Task

A task is a child entity of a job, and a job is required before any task can be added. A task record for which no appointments exist is considered as an open task, and will therefore be displayed in the open tasks component.

The following entities are exposed through the API.

Task

Upsert

Inserts or updates a task record.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)		✔️	See API reference
SourceType	nvarchar(10)		✔️	See API reference
JobNo	nvarchar(50)		✔️	The job's external identifier to assign this task to.
TaskNo	nvarchar(50)		✔️	The task's external identifier.
ShortDescription	nvarchar(50)		✔️
Description	nvarchar(MAX)
TaskType	int	0		See API reference
Name	nvarchar(255)
Type	nvarchar(20)
Category	nvarchar(100)			See API reference
TimeMarker	nvarchar(100)			See API reference
Pin	nvarchar(100)			See API reference
ServiceNo	nvarchar(50)
ServiceGroup	nvarchar(20)
ServiceClass	nvarchar(20)
ServiceSerialNo	nvarchar(50)
ServiceName	nvarchar(50)
IRISFault	nvarchar(10)
IRISSymptom	nvarchar(10)
IRISArea	nvarchar(10)
IRISReason	nvarchar(10)
IRISResolution	nvarchar(10)
Skill1	nvarchar(10)
Skill2	nvarchar(10)
Skill3	nvarchar(10)
ContractNo	nvarchar(20)
ContractType	nvarchar(30)
ContractDescription	nvarchar(MAX)
ContractStartDate	date
ContractEndDate	date
PartsWarrantyStartDate	date
PartsWarrantyEndDate	date
LaborWarrantyStartDate	date
LaborWarrantyEndDate	date
Importance	int	0		See API reference
Status	nvarchar(20)
ExpectedResponseDateTime	datetime
ActualResponseDateTime	datetime
RequestedStartDate	datetime			See API reference
RequestedEndDate	datetime			See API reference
RequestedStartTime	time			See API reference
RequestedEndTime	time			See API reference
ConfirmedStartDate	datetime
ConfirmedEndDate	datetime
ActualStartDate	datetime
ActualEndDate	datetime
LocationDescription	nvarchar(MAX)
Duration	time(7)
DurationInSeconds	bigint			The estimated duration of the task. Determines the initial length of the appointment when dropped on the planning board.
Subject	nvarchar(max)			See API reference
Body	nvarchar(max)			See API reference
InfiniteTask	bit	0		See API reference
TaskOpenAsOf	datetime
TaskOpenTill	datetime
RequiredTotalDuration	time(7)
RequiredNoResources	int
AppointmentEarliestAllowed	datetime			See API reference
AppointmentLatestAllowed	datetime			See API reference
FreeText1	nvarchar(100)			See API reference
FreeText2	nvarchar(100)			See API reference
FreeText3	nvarchar(100)			See API reference
FreeText4	nvarchar(100)			See API reference
FreeText5	nvarchar(100)			See API reference
FreeText6	nvarchar(100)			See API reference
FreeText7	nvarchar(100)			See API reference
FreeText8	nvarchar(100)			See API reference
FreeText9	nvarchar(100)			See API reference
FreeText10	nvarchar(100)			See API reference
FreeText11	nvarchar(100)			See API reference
FreeText12	nvarchar(100)			See API reference
FreeText13	nvarchar(100)			See API reference
FreeText14	nvarchar(100)			See API reference
FreeText15	nvarchar(100)			See API reference
FreeText16	nvarchar(100)			See API reference
FreeText17	nvarchar(100)			See API reference
FreeText18	nvarchar(100)			See API reference
FreeText19	nvarchar(100)			See API reference
FreeText20	nvarchar(100)			See API reference
FreeDecimal1	decimal(18, 6)			See API reference
FreeDecimal2	decimal(18, 6)			See API reference
FreeDecimal3	decimal(18, 6)			See API reference
FreeDecimal4	decimal(18, 6)			See API reference
FreeDecimal5	decimal(18, 6)			See API reference
FreeDate1	datetime			See API reference
FreeDate2	datetime			See API reference
FreeDate3	datetime			See API reference
FreeDate4	datetime			See API reference
FreeDate5	datetime			See API reference
FreeBit1	bit	0		See API reference
FreeBit2	bit	0		See API reference
FreeBit3	bit	0		See API reference
FreeBit4	bit	0		See API reference
FreeBit5	bit	0		See API reference
url1	nvarchar(1000)
urldesc1	nvarchar(255)
url2	nvarchar(1000)
urldesc2	nvarchar(255)
url3	nvarchar(1000)
urldesc3	nvarchar(255)
CertificateNo	nvarchar(50)
RequiredTotalDurationInSeconds	bigint
DoNotCountAppointmentResource	bit	0
IsComplete	bit	0
PlanningUOM	nvarchar(20)
PlanningUOMConversion	decimal(18,6)	0
PlanningQty	decimal(18,6)	0
UseFixPlanningQty	bit	0
RoundToUOM	bit	0
AppointmentTemplate	nvarchar(100)
BulkPlanningQty	decimal(18, 6)
StartDate	datetime
EndDate	datetime
PercentDone	int
SchedulingMode	int	0
BaseLineStartDate	datetime
BaseLineEndDate	datetime
BaseLinePercentDone	int
DeadLine	datetime
Index	int
ConstraintType	int	0
ConstraintDate	datetime
ParentTaskNo	nvarchar(50)
CalendarCode	nvarchar(255)
PredecessorTaskNo	nvarchar(50)
PredecessorLag	int
ManuallyScheduled	bit	0
Note	nvarchar(max)
OverRuleGanttPlanning	bit	0
IgnoreCalendars	bit	0
ContainerName	nvarchar(255)
ContainerIndex	int

