Skip to main content

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.

NameData TypeDefaultRequiredDescription
SourceAppnvarchar(30)✔️See API reference
SourceTypenvarchar(10)✔️See API reference
JobNonvarchar(50)✔️The job's external identifier to assign this task to.
TaskNonvarchar(50)✔️The task's external identifier.
ShortDescriptionnvarchar(50)✔️
Descriptionnvarchar(MAX)
TaskTypeint0See API reference
Namenvarchar(255)
Typenvarchar(20)
Categorynvarchar(100)See API reference
TimeMarkernvarchar(100)See API reference
Pinnvarchar(100)See API reference
ServiceNonvarchar(50)
ServiceGroupnvarchar(20)
ServiceClassnvarchar(20)
ServiceSerialNonvarchar(50)
ServiceNamenvarchar(50)
IRISFaultnvarchar(10)
IRISSymptomnvarchar(10)
IRISAreanvarchar(10)
IRISReasonnvarchar(10)
IRISResolutionnvarchar(10)
Skill1nvarchar(10)
Skill2nvarchar(10)
Skill3nvarchar(10)
ContractNonvarchar(20)
ContractTypenvarchar(30)
ContractDescriptionnvarchar(MAX)
ContractStartDatedate
ContractEndDatedate
PartsWarrantyStartDatedate
PartsWarrantyEndDatedate
LaborWarrantyStartDatedate
LaborWarrantyEndDatedate
Importanceint0See API reference
Statusnvarchar(20)
ExpectedResponseDateTimedatetime
ActualResponseDateTimedatetime
RequestedStartDatedatetimeSee API reference
RequestedEndDatedatetimeSee API reference
RequestedStartTimetimeSee API reference
RequestedEndTimetimeSee API reference
ConfirmedStartDatedatetime
ConfirmedEndDatedatetime
ActualStartDatedatetime
ActualEndDatedatetime
LocationDescriptionnvarchar(MAX)
Durationtime(7)
DurationInSecondsbigintThe estimated duration of the task. Determines the initial length of the appointment when dropped on the planning board.
Subjectnvarchar(max)See API reference
Bodynvarchar(max)See API reference
InfiniteTaskbit0See API reference
TaskOpenAsOfdatetime
TaskOpenTilldatetime
RequiredTotalDurationtime(7)
RequiredNoResourcesint
AppointmentEarliestAlloweddatetimeSee API reference
AppointmentLatestAlloweddatetimeSee API reference
FreeText1nvarchar(100)See API reference
FreeText2nvarchar(100)See API reference
FreeText3nvarchar(100)See API reference
FreeText4nvarchar(100)See API reference
FreeText5nvarchar(100)See API reference
FreeText6nvarchar(100)See API reference
FreeText7nvarchar(100)See API reference
FreeText8nvarchar(100)See API reference
FreeText9nvarchar(100)See API reference
FreeText10nvarchar(100)See API reference
FreeText11nvarchar(100)See API reference
FreeText12nvarchar(100)See API reference
FreeText13nvarchar(100)See API reference
FreeText14nvarchar(100)See API reference
FreeText15nvarchar(100)See API reference
FreeText16nvarchar(100)See API reference
FreeText17nvarchar(100)See API reference
FreeText18nvarchar(100)See API reference
FreeText19nvarchar(100)See API reference
FreeText20nvarchar(100)See API reference
FreeDecimal1decimal(18, 6)See API reference
FreeDecimal2decimal(18, 6)See API reference
FreeDecimal3decimal(18, 6)See API reference
FreeDecimal4decimal(18, 6)See API reference
FreeDecimal5decimal(18, 6)See API reference
FreeDate1datetimeSee API reference
FreeDate2datetimeSee API reference
FreeDate3datetimeSee API reference
FreeDate4datetimeSee API reference
FreeDate5datetimeSee API reference
FreeBit1bit0See API reference
FreeBit2bit0See API reference
FreeBit3bit0See API reference
FreeBit4bit0See API reference
FreeBit5bit0See API reference
url1nvarchar(1000)
urldesc1nvarchar(255)
url2nvarchar(1000)
urldesc2nvarchar(255)
url3nvarchar(1000)
urldesc3nvarchar(255)
CertificateNonvarchar(50)
RequiredTotalDurationInSecondsbigint
DoNotCountAppointmentResourcebit0
IsCompletebit0
PlanningUOMnvarchar(20)
PlanningUOMConversiondecimal(18,6)0
PlanningQtydecimal(18,6)0
UseFixPlanningQtybit0
RoundToUOMbit0
AppointmentTemplatenvarchar(100)
BulkPlanningQtydecimal(18, 6)
StartDatedatetime
EndDatedatetime
PercentDoneint
SchedulingModeint0
BaseLineStartDatedatetime
BaseLineEndDatedatetime
BaseLinePercentDoneint
DeadLinedatetime
Indexint
ConstraintTypeint0
ConstraintDatedatetime
ParentTaskNonvarchar(50)
CalendarCodenvarchar(255)
PredecessorTaskNonvarchar(50)
PredecessorLagint
ManuallyScheduledbit0
Notenvarchar(max)
OverRuleGanttPlanningbit0
IgnoreCalendarsbit0
ContainerNamenvarchar(255)
ContainerIndexint
  • 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"]
    }
    ]

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.
NameData TypeDefaultRequiredDescription
SourceAppnvarchar(30)✔️See API reference
SourceTypenvarchar(10)✔️See API reference
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
CheckAppointmentsbit✔️
SentFromBackOfficebit1
  • 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"]
    }
    ]

