Caption

Upsert

Inserts or updates a captionCaptionThe label shown for a field or entity in the interface, translatable per language. A tenant that calls jobs "projects" changes the caption, not the data model. for a DATABASEFIELD in the specified language. These captions are used in the open tasksOpen taskA task that has not been scheduled yet. It waits in the open task list to be placed on the planning board. grid, the task details pane and in the field templatesField templateA rule that composes an appointment subject and body from job and task fields, so the text reads the way planners want..

Name	Data Type	Default	Required
Context	int	6
SourceTable	nvarchar(255)
FieldName	nvarchar(255)
Language	nvarchar(10)
Caption	nvarchar(100)

Import

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

  [
      {
          "StoredProcedureName": "mboc_upsertCaption",
          "ParameterNames": ["SourceTable", "FieldName", "Language", "Caption"],
          "ParameterValues": ["Job", "FreeBit1", "en", "Pineapple on pizza?"]
      }
  ]

API

• See POST /caption, PUT /caption in the REST API reference.
• Example body:

  {
    SourceTable": "Job",
    "FieldName":"FreeBit1",
    "Language":"en",
    "Caption":"Pineapple on pizza?"
  }

API reference

Context

A context says what kind of thing a caption belongs to. Captions for database fields, the ones this endpoint writes, use context 6 (DATABASEFIELD), which is why the parameter defaults to it and why most callers never send it.

The table below is the complete set, and these values are fixed. Contexts are defined by the product rather than stored as editable data, so an id means the same thing in every tenant and on every version: you can hard code 6 in an integration without checking first. A value outside this set is not a context Dime.Scheduler recognises and is ignored rather than stored.

Value	Name
1	RESOURCE
2	APPOINTMENT
3	APPOINTMENTFIELDVALUE
4	EMAIL
5	EMAILRECIPIENT
6	DATABASEFIELD
7	TASKDETAILS
8	EMAILIMPORTANCE
9	RECIPIENTTYPE
10	CONTEXT
11	TARGETPANE
12	TARGETPANEGROUP
13	TASK
14	JOB