Import
API

This endpoint is available in the import API endpoint /import via the procedure mboc_upsertTask.

Example body:

[
    {
        "StoredProcedureName": "mboc_upsertTask",
        "ParameterNames": ["SourceApp", "SourceType", "JobNo", "TaskNo", "ShortDescription", "Description"],
        "ParameterValues": ["BC", "JOB", "JOB001", "TASK001", "Important work", "Important work, but in more words"]
    }
]

Endpoint: /task
Supported HTTP methods: POST (create) and PUT (update)

Delete

Deletes a task record. The behavior of this procedure depends on the CheckAppointments flag:

When CheckAppointments is true: the task is not deleted when there are appointments for the task.
When CheckAppointments is false: the task is deleted without further checks. When a task is deleted, all appointments attached to the task, if any, are also deleted.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)		✔️	See API reference
SourceType	nvarchar(10)		✔️	See API reference
JobNo	nvarchar(50)		✔️
TaskNo	nvarchar(50)		✔️
CheckAppointments	bit		✔️
SentFromBackoffice	bit	1

Import
API

This endpoint is available in the import API endpoint /import via the procedure mboc_deleteTask.

Example body:

[
    {
        "StoredProcedureName": "mboc_deleteTask",            
        "ParameterNames": ["SourceApp", "SourceType", "JobNo", "TaskNo", "CheckAppointments"],
        "ParameterValues": ["BC", "JOB", "JOB001", "TASK001", "false"]
    }
]

Endpoint: /task
Supported HTTP methods: DELETE

Upsert task URI

Inserts or updates a task uri record. A task link contains links to documents, web pages and the back-office system.

Name	Data Type	Required	Description
SourceApp	nvarchar(30)	✔️	See API reference
SourceType	nvarchar(10)	✔️	See API reference
JobNo	nvarchar(50)	✔️
TaskNo	nvarchar(50)	✔️
url	nvarchar(1000)
urldesc	nvarchar(255)

Import
API

This endpoint is available in the import API endpoint /import via the procedure mboc_upsertTaskUrl.

Example body:

[
    {
        "StoredProcedureName": "mboc_upsertTaskUrl",
        "ParameterNames": ["SourceApp", "SourceType", "JobNo", "TaskNo", "url", "urldesc"],
        "ParameterValues": ["BC", "Job", "JOB001", "JOBTASK001", "https://docs.dimescheduler.com", "Dime.Scheduler docs"]
    }
]

Endpoint: /taskUri
Supported HTTP methods: POST (create) and PUT (update)

Set lock