Upsert task URI

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

NameData TypeDefaultRequiredDescription
SourceAppnvarchar(30)✔️See API reference
SourceTypenvarchar(10)✔️See API reference
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
urlnvarchar(1000)
urldescnvarchar(255)
  • 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"]
    }
    ]

Set lock

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

NameData TypeDefaultRequiredDescription
SourceAppnvarchar(30)✔️See API reference
SourceTypenvarchar(10)✔️See API reference
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
Lockedbit0
SentFromBackOfficebit1
  • 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"]
    }
    ]

Filter value

Upsert filter value

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

NameData TypeDefaultRequiredDescription
SourceAppnvarchar(30)✔️See API reference
SourceTypenvarchar(10)✔️See API reference
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
FilterGroupnvarchar(50)✔️
FilterValuenvarchar(100)✔️
TransferToTempbit0See API reference
  • 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"]
    }
    ]

Delete filter value

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

NameData TypeDefaultRequiredDescription
SourceAppnvarchar(30)✔️See API reference
SourceTypenvarchar(10)✔️See API reference
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
FilterGroupnvarchar(20)✔️
FilterValuenvarchar(20)✔️
  • 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"]
    }
    ]

Clear filter value

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

NameData TypeDefaultRequiredDescription
SourceAppnvarchar(30)✔️See API reference
SourceTypenvarchar(10)✔️See API reference
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
  • 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.

NameData TypeDefaultRequiredDescription
SourceAppnvarchar(30)✔️See API reference
SourceTypenvarchar(10)✔️See API reference
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
ContainerNamenvarchar(255)✔️
Indexint
  • 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"]
    }
    ]

Delete task container

Removes the task container.

NameData TypeDefaultRequiredDescription
SourceAppnvarchar(30)✔️See API reference
SourceTypenvarchar(10)✔️See API reference
JobNonvarchar(50)✔️
TaskNonvarchar(50)✔️
ContainerNamenvarchar(255)
  • 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"]
    }
    ]

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 of its 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 Source Type fields in the data model.

Source App

When the planner creates 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 subsequently send the appointment to the corresponding URI.

The source app field is a unique identifier that identifies a back-office instance such as a tenant of Business Central, a test environment, an instance of CRM cloud, or any other application you wish to use to feed 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 ensure 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.

Read more on the task type here.

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.

Category

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

Time Marker

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

Pin

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.