Indicator

The video below showcases the functionality of some of the indicatorsIndicatorCollective term for the visual signals - categories, time markers, pins, and tags - that identify and label appointments.:

Category

A categoryCategoryA visual indicator (a color) applied to appointments to classify or label them. is the property or attribute of an appointmentAppointmentA task scheduled to a resource for a specific period - the scheduled instance you see on the planning board. that determines the color in which an appointment is displayed. The category is used to provide an immediate visual insight in the type or status of appointments.

Upsert

Inserts or updates a category record.

Name	Data Type	Default	Required
CategoryName	nvarchar(100)		✔️
DisplayName	nvarchar(100)	CategoryName
CategoryHexColor	nvarchar(50)
ColorR	int
ColorG	int
ColorB	int

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_upsertCategory.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_upsertCategory",
          "ParameterNames": ["CategoryName", "DisplayName", "CategoryHexColor"],
          "ParameterValues": ["INPROGRESS", "In Progress", "#6e64b5"]
      }
  ]

API

See POST /category, PUT /category in the REST API reference.

Rename category

Renames the category.

Name	Data Type	Default	Required
CategoryName	nvarchar(100)		✔️
NewCategoryName	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_renameCategory.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_renameCategory",
          "ParameterNames": ["CategoryName", "NewCategoryName"],
          "ParameterValues": ["INPROCESSTYPO", "INPROCESS"]
      }
  ]

API

This endpoint is not available yet.

Delete category

Removes this indicator from the database.

Name	Data Type	Default	Required
CategoryName	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_deleteCategory.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_deleteCategory",
          "ParameterNames": ["CategoryName"],
          "ParameterValues": ["INPROCESS"]
      }
  ]

API

See DELETE /category in the REST API reference.

Time Marker

A time markerTime markerA visual indicator on an appointment, separate from its category, used to flag a status or condition at a point in time. is the property or attribute of an appointment that determines the colored bar displayed below the appointment in the planning boardPlanning boardThe main graphical scheduling surface where dispatchers drag tasks onto resources across a timeline.. The time marker is used to provide an immediate visual insight in the type or status of appointments.

Upsert time marker

Inserts or updates a time marker record.

Name	Data Type	Default	Required
TimeMarker	nvarchar(100)		✔️
HexColor	nvarchar(50)
ColorR	int
ColorG	int
ColorB	int

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_upsertTimeMarker.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_upsertTimeMarker",
          "ParameterNames": ["TimeMarker", "HexColor"],
          "ParameterValues": ["In Progress", "#6e64b5"]
      }
  ]

API

See POST /timeMarker, PUT /timeMarker in the REST API reference.

Rename time marker

Renames the time marker.

Name	Data Type	Default	Required
TimeMarker	nvarchar(100)		✔️
NewTimeMarker	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_renameTimeMarker.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_renameTimeMarker",
          "ParameterNames": ["TimeMarker", "NewTimeMarker"],
          "ParameterValues": ["INPROCESSTYPO", "INPROCESS"]
      }
  ]

API

This endpoint is not available yet.

Delete time marker

Removes this indicator from the database.

Name	Data Type	Default	Required
TimeMarker	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_deleteTimeMarker.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_deleteTimeMarker",
          "ParameterNames": ["TimeMarker"],
          "ParameterValues": ["INPROCESS"]
      }
  ]

API

See DELETE /timeMarker in the REST API reference.

Pin

A pinPinAn indicator that lives on a task rather than an appointment and colors its marker on the map, typically by skill, vehicle type or region. It has no equivalent on the planning board. is the property or attribute of an appointment that determines the colored pin on the map.

Upsert pin

Inserts or updates a pin record.

Name	Data Type	Default	Required
Name	nvarchar(100)		✔️
HexColor	nvarchar(50)
ColorR	int
ColorG	int
ColorB	int

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_upsertPin.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_upsertPin",
          "ParameterNames": ["Name", "HexColor"],
          "ParameterValues": ["In Progress", "#6e64b5"]
      }
  ]

API

See POST /pin, PUT /pin in the REST API reference.

Rename pin

Renames the pin.

Name	Data Type	Default	Required
Name	nvarchar(100)		✔️
NewName	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_renamePin.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_renamePin",
          "ParameterNames": ["Name", "NewName"],
          "ParameterValues": ["INPROCESSTYPO", "INPROCESS"]
      }
  ]

API

This endpoint is not available yet.

Delete pin

Removes the indicator from the database.

Name	Data Type	Default	Required
Name	nvarchar(30)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_deletePin.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_deletePin",
          "ParameterNames": ["Name"],
          "ParameterValues": ["INPROCESS"]
      }
  ]

API

See DELETE /pin in the REST API reference.

Tag

Preview

Tags are currently in preview. Functionality and behavior may change between releases. Not recommended for production-critical workflows yet.

A tagTagA reusable label with an icon and a color that can be applied to tasks and appointments. Unlike a category, a record can carry several tags at once. is a reusable, admin-defined label that tasksTaskA unit of work that belongs to a job. It appears in the open task list until it is scheduled to a resource. and appointments reference by code. Unlike the other indicators, a record can carry several tags at once: the Tags parameter on task and appointment is a semicolon-delimited list of tag codes, for example URGENT;NIGHTSHIFT. Read more about tags.

Upsert tag

Inserts or updates a tag, identified by its code. The tag's code is its stable identifier and cannot be changed after creation. Parameters that are left empty on an update keep their stored value, and Name falls back to the code when the tag is created without one.

Name	Data Type	Default	Required
Code	nvarchar(50)		✔️
Name	nvarchar(100)	Code
IconSet	nvarchar(50)
IconName	nvarchar(100)
HexColor	nvarchar(7)

IconSet and IconName identify the icon rendered on the appointment bar. The only supported icon set today is fontawesome, and IconName is the icon's name within that set, for example bolt or moon.

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_upsertTag.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_upsertTag",
          "ParameterNames": ["Code", "Name", "IconSet", "IconName", "HexColor"],
          "ParameterValues": ["URGENT", "Urgent", "fontawesome", "bolt", "#e03131"]
      }
  ]

API

See GET /tag, POST /tag, PUT /tag in the REST API reference.

Delete tag

Removes the tag from the database. Tasks and appointments that still reference the code are left untouched; the tag simply stops rendering on them.

Name	Data Type	Default	Required
Code	nvarchar(50)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_deleteTag.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_deleteTag",
          "ParameterNames": ["Code"],
          "ParameterValues": ["URGENT"]
      }
  ]

API

See DELETE /tag in the REST API reference.