Locks or unlocks all appointments for the task. A locked appointment can not be modified nor deleted on the planning board.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)		✔️	See API reference
SourceType	nvarchar(10)		✔️	See API reference
JobNo	nvarchar(50)		✔️
TaskNo	nvarchar(50)		✔️
Locked	bit	0
SentFromBackoffice	bit	1

Import
API

This endpoint is available in the import API endpoint /import via the procedure mboc_updateTaskLocked.

Example body:

[
    {
        "StoredProcedureName": "mboc_updateTaskLocked",
        "ParameterNames": ["SourceApp", "SourceType", "JobNo", "TaskNo", "Locked"],
        "ParameterValues": ["BC", "Job", "JOB001", "JOBTASK001", "true"]
    }
]

Endpoint: /taskLocked
Supported HTTP methods: POST

Filter value

Upsert filter value

Inserts or updates a task value record. This assigns a filter value to a task.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)		✔️	See API reference
SourceType	nvarchar(10)		✔️	See API reference
JobNo	nvarchar(50)		✔️
TaskNo	nvarchar(50)		✔️
FilterGroup	nvarchar(50)		✔️
FilterValue	nvarchar(100)		✔️
TransferToTemp	bit	0		See API reference

Import
API

This endpoint is available in the import API endpoint /import via the procedure mboc_upsertTaskFilterValue.

Example body:

[
    {
        "StoredProcedureName": "mboc_upsertTaskFilterValue",
        "ParameterNames": ["SourceApp", "SourceType", "JobNo", "TaskNo", "FilterGroup", "FilterValue"],
        "ParameterValues": ["BC", "Job", "JOB001", "JOBTASK001", "Skill", "Yodeling"]
    }
]

Endpoint: /taskFilterValue
Supported HTTP methods: POST (create) and PUT (update)

Delete filter value

Deletes a task filter value record. This removes a filter value from a task.

Name	Data Type	Required	Description
SourceApp	nvarchar(30)	✔️	See API reference
SourceType	nvarchar(10)	✔️	See API reference
JobNo	nvarchar(50)	✔️
TaskNo	nvarchar(50)	✔️
FilterGroup	nvarchar(20)	✔️
FilterValue	nvarchar(20)	✔️

Import
API

This endpoint is available in the import API endpoint /import via the procedure mboc_deleteTaskFilterValue.

Example body:

[
    {
        "StoredProcedureName": "mboc_deleteTaskFilterValue",
        "ParameterNames": ["SourceApp", "SourceType", "JobNo", "TaskNo", "FilterGroup", "FilterValue"],
        "ParameterValues": ["BC", "Job", "JOB001", "JOBTASK001", "Skill", "Yodeling"]
    }
]

Endpoint: /taskFilterValue
Supported HTTP methods: DELETE

Clear filter value

Deletes all task filter value records. This removes all filter values from a task.

Name	Data Type	Required	Description
SourceApp	nvarchar(30)	✔️	See API reference
SourceType	nvarchar(10)	✔️	See API reference
JobNo	nvarchar(50)	✔️
TaskNo	nvarchar(50)	✔️

Import
API

This endpoint is available in the import API endpoint /import via the procedure mboc_clearTaskFilterValue.

Example body:

[
    {
        "StoredProcedureName": "mboc_clearTaskFilterValue",
        "ParameterNames": ["SourceApp", "SourceType", "JobNo", "TaskNo"],
        "ParameterValues": ["BC", "Job", "JOB001", "JOBTASK001"]
    }
]

Task container

Upsert task container

Inserts or updates a task container.

Name	Data Type	Required	Description
SourceApp	nvarchar(30)	✔️	See API reference
SourceType	nvarchar(10)	✔️	See API reference
JobNo	nvarchar(50)	✔️
TaskNo	nvarchar(50)	✔️
ContainerName	nvarchar(255)	✔️
Index	int

Import
API

This endpoint is available in the import API endpoint /import via the procedure mboc_upsertTaskContainer.

Example body:

[
    {
        "StoredProcedureName": "mboc_upsertTaskContainer",
        "ParameterNames": ["SourceApp", "SourceType", "JobNo", "TaskNo", "ContainerName"],
        "ParameterValues": ["BC", "Job", "JOB001", "JOBTASK001", "PROJECT_ABC"]
    }
]

Endpoint: /taskContainer
Supported HTTP methods: POST (create) and PUT (update)

Delete task container

Removes the task container.

Name	Data Type	Required	Description
SourceApp	nvarchar(30)	✔️	See API reference
SourceType	nvarchar(10)	✔️	See API reference
JobNo	nvarchar(50)	✔️
TaskNo	nvarchar(50)	✔️
ContainerName	nvarchar(255)

Import
API

This endpoint is available in the import API endpoint /import via the procedure mboc_deleteTaskContainer.

Example body:

[
    {
        "StoredProcedureName": "mboc_deleteTaskContainer",
        "ParameterNames": ["SourceApp", "SourceType", "JobNo", "TaskNo", "ContainerName"],
        "ParameterValues": ["BC", "JOB", "JOB001", "JOBTASK001", "PROJECT_ABC"]
    }
]

Endpoint: /taskContainer
Supported HTTP methods: DELETE

API Reference

Requested dates

This set of fields are behavioral data. See here for more info.

Requested times

This set of fields are behavioral data. See here for more info.

Source

Dime.Scheduler is a centralized planning application. One the key tenets is the ability to accommodate data from different origins. For instance, it is perfectly acceptable to plan work orders from Business Central, CRM, imported Excel sheets, etc., and Dime.Scheduler won't break a sweat because of the existence of the Source App and SourceType fields in the data model.

Source App

When the planner makes an appointment for a resource or task, Dime.Scheduler knows which system to notify. Through the connector setup, Dime.Scheduler will find a matching SourceApp and send the appointment to the corresponding URI subsequently. The source app field is a unique identifier that identifies a back office instance such a tenant of Business Central, a test environment, an instance of CRM cloud, or any other application you wish to use to feed the data into Dime.Scheduler.

Source Type

The SourceType is used inside the back-office system itself. A source type represents a distinct entity such as a service order, production order, assembly order, etc.

The standard connectors that Dime Software provides make it possible to plan different types of resources and tasks. When Dime.Scheduler posts an appointment to a standard connector, it ends up in a staging table, which is then processed by the connector to make sure the appointment produced in Dime.Scheduler is traced back to the original record using the externally identifiable fields (JobNo, TaskNo, ResourceNo) that identify the record.

Infinite

When set to true, the task will always remain available in the open task list. Typical examples include holiday and sickness tasks.

Planning range

The earliest and latest allowed dates make it possible to define a date range in which the task has to be scheduled. See here for more information.

Task type

Planning can be done in two ways: through the planning board or through the Gantt chart. When the task type is the latter (value 1), drag and drop will be disabled in the open task list, and planning will need to be done through the Gantt chart.

Importance

Controls the visual indicator of the planned task in the planning board. Read more about this topic here.

Subject and body

Through the field template setup, the task's subject and body is set when imported in Dime.Scheduler.

Time Marker

Controls the visual indicator of the planned task in the planning board. Read more about this topic here.

Controls the visual indicator of the planned task in the map. Read more about this topic here.

Free fields

Free fields are unmapped fields that you can link custom fields to.

The caption can be changed through the captions localization system. Either use the GUI and look for the corresponding field of the corresponding source table for the 'DATABASEFIELD' context, or use the API.

Transfer to temp

The TransferToTemp field indicates whether the task filter value(s) are being sent to Dime.Scheduler before (value = 1 or True) or after (value = 0 or False) the task is sent.

Task​

Upsert​

Delete​

Upsert task URI​

Set lock​

Filter value​

Upsert filter value​

Delete filter value​

Clear filter value​

Task container​

Upsert task container​

Delete task container​

API Reference​

Requested dates​

Requested times​

Source​

Source App​

Source Type​

Infinite​

Planning range​

Task type​

Importance​

Subject and body​

Category​

Time Marker​

Pin​

Free fields​

Transfer to temp​

Task

Upsert

Delete

Upsert task URI

Set lock

Filter value

Upsert filter value

Delete filter value

Clear filter value

Task container

Upsert task container

Delete task container

API Reference

Requested dates

Requested times

Source

Source App

Source Type

Infinite

Planning range

Task type

Importance

Subject and body

Category

Time Marker

Pin

Free fields

Transfer to temp