topdesk

TOPdesk Incident Management

Server path: /topdesk | Type: Application | PCID required: Yes

Tools

Tool	Description
topdesk_archive_incident	Archive an incident by id
topdesk_create_incident	Create an Incident
topdesk_create_incident_timespent	Register time spent on an incident by id
topdesk_deescalate_incident	Deescalate an incident by id
topdesk_delete_incident_actions	Delete action by incident id and action id
topdesk_delete_incident_attachments	Delete a file from an incident identified by id
topdesk_delete_incident_requests	Delete request by incident id and request id
topdesk_escalate_incident	Escalate an incident by id
topdesk_get_incident	Returns an incident.
topdesk_get_incident_actions	Get incident actions by incident id and action id
topdesk_get_incident_free_fields_searchlists	Get list of optional drop-down values
topdesk_get_incident_requests	Get incident request by incident id and request id
topdesk_get_incident_timeregistrations	Returns an timeregistration by id.
topdesk_list_incident	Returns a list of incidents.
topdesk_list_incident_actions	Get incident actions by incident id
topdesk_list_incident_attachments	Get incident attachments by incident id
topdesk_list_incident_call_types	Get list of call types
topdesk_list_incident_categories	Get list of categories
topdesk_list_incident_closure_codes	Get list of closure codes
topdesk_list_incident_deescalation_reasons	Get list of reasons for deescalation
topdesk_list_incident_durations	Get list of durations
topdesk_list_incident_entry_types	Get list of entry types
topdesk_list_incident_escalation_reasons	Get list of reasons for escalation
topdesk_list_incident_impacts	Get list of impacts
topdesk_list_incident_priorities	Get list of priorities
topdesk_list_incident_progresstrail	Get incident progress trail by incident id
topdesk_list_incident_progresstrail_count	Get incident progress trail entry count by incident id
topdesk_list_incident_requests	Get incident requests by incident id
topdesk_list_incident_slas	Get list of SLA services
topdesk_list_incident_slas_services	Get list of services
topdesk_list_incident_statuses	Get list of processing statuses
topdesk_list_incident_subcategories	Get list of subcategories
topdesk_list_incident_timeregistrations	Get list of time registrations. By default only time registartions entries for 1st and 2nd line incidents are returned
topdesk_list_incident_timespent	Register time spent on an incident by id
topdesk_list_incident_urgencies	Get list of urgencies
topdesk_patch_incident	Updates an Incident
topdesk_unarchive_incident	Unarchive an incident by id
topdesk_update_incident	Updates an Incident

---

topdesk_archive_incident

Archive an incident by id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The incident id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The incident id"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

topdesk_create_incident

Create an Incident

Parameters:

Parameter	Type	Required	Default	Description
action	string	No	—	Initial action. The following html tags can be used to format the text: <ul> <li><i></li> <li><em></li> <li><b></li> <li><strong></li> <li><u></li> <li><img> BASE64-encoding has to be used. Only pictures up to the size of 450x450 pixels are supported. Allowed picture-formats: gif, png, bmp, pcx, iff, ras, pnm, psd, jpg. Example: <img src=“data:image/png;base64,iVBORw0KGgoAAA…”></li> <li><br></li> <li><p></li> <li><div></li> </ul> Can be set by operators and persons.
actionInvisibleForCaller	boolean	No	—	Whether the initial action is invisible for persons. Can only be set by operators.
branch	object	No	—	Branch (for Location) by id. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Example: "branch" : &#123; "id" : "&lt;UUID&gt;" &#125;
briefDescription	string	No	—	Brief description. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked.
caller	object	No	—	Using the caller parameter to fill in a registered caller is deprecated, use the callerLookup parameter instead. The caller contact details for this incident. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Is filled in automatically for persons and when the callerLookup parameter is provided. To fill in an unregistered caller, fill in the caller’s name: "caller" : &#123; "dynamicName" : "Firstname Lastname" &#125; It is an error to provide both a name and a registered caller.
callerLookup	object	No	—	Lookup value for filling in a registered caller’s contact details. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. The caller is filled in automatically for persons. Examples: "callerLookup" : &#123; "id" : "&lt;UUID&gt;" &#125; or "callerLookup" : &#123; "email" : "[e-mail]" &#125; It is an error to provide more than one lookup value or to provide an empty callerLookup object.
callType	object	No	—	Call type by id or name. Can be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: "callType" : &#123; "id" : "&lt;UUID&gt;" &#125; or "callType" : &#123; "name" : "Name of Searchlist" &#125;
category	object	No	—	Category by id or name. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. It is an error to provide both an id and a name. Example: "category" : &#123; "id" : "&lt;UUID&gt;" &#125; or "category" : &#123; "name" : "Name of Searchlist" &#125;
closed	boolean	No	—	Whether the incident is closed. Can only be set by operators. For partials, will be ignored. The value of completed will be used instead.
closedDate	string	No	—	Closed date. Can only be set by operators. For partials, will be ignored. The value of completedDate will be used instead. Example: “closedDate” : “2018-11-15T14:00:00.000+0200” The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2018-10-28T10:30:00.000 is equivalent to 2018-10-28T10:30:00.000+0000
closureCode	object	No	—	Closure code by id or name. Can only be set by operators. Example: "closureCode" : &#123; "id" : "&lt;UUID&gt;" &#125; or "closureCode" : &#123; "name" : "Name of Searchlist" &#125;
completed	boolean	No	—	Whether the incident is completed. Can only be set by operators.
completedDate	string	No	—	Completed date. Can only be set by operators. Example: “completedDate” : “2018-11-15T14:00:00.000+0200” The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2018-10-28T10:30:00.000 is equivalent to 2018-10-28T10:30:00.000+0000
costs	number	No	—	Costs. Can only be set by operators. Example: “costs” : “0.15”
duration	object	No	—	Duration by id or name. Can only be set by operators. Example: "duration" : &#123; "id" : "&lt;UUID&gt;" &#125; or "duration" : &#123; "name" : "Name of Searchlist" &#125;
entryType	object	No	—	Entry type by id or name. Can only be set by operators. Example: "entryType" : &#123; "id" : "&lt;UUID&gt;" &#125; or "entryType" : &#123; "name" : "Name of Searchlist" &#125;
externalLink	object	No	—	External Link
externalNumber	string	No	—	External number. Can only be set by operators. For partials, if not provided, will be automatically copied from the main incident.
feedbackMessage	string	No	—	Leave feedback message on incident, only available for closed incidents and when feedbackRating is given. Can only be set by operators or the caller of the incident. Example: "feedbackMessage" : "Nice!"
feedbackRating	number	No	—	Rate incident, only available for closed incidents. Can only be set by operators or the caller of the incident. Example: "feedbackRating" : "5"
impact	object	No	—	Impact by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Example: "impact" : &#123; "id" : "&lt;UUID&gt;" &#125; or "impact" : &#123; "name" : "Name of Searchlist" &#125;
location	object	No	—	Location by id. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Example: "location" : &#123; "id" : "&lt;UUID&gt;" &#125;
mainIncident	object	No	—	Main incident id or number, required for creating a partial incident. This must be an open, unarchived second line incident and visible to the operator. It is an error to provide a main incident for non-partial incidents. Can only be set by operators. example: "mainIncident" : &#123; "id" : "&lt;UUID&gt;" &#125; or ```` "mainIncident" : &#123; "number" : "I 1909 123" &#125;
majorCall	boolean	No	—	Whether the incident is a major call. Can only be set by operators.
majorCallObject	object	No	—	Major call by id or number. Can only be set by operators. Example: "majorCallObject" : &#123; "id" : "&lt;UUID&gt;" &#125; or "majorCallObject" : &#123; "name" : "I 1909 123" &#125;
object	object	No	—	Object by id or by name. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Examples: "object" : &#123; "id" : "&lt;UUID&gt;" &#125; or "object" : &#123; "name" : "OBJ001" &#125; If both object and location are given, object is set and location is ignored.
onHold	boolean	No	—	On hold. On hold date will be filled accordingly. Can only be set by operators. Example: "onHold" : "true"
operator	object	No	—	Operator by id. Can only be set by operators. For partials, if not provided, will be automatically copied from the main incident. Example: "operator": &#123; "id": "&lt;UUID&gt;" &#125;
operatorGroup	object	No	—	Operator group by id. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: "operatorGroup" : &#123; "id" : "&lt;UUID&gt;" &#125;
optionalFields1	object	No	—	The enabled optional fields.
optionalFields2	object	No	—	The enabled optional fields.
priority	object	No	—	Priority by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Will be automatically filled in if you provide impact and/or urgency leading to a unique priority according to your priority matrix, and the same request doesn’t provide a priority. For incidents with a linked SLA, if the priority provided cannot be found in the Service Level Priority List, the duration field of the incident will be emptied. Example: "priority" : &#123; "id" : "&lt;UUID&gt;" &#125; or "priority" : &#123; "name" : "Name of Searchlist" &#125;
processingStatus	object	No	—	Processing status by id or name. Can only be set by operators. Example: "processingStatus" : &#123; "id" : "&lt;UUID&gt;" &#125; or "processingStatus" : &#123; "name" : "Name of Searchlist" &#125;
publishToSsd	boolean	No	—	Whether the incident should be published in the Self Service Desk; only major incidents can be published. Can only be set by operators.
request	string	No	—	Initial request. The following html tags can be used to format the text: <ul> <li><i></li> <li><em></li> <li><b></li> <li><strong></li> <li><u></li> <li><img> BASE64-encoding has to be used. Only pictures up to the size of 450x450 pixels are supported. Allowed picture-formats: gif, png, bmp, pcx, iff, ras, pnm, psd, jpg. Example: <img src=“data:image/png;base64,iVBORw0KGgoAAA…”></li> <li><br></li> <li><p></li> <li><div></li> </ul> Can be set by operators and persons.
responded	boolean	No	—	Whether the incident is responded. SLM-licence is needed. Can only be set by operators. When the setting “Status determines responded” is on, this will be filled automatically (manual setting is prohibited).
responseDate	string	No	—	Response date. SLM-licence is needed. Can only be set by operators. Will automatically be set to current date if left out and “responded : true” is set. Example: "responseDate" : "2015-11-15T14:00:00.000+0200" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000
sla	object	No	—	SLA by id. Can only be set by operators. Example: "sla" : &#123; "id" : "&lt;UUID&gt;" &#125;
status	string	No	—	Status of the incident. Can only be set by operators.
subcategory	object	No	—	Subcategory by id or name. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. It is an error to provide both an id and a name. If a subcategory is provided without a category, the corresponding category will be filled in automatically, unless there are multiple matching categories, in which case the request will fail. Examples: "subcategory" : &#123; "id" : "&lt;UUID&gt;" &#125; or "subcategory" : &#123; "name" : "Printer" &#125;
supplier	object	No	—	Supplier by id. Can only be set by operators. Example: "supplier" : &#123; "id" : "&lt;UUID&gt;" &#125;
targetDate	object	No	—	Target date. Can only be set by operators. Example: "targetDate" : "2015-11-15T14:00:00.000+0200" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000
urgency	object	No	—	Urgency by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Example: "urgency" : &#123; "id" : "&lt;UUID&gt;" &#125; or "urgency" : &#123; "name" : "Name of Searchlist" &#125;

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "action": {
      "type": "string",
      "description": "Initial action. The following html tags can be used to format the text: <ul> <li>&lt;i&gt;</li> <li>&lt;em&gt;</li> <li>&lt;b&gt;</li> <li>&lt;strong&gt;</li> <li>&lt;u&gt;</li> <li>&lt;img&gt; BASE64-encoding has to be used. Only pictures up to the size of 450x450 pixels are supported. Allowed picture-formats: gif, png, bmp, pcx, iff, ras, pnm, psd, jpg. Example: &lt;img src=\"data:image/png;base64,iVBORw0KGgoAAA...\"&gt;</li> <li>&lt;br&gt;</li> <li>&lt;p&gt;</li> <li>&lt;div&gt;</li> </ul> Can be set by operators and persons."
    },
    "actionInvisibleForCaller": {
      "type": "boolean",
      "description": "Whether the initial action is invisible for persons. Can only be set by operators."
    },
    "branch": {
      "type": "object",
      "description": "Branch (for Location) by id. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Example: ``` \"branch\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "briefDescription": {
      "type": "string",
      "description": "Brief description. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked."
    },
    "caller": {
      "type": "object",
      "description": "``` Using the caller parameter to fill in a registered caller is deprecated, use the callerLookup parameter instead. ``` The caller contact details for this incident. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Is filled in automatically for persons and when the callerLookup parameter is provided. To fill in an unregistered caller, fill in the caller's name: ``` \"caller\" : { \"dynamicName\" : \"Firstname Lastname\" } ``` It is an error to provide both a name and a registered caller.",
      "properties": {
        "branch": {
          "type": "object",
          "description": "The caller branch by id. Can only be set by operators. Example: ``` \"caller\" : { \"branch\" : { \"id\" : \"<UUID>\" }} ```"
        },
        "dynamicName": {
          "type": "string",
          "description": "Dynamic Name of the caller. Can only be set by operators. Can only be changed for unregistered callers. Example: ``` \"caller\" : { \"dynamicName\" : \"Ginneken, Erik van\" } ```"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Phone number of the caller. Can only be set by operators. Example: ``` \"caller\" : { \"phoneNumber\" : \"123 456\" } ```"
        },
        "mobileNumber": {
          "type": "string",
          "description": "Mobile phone number of the caller. Can only be set by operators. Example: ``` \"caller\" : { \"mobileNumber\" : \"123 456\" } ```"
        },
        "email": {
          "type": "string",
          "description": "Email of the caller. Can only be set by operators. Example: ``` \"caller\" : { \"email\" : \"[e-mail]\" } ```"
        },
        "department": {
          "type": "object",
          "description": "Department of the caller by id or name. Can only be set by operators. Example: ``` \"caller\" : { \"department\" : { \"id\" : \"<UUID>\" }} ``` or ``` \"department\" : { \"name\" : \"Name of Searchlist\" } ```"
        },
        "locations": {
          "type": "object",
          "description": "Location of the caller by id. Can only be set by operators. Example: ``` \"caller\" : { \"location\" : { \"id\" : \"<UUID>\" } ```"
        },
        "budgetHolder": {
          "type": "object",
          "description": "Budget holder of the caller by id or name. Can only be set by operators. Example: ``` \"caller\" : { \"budgetHolder\" : { \"id\" : \"<UUID>\" } ``` or ``` \"budgetHolder\" : { \"name\" : \"Name of Searchlist\" } ```"
        },
        "personExtraFieldA": {
          "type": "object",
          "description": "Person extra field a of the caller by id or name. Can only be set by operators. Example: ``` \"caller\" : { \"personExtraFieldA\" : { \"id\" : \"<UUID>\" } ``` or ``` \"personExtraFieldA\" : { \"name\" : \"Name of Searchlist\" } ```"
        },
        "personExtraFieldB": {
          "type": "object",
          "description": "Person extra field b of the caller by id or name. Can only be set by operators. Example: ``` \"caller\" : { \"personExtraFieldB\" : { \"id\" : \"<UUID>\" } ``` or ``` \"personExtraFieldB\" : { \"name\" : \"Name of Searchlist\" } ```"
        }
      }
    },
    "callerLookup": {
      "type": "object",
      "description": "Lookup value for filling in a registered caller's contact details. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. The caller is filled in automatically for persons. Examples: ``` \"callerLookup\" : { \"id\" : \"<UUID>\" } ``` or ``` \"callerLookup\" : { \"email\" : \"[e-mail]\" } ``` It is an error to provide more than one lookup value or to provide an empty callerLookup object.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "callType": {
      "type": "object",
      "description": "Call type by id or name. Can be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: ``` \"callType\" : { \"id\" : \"<UUID>\" } ``` or ``` \"callType\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "category": {
      "type": "object",
      "description": "Category by id or name. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. It is an error to provide both an id and a name. Example: ``` \"category\" : { \"id\" : \"<UUID>\" } ``` or ``` \"category\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "closed": {
      "type": "boolean",
      "description": "Whether the incident is closed. Can only be set by operators. For partials, will be ignored. The value of completed will be used instead."
    },
    "closedDate": {
      "type": "string",
      "description": "Closed date. Can only be set by operators. For partials, will be ignored. The value of completedDate will be used instead. Example: \"closedDate\" : \"2018-11-15T14:00:00.000+0200\" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2018-10-28T10:30:00.000 is equivalent to 2018-10-28T10:30:00.000+0000"
    },
    "closureCode": {
      "type": "object",
      "description": "Closure code by id or name. Can only be set by operators. Example: ``` \"closureCode\" : { \"id\" : \"<UUID>\" } ``` or ``` \"closureCode\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "completed": {
      "type": "boolean",
      "description": "Whether the incident is completed. Can only be set by operators."
    },
    "completedDate": {
      "type": "string",
      "description": "Completed date. Can only be set by operators. Example: \"completedDate\" : \"2018-11-15T14:00:00.000+0200\" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2018-10-28T10:30:00.000 is equivalent to 2018-10-28T10:30:00.000+0000"
    },
    "costs": {
      "type": "number",
      "description": "Costs. Can only be set by operators. Example: \"costs\" : \"0.15\""
    },
    "duration": {
      "type": "object",
      "description": "Duration by id or name. Can only be set by operators. Example: ``` \"duration\" : { \"id\" : \"<UUID>\" } ``` or ``` \"duration\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "entryType": {
      "type": "object",
      "description": "Entry type by id or name. Can only be set by operators. Example: ``` \"entryType\" : { \"id\" : \"<UUID>\" } ``` or ``` \"entryType\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "externalLink": {
      "type": "object",
      "description": "External Link",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "type": {
          "type": "string",
          "description": "Integer (supplied as string) to identify the external system by. Can only be set by operators. Needs to be supplied together with a valid id in order to create a link. Example: \"externalLink\" : { \"id\" : \"identifier-of-external-system\", \"type\" : \"11\" }"
        },
        "date": {
          "type": "string",
          "description": "Date of the last synchronization. Can only be set by operators. Example: \"externalLink\" : { \"id\" : \"identifier-of-external-system\", \"type\" : \"11\" , \"date\" : \"2018-09-17T17:36:00\" }"
        }
      }
    },
    "externalNumber": {
      "type": "string",
      "description": "External number. Can only be set by operators. For partials, if not provided, will be automatically copied from the main incident."
    },
    "feedbackMessage": {
      "type": "string",
      "description": "Leave feedback message on incident, only available for closed incidents and when feedbackRating is given. Can only be set by operators or the caller of the incident. Example: ``` \"feedbackMessage\" : \"Nice!\" ```"
    },
    "feedbackRating": {
      "type": "number",
      "description": "Rate incident, only available for closed incidents. Can only be set by operators or the caller of the incident. Example: ``` \"feedbackRating\" : \"5\" ```",
      "enum": [
        1,
        2,
        3,
        4,
        5
      ]
    },
    "impact": {
      "type": "object",
      "description": "Impact by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Example: ``` \"impact\" : { \"id\" : \"<UUID>\" } ``` or ``` \"impact\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "location": {
      "type": "object",
      "description": "Location by id. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Example: ``` \"location\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "mainIncident": {
      "type": "object",
      "description": "Main incident id or number, required for creating a partial incident. This must be an open, unarchived second line incident and visible to the operator. It is an error to provide a main incident for non-partial incidents. Can only be set by operators. example: ``` \"mainIncident\" : { \"id\" : \"<UUID>\" } or ```` \"mainIncident\" : { \"number\" : \"I 1909 123\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Either id or name can be used to specify incident"
        },
        "number": {
          "type": "string",
          "description": "Either name or id can be used to specify incident"
        }
      }
    },
    "majorCall": {
      "type": "boolean",
      "description": "Whether the incident is a major call. Can only be set by operators."
    },
    "majorCallObject": {
      "type": "object",
      "description": "Major call by id or number. Can only be set by operators. Example: ``` \"majorCallObject\" : { \"id\" : \"<UUID>\" } ``` or ``` \"majorCallObject\" : { \"name\" : \"I 1909 123\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "object": {
      "type": "object",
      "description": "Object by id or by name. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Examples: ``` \"object\" : { \"id\" : \"<UUID>\" } ``` or ``` \"object\" : { \"name\" : \"OBJ001\" } ``` If both object and location are given, object is set and location is ignored.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "onHold": {
      "type": "boolean",
      "description": "On hold. On hold date will be filled accordingly. Can only be set by operators. Example: ``` \"onHold\" : \"true\" ```"
    },
    "operator": {
      "type": "object",
      "description": "Operator by id. Can only be set by operators. For partials, if not provided, will be automatically copied from the main incident. Example: ``` \"operator\": { \"id\": \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "operatorGroup": {
      "type": "object",
      "description": "Operator group by id. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: ``` \"operatorGroup\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "optionalFields1": {
      "type": "object",
      "description": "The enabled optional fields.",
      "properties": {
        "boolean1": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean2": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean3": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean4": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean5": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "number1": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number2": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number3": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number4": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number5": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "text1": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text2": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text3": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text4": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text5": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "memo1": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo2": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo3": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo4": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo5": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "date1": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date2": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date3": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date4": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date5": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "searchlist1": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist2": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist3": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist4": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist5": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        }
      }
    },
    "optionalFields2": {
      "type": "object",
      "description": "The enabled optional fields.",
      "properties": {
        "boolean1": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean2": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean3": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean4": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean5": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "number1": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number2": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number3": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number4": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number5": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "text1": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text2": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text3": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text4": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text5": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "memo1": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo2": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo3": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo4": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo5": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "date1": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date2": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date3": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date4": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date5": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "searchlist1": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist2": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist3": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist4": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist5": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        }
      }
    },
    "priority": {
      "type": "object",
      "description": "Priority by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Will be automatically filled in if you provide impact and/or urgency leading to a unique priority according to your priority matrix, and the same request doesn't provide a priority. For incidents with a linked SLA, if the priority provided cannot be found in the Service Level Priority List, the duration field of the incident will be emptied. Example: ``` \"priority\" : { \"id\" : \"<UUID>\" } ``` or ``` \"priority\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "processingStatus": {
      "type": "object",
      "description": "Processing status by id or name. Can only be set by operators. Example: ``` \"processingStatus\" : { \"id\" : \"<UUID>\" } ``` or ``` \"processingStatus\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "publishToSsd": {
      "type": "boolean",
      "description": "Whether the incident should be published in the Self Service Desk; only major incidents can be published. Can only be set by operators."
    },
    "request": {
      "type": "string",
      "description": "Initial request. The following html tags can be used to format the text: <ul> <li>&lt;i&gt;</li> <li>&lt;em&gt;</li> <li>&lt;b&gt;</li> <li>&lt;strong&gt;</li> <li>&lt;u&gt;</li> <li>&lt;img&gt; BASE64-encoding has to be used. Only pictures up to the size of 450x450 pixels are supported. Allowed picture-formats: gif, png, bmp, pcx, iff, ras, pnm, psd, jpg. Example: &lt;img src=\"data:image/png;base64,iVBORw0KGgoAAA...\"&gt;</li> <li>&lt;br&gt;</li> <li>&lt;p&gt;</li> <li>&lt;div&gt;</li> </ul> Can be set by operators and persons."
    },
    "responded": {
      "type": "boolean",
      "description": "Whether the incident is responded. SLM-licence is needed. Can only be set by operators. When the setting \"Status determines responded\" is on, this will be filled automatically (manual setting is prohibited)."
    },
    "responseDate": {
      "type": "string",
      "description": "Response date. SLM-licence is needed. Can only be set by operators. Will automatically be set to current date if left out and \"responded : true\" is set. Example: ``` \"responseDate\" : \"2015-11-15T14:00:00.000+0200\" ``` The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000"
    },
    "sla": {
      "type": "object",
      "description": "SLA by id. Can only be set by operators. Example: ``` \"sla\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "status": {
      "type": "string",
      "description": "Status of the incident. Can only be set by operators.",
      "enum": [
        "firstLine",
        "secondLine",
        "partial"
      ]
    },
    "subcategory": {
      "type": "object",
      "description": "Subcategory by id or name. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. It is an error to provide both an id and a name. If a subcategory is provided without a category, the corresponding category will be filled in automatically, unless there are multiple matching categories, in which case the request will fail. Examples: ``` \"subcategory\" : { \"id\" : \"<UUID>\" } ``` or ``` \"subcategory\" : { \"name\" : \"Printer\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "supplier": {
      "type": "object",
      "description": "Supplier by id. Can only be set by operators. Example: ``` \"supplier\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "targetDate": {
      "type": "object",
      "description": "Target date. Can only be set by operators. Example: ``` \"targetDate\" : \"2015-11-15T14:00:00.000+0200\" ``` The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "urgency": {
      "type": "object",
      "description": "Urgency by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Example: ``` \"urgency\" : { \"id\" : \"<UUID>\" } ``` or ``` \"urgency\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_create_incident_timespent

Register time spent on an incident by id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The incident id
entryDate	string	No	—	Date for when the time spent should be registered. If not set, will be set to the current time. Example: "entryDate": : "2015-11-15T14:00:00.000+0200" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000
notes	string	No	—	Notes for the entry of registered time spent Example: "notes": "Took a bit longer to find a patch than expected."
operator	object	No	—	Operator by id. If not set, currently logged in operator will be used. Example: "operator" : { "id" : "<UUID>" }
operatorGroup	object	No	—	Operator group by id. Must match with the specified operator. If no operator specified, operator group will also be set as the operator. Example: "operatorGroup" : { "id" : "<UUID>" }
reason	object	No	—	The reason value
timeSpent	integer	Yes	—	Time spent in minutes. Can be negative as long as the total registered time on the incident does not go below 0. Can not be 0. Example: "timeSpent": 30

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The incident id"
    },
    "entryDate": {
      "type": "string",
      "description": "Date for when the time spent should be registered. If not set, will be set to the current time. Example: `\"entryDate\": : \"2015-11-15T14:00:00.000+0200\"` The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000"
    },
    "notes": {
      "type": "string",
      "description": "Notes for the entry of registered time spent Example: `\"notes\": \"Took a bit longer to find a patch than expected.\"`"
    },
    "operator": {
      "type": "object",
      "description": "Operator by id. If not set, currently logged in operator will be used. Example: `\"operator\" : { \"id\" : \"<UUID>\" }`",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "operatorGroup": {
      "type": "object",
      "description": "Operator group by id. Must match with the specified operator. If no operator specified, operator group will also be set as the operator. Example: `\"operatorGroup\" : { \"id\" : \"<UUID>\" }`",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "reason": {
      "type": "object",
      "description": "The reason value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        }
      }
    },
    "timeSpent": {
      "type": "integer",
      "description": "Time spent in minutes. Can be negative as long as the total registered time on the incident does not go below 0. Can not be 0. Example: `\"timeSpent\": 30`"
    }
  },
  "required": [
    "PCID",
    "id",
    "timeSpent"
  ]
}

---

topdesk_deescalate_incident

Deescalate an incident by id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The incident id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The incident id"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

topdesk_delete_incident_actions

Delete action by incident id and action id

Parameters:

Parameter	Type	Required	Default	Description
incidentid	string	Yes	—	incident id
actionid	string	Yes	—	action id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "incidentid": {
      "type": "string",
      "description": "incident id"
    },
    "actionid": {
      "type": "string",
      "description": "action id"
    }
  },
  "required": [
    "PCID",
    "incidentid",
    "actionid"
  ]
}

---

topdesk_delete_incident_attachments

Delete a file from an incident identified by id

Parameters:

Parameter	Type	Required	Default	Description
incidentId	string	Yes	—	The incident id
attachmentId	string	Yes	—	The attachment id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "incidentId": {
      "type": "string",
      "description": "The incident id"
    },
    "attachmentId": {
      "type": "string",
      "description": "The attachment id"
    }
  },
  "required": [
    "PCID",
    "incidentId",
    "attachmentId"
  ]
}

---

topdesk_delete_incident_requests

Delete request by incident id and request id

Parameters:

Parameter	Type	Required	Default	Description
incidentid	string	Yes	—	incident id
requestid	string	Yes	—	request id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "incidentid": {
      "type": "string",
      "description": "incident id"
    },
    "requestid": {
      "type": "string",
      "description": "request id"
    }
  },
  "required": [
    "PCID",
    "incidentid",
    "requestid"
  ]
}

---

topdesk_escalate_incident

Escalate an incident by id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The incident id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The incident id"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

topdesk_get_incident

Returns an incident.

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The uuid of the incident

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The uuid of the incident"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

topdesk_get_incident_actions

Get incident actions by incident id and action id

Parameters:

Parameter	Type	Required	Default	Description
incidentid	string	Yes	—	incident id
actionid	string	Yes	—	action id
inlineimages	boolean	No	—	Whether inline images should be returned
non_api_attachment_urls	boolean	No	—	Whether links to attachments and bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "incidentid": {
      "type": "string",
      "description": "incident id"
    },
    "actionid": {
      "type": "string",
      "description": "action id"
    },
    "inlineimages": {
      "type": "boolean",
      "description": "Whether inline images should be returned"
    },
    "non_api_attachment_urls": {
      "type": "boolean",
      "description": "Whether links to attachments and bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user"
    }
  },
  "required": [
    "PCID",
    "incidentid",
    "actionid"
  ]
}

---

topdesk_get_incident_free_fields_searchlists

Get list of optional drop-down values

Parameters:

Parameter	Type	Required	Default	Description
tab	number	Yes	—	The tab number
searchlist	number	Yes	—	The list of optional drop-down values

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "tab": {
      "type": "number",
      "description": "The tab number",
      "enum": [
        1,
        2
      ]
    },
    "searchlist": {
      "type": "number",
      "description": "The list of optional drop-down values",
      "enum": [
        1,
        2,
        3,
        4,
        5
      ]
    }
  },
  "required": [
    "PCID",
    "tab",
    "searchlist"
  ]
}

---

topdesk_get_incident_requests

Get incident request by incident id and request id

Parameters:

Parameter	Type	Required	Default	Description
incidentid	string	Yes	—	incident id
requestid	string	Yes	—	request id
inlineimages	boolean	No	—	Whether inline images should be returned
non_api_attachment_urls	boolean	No	—	Whether links to bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "incidentid": {
      "type": "string",
      "description": "incident id"
    },
    "requestid": {
      "type": "string",
      "description": "request id"
    },
    "inlineimages": {
      "type": "boolean",
      "description": "Whether inline images should be returned"
    },
    "non_api_attachment_urls": {
      "type": "boolean",
      "description": "Whether links to bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user"
    }
  },
  "required": [
    "PCID",
    "incidentid",
    "requestid"
  ]
}

---

topdesk_get_incident_timeregistrations

Returns an timeregistration by id.

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The uuid of the time registartion

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The uuid of the time registartion"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

topdesk_list_incident

Returns a list of incidents.

Parameters:

Parameter	Type	Required	Default	Description
pageStart	integer	No	—	The offset to start at. The default is 0.
pageSize	integer	No	—	How many incidents should be returned max. Default is 10.
sort	string	No	—	The sort order of the returned incidents. Incidents can be ordered by most of the fields. But for best performance one should order by one of the following fields: callDate, creationDate, modificationDate, targetDate, closedDate or id. It’s faster to order by 1 field only. To specify if the order should be ascending or descending, append “:asc” or “:desc” to the field name. Multiple columns can be specified by comma-joining the orderings. Example: sort=tragetDate:asc,creationDate:desc. Fields not allowed for sorting are: externalLinks, escalationStatus, action, attachments, partialIncidents, partialIncidents.link
query	string	No	—	A FIQL string to select which incidents should be returned. (See Tutorial)
fields	string	No	—	A comma-separated list of which fields should be returned. By default all fields will be returned. (slow)
dateFormat	string	No	—	Format of date fields in json. When set to iso8601 dates will be sent in the form of ‘2020-10-01T14:10:00Z’. Otherwise old date format will be used: ‘2020-10-01T14:10:00.000+0000’
all	boolean	No	—	when present or when present and set to true will make all incident to be returned. Including partials and archived. This overrides the default behaviour when only firstLine and secondLine incidents are returned by default. This can be used in combinations with query parameter to narrow down the requited statuses.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageStart": {
      "type": "integer",
      "description": "The offset to start at. The default is 0."
    },
    "pageSize": {
      "type": "integer",
      "description": "How many incidents should be returned max. Default is 10."
    },
    "sort": {
      "type": "string",
      "description": "The sort order of the returned incidents. Incidents can be ordered by most of the fields. But for best performance one should order by one of the following fields: callDate, creationDate, modificationDate, targetDate, closedDate or id. It's faster to order by 1 field only. To specify if the order should be ascending or descending, append \":asc\" or \":desc\" to the field name. Multiple columns can be specified by comma-joining the orderings. Example: sort=tragetDate:asc,creationDate:desc. Fields not allowed for sorting are: externalLinks, escalationStatus, action, attachments, partialIncidents, partialIncidents.link"
    },
    "query": {
      "type": "string",
      "description": "A FIQL string to select which incidents should be returned. (See [Tutorial](https://developers.topdesk.com/tutorial.html#query))"
    },
    "fields": {
      "type": "string",
      "description": "A comma-separated list of which fields should be returned. By default all fields will be returned. (slow)"
    },
    "dateFormat": {
      "type": "string",
      "description": "Format of date fields in json. When set to iso8601 dates will be sent in the form of '2020-10-01T14:10:00Z'. Otherwise old date format will be used: '2020-10-01T14:10:00.000+0000'",
      "enum": [
        "iso8601"
      ]
    },
    "all": {
      "type": "boolean",
      "description": "when present or when present and set to true will make all incident to be returned. Including partials and archived. This overrides the default behaviour when only _firstLine_ and _secondLine_ incidents are returned by default. This can be used in combinations with _query_ parameter to narrow down the requited statuses."
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_actions

Get incident actions by incident id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	incident id
start	number	No	—	The offset at which to start listing the progress trail entries at
page_size	number	No	—	The amount of progress trail entries to be returned per request
inlineimages	boolean	No	—	Whether inline images should be returned
non_api_attachment_urls	boolean	No	—	Whether links to attachments and bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "incident id"
    },
    "start": {
      "type": "number",
      "description": "The offset at which to start listing the progress trail entries at"
    },
    "page_size": {
      "type": "number",
      "description": "The amount of progress trail entries to be returned per request"
    },
    "inlineimages": {
      "type": "boolean",
      "description": "Whether inline images should be returned"
    },
    "non_api_attachment_urls": {
      "type": "boolean",
      "description": "Whether links to attachments and bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

topdesk_list_incident_attachments

Get incident attachments by incident id

Parameters:

Parameter	Type	Required	Default	Description
incidentId	string	Yes	—	The incident id
start	number	No	—	The offset at which to start listing at
page_size	number	No	—	The amount of entities to be returned per request
non_api_attachment_urls	boolean	No	—	Whether links to bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "incidentId": {
      "type": "string",
      "description": "The incident id"
    },
    "start": {
      "type": "number",
      "description": "The offset at which to start listing at"
    },
    "page_size": {
      "type": "number",
      "description": "The amount of entities to be returned per request"
    },
    "non_api_attachment_urls": {
      "type": "boolean",
      "description": "Whether links to bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user"
    }
  },
  "required": [
    "PCID",
    "incidentId"
  ]
}

---

topdesk_list_incident_call_types

Get list of call types

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_categories

Get list of categories

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_closure_codes

Get list of closure codes

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_deescalation_reasons

Get list of reasons for deescalation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_durations

Get list of durations

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_entry_types

Get list of entry types

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_escalation_reasons

Get list of reasons for escalation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_impacts

Get list of impacts

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_priorities

Get list of priorities

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_progresstrail

Get incident progress trail by incident id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	incident id
start	number	No	—	The offset at which to start listing the progress trail entries at
page_size	number	No	—	The amount of progress trail entries to be returned per request
inlineimages	boolean	No	—	Whether inline images should be returned
non_api_attachment_urls	boolean	No	—	Whether links to attachments and bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "incident id"
    },
    "start": {
      "type": "number",
      "description": "The offset at which to start listing the progress trail entries at"
    },
    "page_size": {
      "type": "number",
      "description": "The amount of progress trail entries to be returned per request"
    },
    "inlineimages": {
      "type": "boolean",
      "description": "Whether inline images should be returned"
    },
    "non_api_attachment_urls": {
      "type": "boolean",
      "description": "Whether links to attachments and bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

topdesk_list_incident_progresstrail_count

Get incident progress trail entry count by incident id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The incident id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The incident id"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

topdesk_list_incident_requests

Get incident requests by incident id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	incident id
start	number	No	—	The offset at which to start listing at
page_size	number	No	—	The amount of entities to be returned per request
inlineimages	boolean	No	—	Whether inline images should be returned
non_api_attachment_urls	boolean	No	—	Whether links to bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "incident id"
    },
    "start": {
      "type": "number",
      "description": "The offset at which to start listing at"
    },
    "page_size": {
      "type": "number",
      "description": "The amount of entities to be returned per request"
    },
    "inlineimages": {
      "type": "boolean",
      "description": "Whether inline images should be returned"
    },
    "non_api_attachment_urls": {
      "type": "boolean",
      "description": "Whether links to bigger versions of inline images should be returned in a format that can be used by a browser (with cookie authentication) instead of by an API user"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

topdesk_list_incident_slas

Get list of SLA services

Parameters:

Parameter	Type	Required	Default	Description
page_size	number	No	—	The amount of SLA services to be returned per request. There is no way to request later ‘pages’, provide more specific filter parameters instead.
incident	string	No	—	An incident number or identifier. If specified, all other filter parameters are ignored, and exactly those SLA services that could apply to the incident will be returned. This filter accounts for the strict/loose validity setting, and contract start and end date.
contract	string	No	—	Return only SLA services for the specified contract id. If specified, the other filter parameters that determine the contract (including ‘person’) are ignored.
person	string	No	—	Shortcut for filtering contract. The values from the person card are used for the contract filtering options. If specified, the other filter parameters that determine the contract (except contractDate) are ignored.
service	string	No	—	A service name or id. If specified, the other filter parameters that determine the service are ignored.
branch	string	No	—	Return only SLA services where the contract applies to the specified branch. The Contract for head branch valid for subsidiary branches’ setting is applied.
budgetHolder	string	No	—	Name or id of a budget holder. Return only SLA services where the contract applies to the specified budget holder.
department	string	No	—	Name or id of a department. Return only SLA services where the contract applies to the specified department.
branchExtraA	string	No	—	Name or id of a branchExtraA. Return only SLA services where the contract applies to the specified branchExtraA.
branchExtraB	string	No	—	Name or id of a branchExtraB. Return only SLA services where the contract applies to the specified branchExtraB.
contractDate	string	No	—	Date on which the contract needs to be valid. If not specified, defaults to now. The date must be specified in UTC, according to ISO 8601.
callType	string	No	—	Name or id of a call type. Return only SLA services where the service is available for to the specified call type.
category	string	No	—	Name (default language only) or id of a category for incidents. Return only SLA services where the service is available for to the specified category.
subcategory	string	No	—	Name (default language only) or id of a subcategory for incidents. Return only SLA services where the service is available for to the specified subcategory.
asset	string	No	—	Name, object id or asset id. Return only SLA services where the service is linked to the specified asset.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page_size": {
      "type": "number",
      "description": "The amount of SLA services to be returned per request. There is no way to request later 'pages', provide more specific filter parameters instead."
    },
    "incident": {
      "type": "string",
      "description": "An incident number or identifier. If specified, all other filter parameters are ignored, and exactly those SLA services that could apply to the incident will be returned. This filter accounts for the strict/loose validity setting, and contract start and end date."
    },
    "contract": {
      "type": "string",
      "description": "Return only SLA services for the specified contract id. If specified, the other filter parameters that determine the contract (including 'person') are ignored."
    },
    "person": {
      "type": "string",
      "description": "Shortcut for filtering contract. The values from the person card are used for the contract filtering options. If specified, the other filter parameters that determine the contract (except contractDate) are ignored."
    },
    "service": {
      "type": "string",
      "description": "A service name or id. If specified, the other filter parameters that determine the service are ignored."
    },
    "branch": {
      "type": "string",
      "description": "Return only SLA services where the contract applies to the specified branch. The Contract for head branch valid for subsidiary branches' setting is applied."
    },
    "budgetHolder": {
      "type": "string",
      "description": "Name or id of a budget holder. Return only SLA services where the contract applies to the specified budget holder."
    },
    "department": {
      "type": "string",
      "description": "Name or id of a department. Return only SLA services where the contract applies to the specified department."
    },
    "branchExtraA": {
      "type": "string",
      "description": "Name or id of a branchExtraA. Return only SLA services where the contract applies to the specified branchExtraA."
    },
    "branchExtraB": {
      "type": "string",
      "description": "Name or id of a branchExtraB. Return only SLA services where the contract applies to the specified branchExtraB."
    },
    "contractDate": {
      "type": "string",
      "description": "Date on which the contract needs to be valid. If not specified, defaults to now. The date must be specified in UTC, according to ISO 8601."
    },
    "callType": {
      "type": "string",
      "description": "Name or id of a call type. Return only SLA services where the service is available for to the specified call type."
    },
    "category": {
      "type": "string",
      "description": "Name (default language only) or id of a category for incidents. Return only SLA services where the service is available for to the specified category."
    },
    "subcategory": {
      "type": "string",
      "description": "Name (default language only) or id of a subcategory for incidents. Return only SLA services where the service is available for to the specified subcategory."
    },
    "asset": {
      "type": "string",
      "description": "Name, object id or asset id. Return only SLA services where the service is linked to the specified asset."
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_slas_services

Get list of services

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_statuses

Get list of processing statuses

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_subcategories

Get list of subcategories

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_timeregistrations

Get list of time registrations. By default only time registartions entries for 1st and 2nd line incidents are returned

Parameters:

Parameter	Type	Required	Default	Description
pageStart	integer	No	—	The offset to start at. The default is 0.
pageSize	integer	No	—	How many entries should be returned max. Default is 100.
sort	string	No	—	The sort order of the returned entries. To specify if the order should be ascending or descending append “:asc” or “:desc” to the field name. Multiple columns can be specified by comma-joining the orderings. Example: sort=timeSpent:asc,creationDate:desc. By default entries are sorted by modificationDate:desc, creationDate:desc
query	string	No	—	A FIQL string to select which incidents should be returned.
fields	string	No	—	A comma-separated list of which fields should be returned. By default only id will be returned. The name of fields corresponds to the names returned in response.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageStart": {
      "type": "integer",
      "description": "The offset to start at. The default is 0."
    },
    "pageSize": {
      "type": "integer",
      "description": "How many entries should be returned max. Default is 100."
    },
    "sort": {
      "type": "string",
      "description": "The sort order of the returned entries. To specify if the order should be ascending or descending append \":asc\" or \":desc\" to the field name. Multiple columns can be specified by comma-joining the orderings. Example: sort=timeSpent:asc,creationDate:desc. By default entries are sorted by modificationDate:desc, creationDate:desc"
    },
    "query": {
      "type": "string",
      "description": "A FIQL string to select which incidents should be returned."
    },
    "fields": {
      "type": "string",
      "description": "A comma-separated list of which fields should be returned. By default only id will be returned. The name of fields corresponds to the names returned in response."
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_list_incident_timespent

Register time spent on an incident by id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The incident id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The incident id"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

topdesk_list_incident_urgencies

Get list of urgencies

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

topdesk_patch_incident

Updates an Incident

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
action	string	No	—	Initial action. The following html tags can be used to format the text: <ul> <li><i></li> <li><em></li> <li><b></li> <li><strong></li> <li><u></li> <li><img> BASE64-encoding has to be used. Only pictures up to the size of 450x450 pixels are supported. Allowed picture-formats: gif, png, bmp, pcx, iff, ras, pnm, psd, jpg. Example: <img src=“data:image/png;base64,iVBORw0KGgoAAA…”></li> <li><br></li> <li><p></li> <li><div></li> </ul> Can be set by operators and persons.
actionInvisibleForCaller	boolean	No	—	Whether the initial action is invisible for persons. Can only be set by operators.
branch	object	No	—	Branch (for Location) by id. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Example: "branch" : &#123; "id" : "&lt;UUID&gt;" &#125;
briefDescription	string	No	—	Brief description. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked.
callDate	string	No	—	The date when this call was registed. Usually that’s the same as when the incident was created, but it can be useful to change it e.g. when registering a call that came in yesterday. Example: "callDate" : "2015-11-15T14:00:00.000+0200"
caller	object	No	—	Using the caller parameter to fill in a registered caller is deprecated, use the callerLookup parameter instead. The caller contact details for this incident. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Is filled in automatically for persons and when the callerLookup parameter is provided. To fill in an unregistered caller, fill in the caller’s name: "caller" : &#123; "dynamicName" : "Firstname Lastname" &#125; It is an error to provide both a name and a registered caller.
callerLookup	object	No	—	Lookup value for filling in a registered caller’s contact details. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. The caller is filled in automatically for persons. Examples: "callerLookup" : &#123; "id" : "&lt;UUID&gt;" &#125; or "callerLookup" : &#123; "email" : "[e-mail]" &#125; It is an error to provide more than one lookup value or to provide an empty callerLookup object.
callType	object	No	—	Call type by id or name. Can be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: "callType" : &#123; "id" : "&lt;UUID&gt;" &#125; or "callType" : &#123; "name" : "Name of Searchlist" &#125;
category	object	No	—	Call type by id or name. Can be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: "callType" : &#123; "id" : "&lt;UUID&gt;" &#125; or "callType" : &#123; "name" : "Name of Searchlist" &#125;
closed	boolean	No	—	Whether the incident is closed. Can only be set by operators. For partials, will be ignored. The value of completed will be used instead.
closedDate	string	No	—	Closed date. Can only be set by operators. For partials, will be ignored. The value of completedDate will be used instead. Example: “closedDate” : “2018-11-15T14:00:00.000+0200” The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2018-10-28T10:30:00.000 is equivalent to 2018-10-28T10:30:00.000+0000
closureCode	object	No	—	Closure code by id or name. Can only be set by operators. Example: "closureCode" : &#123; "id" : "&lt;UUID&gt;" &#125; or "closureCode" : &#123; "name" : "Name of Searchlist" &#125;
completed	boolean	No	—	Whether the incident is completed. Can only be set by operators.
completedDate	string	No	—	Completed date. Can only be set by operators. Example: “completedDate” : “2018-11-15T14:00:00.000+0200” The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2018-10-28T10:30:00.000 is equivalent to 2018-10-28T10:30:00.000+0000
costs	number	No	—	Costs. Can only be set by operators. Example: “costs” : “0.15”
duration	object	No	—	Duration by id or name. Can only be set by operators. Example: "duration" : &#123; "id" : "&lt;UUID&gt;" &#125; or "duration" : &#123; "name" : "Name of Searchlist" &#125;
entryType	object	No	—	Entry type by id or name. Can only be set by operators. Example: "entryType" : &#123; "id" : "&lt;UUID&gt;" &#125; or "entryType" : &#123; "name" : "Name of Searchlist" &#125;
externalLink	object	No	—	External Link
externalNumber	string	No	—	External number. Can only be set by operators. For partials, if not provided, will be automatically copied from the main incident.
feedbackMessage	string	No	—	Leave feedback message on incident, only available for closed incidents and when feedbackRating is given. Can only be set by operators or the caller of the incident. Example: "feedbackMessage" : "Nice!"
feedbackRating	number	No	—	Rate incident, only available for closed incidents. Can only be set by operators or the caller of the incident. Example: "feedbackRating" : "5"
impact	object	No	—	Impact by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Example: "impact" : &#123; "id" : "&lt;UUID&gt;" &#125; or "impact" : &#123; "name" : "Name of Searchlist" &#125;
location	object	No	—	Location by id. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Example: "location" : &#123; "id" : "&lt;UUID&gt;" &#125;
majorCall	boolean	No	—	Whether the incident is a major call. Can only be set by operators.
majorCallObject	object	No	—	Major call by id or number. Can only be set by operators. Example: "majorCallObject" : &#123; "id" : "&lt;UUID&gt;" &#125; or "majorCallObject" : &#123; "name" : "I 1909 123" &#125;
object	object	No	—	Object by id or by name. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Examples: "object" : &#123; "id" : "&lt;UUID&gt;" &#125; or "object" : &#123; "name" : "OBJ001" &#125; If both object and location are given, object is set and location is ignored.
onHold	boolean	No	—	On hold. On hold date will be filled accordingly. Can only be set by operators. Example: "onHold" : "true"
operator	object	No	—	Operator by id. Can only be set by operators. For partials, if not provided, will be automatically copied from the main incident. Example: "operator": &#123; "id": "&lt;UUID&gt;" &#125;
operatorGroup	object	No	—	Operator group by id. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: "operatorGroup" : &#123; "id" : "&lt;UUID&gt;" &#125;
optionalFields1	object	No	—	The enabled optional fields.
optionalFields2	object	No	—	The enabled optional fields.
priority	object	No	—	Priority by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Will be automatically filled in if you provide impact and/or urgency leading to a unique priority according to your priority matrix, and the same request doesn’t provide a priority. For incidents with a linked SLA, if the priority provided cannot be found in the Service Level Priority List, the duration field of the incident will be emptied. Example: "priority" : &#123; "id" : "&lt;UUID&gt;" &#125; or "priority" : &#123; "name" : "Name of Searchlist" &#125;
processingStatus	object	No	—	Processing status by id or name. Can only be set by operators. Example: "processingStatus" : &#123; "id" : "&lt;UUID&gt;" &#125; or "processingStatus" : &#123; "name" : "Name of Searchlist" &#125;
publishToSsd	boolean	No	—	Whether the incident should be published in the Self Service Desk; only major incidents can be published. Can only be set by operators.
request	string	No	—	Initial request. The following html tags can be used to format the text: <ul> <li><i></li> <li><em></li> <li><b></li> <li><strong></li> <li><u></li> <li><img> BASE64-encoding has to be used. Only pictures up to the size of 450x450 pixels are supported. Allowed picture-formats: gif, png, bmp, pcx, iff, ras, pnm, psd, jpg. Example: <img src=“data:image/png;base64,iVBORw0KGgoAAA…”></li> <li><br></li> <li><p></li> <li><div></li> </ul> Can be set by operators and persons.
responded	boolean	No	—	Whether the incident is responded. SLM-licence is needed. Can only be set by operators. When the setting “Status determines responded” is on, this will be filled automatically (manual setting is prohibited).
responseDate	string	No	—	Response date. SLM-licence is needed. Can only be set by operators. Will automatically be set to current date if left out and “responded : true” is set. Example: "responseDate" : "2015-11-15T14:00:00.000+0200" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000
sla	object	No	—	SLA by id. Can only be set by operators. Example: "sla" : &#123; "id" : "&lt;UUID&gt;" &#125;
subcategory	object	No	—	Subcategory by id or name. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. It is an error to provide both an id and a name. If a subcategory is provided without a category, the corresponding category will be filled in automatically, unless there are multiple matching categories, in which case the request will fail. Examples: "subcategory" : &#123; "id" : "&lt;UUID&gt;" &#125; or "subcategory" : &#123; "name" : "Printer" &#125;
supplier	object	No	—	Supplier by id. Can only be set by operators. Example: "supplier" : &#123; "id" : "&lt;UUID&gt;" &#125;
targetDate	object	No	—	Target date. Can only be set by operators. Example: "targetDate" : "2015-11-15T14:00:00.000+0200" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000
urgency	object	No	—	Urgency by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Example: "urgency" : &#123; "id" : "&lt;UUID&gt;" &#125; or "urgency" : &#123; "name" : "Name of Searchlist" &#125;

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "action": {
      "type": "string",
      "description": "Initial action. The following html tags can be used to format the text: <ul> <li>&lt;i&gt;</li> <li>&lt;em&gt;</li> <li>&lt;b&gt;</li> <li>&lt;strong&gt;</li> <li>&lt;u&gt;</li> <li>&lt;img&gt; BASE64-encoding has to be used. Only pictures up to the size of 450x450 pixels are supported. Allowed picture-formats: gif, png, bmp, pcx, iff, ras, pnm, psd, jpg. Example: &lt;img src=\"data:image/png;base64,iVBORw0KGgoAAA...\"&gt;</li> <li>&lt;br&gt;</li> <li>&lt;p&gt;</li> <li>&lt;div&gt;</li> </ul> Can be set by operators and persons."
    },
    "actionInvisibleForCaller": {
      "type": "boolean",
      "description": "Whether the initial action is invisible for persons. Can only be set by operators."
    },
    "branch": {
      "type": "object",
      "description": "Branch (for Location) by id. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Example: ``` \"branch\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "briefDescription": {
      "type": "string",
      "description": "Brief description. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked."
    },
    "callDate": {
      "type": "string",
      "description": "The date when this call was registed. Usually that's the same as when the incident was created, but it can be useful to change it e.g. when registering a call that came in yesterday. Example: ``` \"callDate\" : \"2015-11-15T14:00:00.000+0200\" ```"
    },
    "caller": {
      "type": "object",
      "description": "``` Using the caller parameter to fill in a registered caller is deprecated, use the callerLookup parameter instead. ``` The caller contact details for this incident. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Is filled in automatically for persons and when the callerLookup parameter is provided. To fill in an unregistered caller, fill in the caller's name: ``` \"caller\" : { \"dynamicName\" : \"Firstname Lastname\" } ``` It is an error to provide both a name and a registered caller.",
      "properties": {
        "branch": {
          "type": "object",
          "description": "The caller branch by id. Can only be set by operators. Example: ``` \"caller\" : { \"branch\" : { \"id\" : \"<UUID>\" }} ```"
        },
        "dynamicName": {
          "type": "string",
          "description": "Dynamic Name of the caller. Can only be set by operators. Can only be changed for unregistered callers. Example: ``` \"caller\" : { \"dynamicName\" : \"Ginneken, Erik van\" } ```"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Phone number of the caller. Can only be set by operators. Example: ``` \"caller\" : { \"phoneNumber\" : \"123 456\" } ```"
        },
        "mobileNumber": {
          "type": "string",
          "description": "Mobile phone number of the caller. Can only be set by operators. Example: ``` \"caller\" : { \"mobileNumber\" : \"123 456\" } ```"
        },
        "email": {
          "type": "string",
          "description": "Email of the caller. Can only be set by operators. Example: ``` \"caller\" : { \"email\" : \"[e-mail]\" } ```"
        },
        "department": {
          "type": "object",
          "description": "Department of the caller by id or name. Can only be set by operators. Example: ``` \"caller\" : { \"department\" : { \"id\" : \"<UUID>\" }} ``` or ``` \"department\" : { \"name\" : \"Name of Searchlist\" } ```"
        },
        "locations": {
          "type": "object",
          "description": "Location of the caller by id. Can only be set by operators. Example: ``` \"caller\" : { \"location\" : { \"id\" : \"<UUID>\" } ```"
        },
        "budgetHolder": {
          "type": "object",
          "description": "Budget holder of the caller by id or name. Can only be set by operators. Example: ``` \"caller\" : { \"budgetHolder\" : { \"id\" : \"<UUID>\" } ``` or ``` \"budgetHolder\" : { \"name\" : \"Name of Searchlist\" } ```"
        },
        "personExtraFieldA": {
          "type": "object",
          "description": "Person extra field a of the caller by id or name. Can only be set by operators. Example: ``` \"caller\" : { \"personExtraFieldA\" : { \"id\" : \"<UUID>\" } ``` or ``` \"personExtraFieldA\" : { \"name\" : \"Name of Searchlist\" } ```"
        },
        "personExtraFieldB": {
          "type": "object",
          "description": "Person extra field b of the caller by id or name. Can only be set by operators. Example: ``` \"caller\" : { \"personExtraFieldB\" : { \"id\" : \"<UUID>\" } ``` or ``` \"personExtraFieldB\" : { \"name\" : \"Name of Searchlist\" } ```"
        }
      }
    },
    "callerLookup": {
      "type": "object",
      "description": "Lookup value for filling in a registered caller's contact details. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. The caller is filled in automatically for persons. Examples: ``` \"callerLookup\" : { \"id\" : \"<UUID>\" } ``` or ``` \"callerLookup\" : { \"email\" : \"[e-mail]\" } ``` It is an error to provide more than one lookup value or to provide an empty callerLookup object.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "callType": {
      "type": "object",
      "description": "Call type by id or name. Can be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: ``` \"callType\" : { \"id\" : \"<UUID>\" } ``` or ``` \"callType\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "category": {
      "type": "object",
      "description": "Call type by id or name. Can be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: ``` \"callType\" : { \"id\" : \"<UUID>\" }``` or ``` \"callType\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "closed": {
      "type": "boolean",
      "description": "Whether the incident is closed. Can only be set by operators. For partials, will be ignored. The value of completed will be used instead."
    },
    "closedDate": {
      "type": "string",
      "description": "Closed date. Can only be set by operators. For partials, will be ignored. The value of completedDate will be used instead. Example: \"closedDate\" : \"2018-11-15T14:00:00.000+0200\" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2018-10-28T10:30:00.000 is equivalent to 2018-10-28T10:30:00.000+0000"
    },
    "closureCode": {
      "type": "object",
      "description": "Closure code by id or name. Can only be set by operators. Example: ``` \"closureCode\" : { \"id\" : \"<UUID>\" } ``` or ``` \"closureCode\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "completed": {
      "type": "boolean",
      "description": "Whether the incident is completed. Can only be set by operators."
    },
    "completedDate": {
      "type": "string",
      "description": "Completed date. Can only be set by operators. Example: \"completedDate\" : \"2018-11-15T14:00:00.000+0200\" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2018-10-28T10:30:00.000 is equivalent to 2018-10-28T10:30:00.000+0000"
    },
    "costs": {
      "type": "number",
      "description": "Costs. Can only be set by operators. Example: \"costs\" : \"0.15\""
    },
    "duration": {
      "type": "object",
      "description": "Duration by id or name. Can only be set by operators. Example: ``` \"duration\" : { \"id\" : \"<UUID>\" } ``` or ``` \"duration\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "entryType": {
      "type": "object",
      "description": "Entry type by id or name. Can only be set by operators. Example: ``` \"entryType\" : { \"id\" : \"<UUID>\" } ``` or ``` \"entryType\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "externalLink": {
      "type": "object",
      "description": "External Link",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "type": {
          "type": "string",
          "description": "Integer (supplied as string) to identify the external system by. Can only be set by operators. Needs to be supplied together with a valid id in order to create a link. Example: \"externalLink\" : { \"id\" : \"identifier-of-external-system\", \"type\" : \"11\" }"
        },
        "date": {
          "type": "string",
          "description": "Date of the last synchronization. Can only be set by operators. Example: \"externalLink\" : { \"id\" : \"identifier-of-external-system\", \"type\" : \"11\" , \"date\" : \"2018-09-17T17:36:00\" }"
        }
      }
    },
    "externalNumber": {
      "type": "string",
      "description": "External number. Can only be set by operators. For partials, if not provided, will be automatically copied from the main incident."
    },
    "feedbackMessage": {
      "type": "string",
      "description": "Leave feedback message on incident, only available for closed incidents and when feedbackRating is given. Can only be set by operators or the caller of the incident. Example: ``` \"feedbackMessage\" : \"Nice!\" ```"
    },
    "feedbackRating": {
      "type": "number",
      "description": "Rate incident, only available for closed incidents. Can only be set by operators or the caller of the incident. Example: ``` \"feedbackRating\" : \"5\" ```",
      "enum": [
        1,
        2,
        3,
        4,
        5
      ]
    },
    "impact": {
      "type": "object",
      "description": "Impact by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Example: ``` \"impact\" : { \"id\" : \"<UUID>\" } ``` or ``` \"impact\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "location": {
      "type": "object",
      "description": "Location by id. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Example: ``` \"location\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "majorCall": {
      "type": "boolean",
      "description": "Whether the incident is a major call. Can only be set by operators."
    },
    "majorCallObject": {
      "type": "object",
      "description": "Major call by id or number. Can only be set by operators. Example: ``` \"majorCallObject\" : { \"id\" : \"<UUID>\" } ``` or ``` \"majorCallObject\" : { \"name\" : \"I 1909 123\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "object": {
      "type": "object",
      "description": "Object by id or by name. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Examples: ``` \"object\" : { \"id\" : \"<UUID>\" } ``` or ``` \"object\" : { \"name\" : \"OBJ001\" } ``` If both object and location are given, object is set and location is ignored.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "onHold": {
      "type": "boolean",
      "description": "On hold. On hold date will be filled accordingly. Can only be set by operators. Example: ``` \"onHold\" : \"true\" ```"
    },
    "operator": {
      "type": "object",
      "description": "Operator by id. Can only be set by operators. For partials, if not provided, will be automatically copied from the main incident. Example: ``` \"operator\": { \"id\": \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "operatorGroup": {
      "type": "object",
      "description": "Operator group by id. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: ``` \"operatorGroup\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "optionalFields1": {
      "type": "object",
      "description": "The enabled optional fields.",
      "properties": {
        "boolean1": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean2": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean3": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean4": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean5": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "number1": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number2": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number3": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number4": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number5": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "text1": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text2": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text3": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text4": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text5": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "memo1": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo2": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo3": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo4": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo5": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "date1": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date2": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date3": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date4": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date5": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "searchlist1": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist2": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist3": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist4": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist5": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        }
      }
    },
    "optionalFields2": {
      "type": "object",
      "description": "The enabled optional fields.",
      "properties": {
        "boolean1": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean2": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean3": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean4": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean5": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "number1": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number2": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number3": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number4": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number5": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "text1": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text2": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text3": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text4": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text5": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "memo1": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo2": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo3": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo4": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo5": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "date1": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date2": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date3": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date4": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date5": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "searchlist1": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist2": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist3": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist4": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist5": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        }
      }
    },
    "priority": {
      "type": "object",
      "description": "Priority by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Will be automatically filled in if you provide impact and/or urgency leading to a unique priority according to your priority matrix, and the same request doesn't provide a priority. For incidents with a linked SLA, if the priority provided cannot be found in the Service Level Priority List, the duration field of the incident will be emptied. Example: ``` \"priority\" : { \"id\" : \"<UUID>\" } ``` or ``` \"priority\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "processingStatus": {
      "type": "object",
      "description": "Processing status by id or name. Can only be set by operators. Example: ``` \"processingStatus\" : { \"id\" : \"<UUID>\" } ``` or ``` \"processingStatus\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "publishToSsd": {
      "type": "boolean",
      "description": "Whether the incident should be published in the Self Service Desk; only major incidents can be published. Can only be set by operators."
    },
    "request": {
      "type": "string",
      "description": "Initial request. The following html tags can be used to format the text: <ul> <li>&lt;i&gt;</li> <li>&lt;em&gt;</li> <li>&lt;b&gt;</li> <li>&lt;strong&gt;</li> <li>&lt;u&gt;</li> <li>&lt;img&gt; BASE64-encoding has to be used. Only pictures up to the size of 450x450 pixels are supported. Allowed picture-formats: gif, png, bmp, pcx, iff, ras, pnm, psd, jpg. Example: &lt;img src=\"data:image/png;base64,iVBORw0KGgoAAA...\"&gt;</li> <li>&lt;br&gt;</li> <li>&lt;p&gt;</li> <li>&lt;div&gt;</li> </ul> Can be set by operators and persons."
    },
    "responded": {
      "type": "boolean",
      "description": "Whether the incident is responded. SLM-licence is needed. Can only be set by operators. When the setting \"Status determines responded\" is on, this will be filled automatically (manual setting is prohibited)."
    },
    "responseDate": {
      "type": "string",
      "description": "Response date. SLM-licence is needed. Can only be set by operators. Will automatically be set to current date if left out and \"responded : true\" is set. Example: ``` \"responseDate\" : \"2015-11-15T14:00:00.000+0200\" ``` The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000"
    },
    "sla": {
      "type": "object",
      "description": "SLA by id. Can only be set by operators. Example: ``` \"sla\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "subcategory": {
      "type": "object",
      "description": "Subcategory by id or name. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. It is an error to provide both an id and a name. If a subcategory is provided without a category, the corresponding category will be filled in automatically, unless there are multiple matching categories, in which case the request will fail. Examples: ``` \"subcategory\" : { \"id\" : \"<UUID>\" } ``` or ``` \"subcategory\" : { \"name\" : \"Printer\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "supplier": {
      "type": "object",
      "description": "Supplier by id. Can only be set by operators. Example: ``` \"supplier\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "targetDate": {
      "type": "object",
      "description": "Target date. Can only be set by operators. Example: ``` \"targetDate\" : \"2015-11-15T14:00:00.000+0200\" ``` The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "urgency": {
      "type": "object",
      "description": "Urgency by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Example: ``` \"urgency\" : { \"id\" : \"<UUID>\" } ``` or ``` \"urgency\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

topdesk_unarchive_incident

Unarchive an incident by id

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The incident id
unarchive_partials	boolean	No	—	Whether partial calls should also be unarchived.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The incident id"
    },
    "unarchive_partials": {
      "type": "boolean",
      "description": "Whether partial calls should also be unarchived."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

topdesk_update_incident

Updates an Incident

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
action	string	No	—	Initial action. The following html tags can be used to format the text: <ul> <li><i></li> <li><em></li> <li><b></li> <li><strong></li> <li><u></li> <li><img> BASE64-encoding has to be used. Only pictures up to the size of 450x450 pixels are supported. Allowed picture-formats: gif, png, bmp, pcx, iff, ras, pnm, psd, jpg. Example: <img src=“data:image/png;base64,iVBORw0KGgoAAA…”></li> <li><br></li> <li><p></li> <li><div></li> </ul> Can be set by operators and persons.
actionInvisibleForCaller	boolean	No	—	Whether the initial action is invisible for persons. Can only be set by operators.
branch	object	No	—	Branch (for Location) by id. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Example: "branch" : &#123; "id" : "&lt;UUID&gt;" &#125;
briefDescription	string	No	—	Brief description. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked.
callDate	string	No	—	The date when this call was registed. Usually that’s the same as when the incident was created, but it can be useful to change it e.g. when registering a call that came in yesterday. Example: "callDate" : "2015-11-15T14:00:00.000+0200"
caller	object	No	—	Using the caller parameter to fill in a registered caller is deprecated, use the callerLookup parameter instead. The caller contact details for this incident. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Is filled in automatically for persons and when the callerLookup parameter is provided. To fill in an unregistered caller, fill in the caller’s name: "caller" : &#123; "dynamicName" : "Firstname Lastname" &#125; It is an error to provide both a name and a registered caller.
callerLookup	object	No	—	Lookup value for filling in a registered caller’s contact details. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. The caller is filled in automatically for persons. Examples: "callerLookup" : &#123; "id" : "&lt;UUID&gt;" &#125; or "callerLookup" : &#123; "email" : "[e-mail]" &#125; It is an error to provide more than one lookup value or to provide an empty callerLookup object.
callType	object	No	—	Call type by id or name. Can be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: "callType" : &#123; "id" : "&lt;UUID&gt;" &#125; or "callType" : &#123; "name" : "Name of Searchlist" &#125;
category	object	No	—	Call type by id or name. Can be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: "callType" : &#123; "id" : "&lt;UUID&gt;" &#125; or "callType" : &#123; "name" : "Name of Searchlist" &#125;
closed	boolean	No	—	Whether the incident is closed. Can only be set by operators. For partials, will be ignored. The value of completed will be used instead.
closedDate	string	No	—	Closed date. Can only be set by operators. For partials, will be ignored. The value of completedDate will be used instead. Example: “closedDate” : “2018-11-15T14:00:00.000+0200” The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2018-10-28T10:30:00.000 is equivalent to 2018-10-28T10:30:00.000+0000
closureCode	object	No	—	Closure code by id or name. Can only be set by operators. Example: "closureCode" : &#123; "id" : "&lt;UUID&gt;" &#125; or "closureCode" : &#123; "name" : "Name of Searchlist" &#125;
completed	boolean	No	—	Whether the incident is completed. Can only be set by operators.
completedDate	string	No	—	Completed date. Can only be set by operators. Example: “completedDate” : “2018-11-15T14:00:00.000+0200” The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2018-10-28T10:30:00.000 is equivalent to 2018-10-28T10:30:00.000+0000
costs	number	No	—	Costs. Can only be set by operators. Example: “costs” : “0.15”
duration	object	No	—	Duration by id or name. Can only be set by operators. Example: "duration" : &#123; "id" : "&lt;UUID&gt;" &#125; or "duration" : &#123; "name" : "Name of Searchlist" &#125;
entryType	object	No	—	Entry type by id or name. Can only be set by operators. Example: "entryType" : &#123; "id" : "&lt;UUID&gt;" &#125; or "entryType" : &#123; "name" : "Name of Searchlist" &#125;
externalLink	object	No	—	External Link
externalNumber	string	No	—	External number. Can only be set by operators. For partials, if not provided, will be automatically copied from the main incident.
feedbackMessage	string	No	—	Leave feedback message on incident, only available for closed incidents and when feedbackRating is given. Can only be set by operators or the caller of the incident. Example: "feedbackMessage" : "Nice!"
feedbackRating	number	No	—	Rate incident, only available for closed incidents. Can only be set by operators or the caller of the incident. Example: "feedbackRating" : "5"
impact	object	No	—	Impact by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Example: "impact" : &#123; "id" : "&lt;UUID&gt;" &#125; or "impact" : &#123; "name" : "Name of Searchlist" &#125;
location	object	No	—	Location by id. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Example: "location" : &#123; "id" : "&lt;UUID&gt;" &#125;
majorCall	boolean	No	—	Whether the incident is a major call. Can only be set by operators.
majorCallObject	object	No	—	Major call by id or number. Can only be set by operators. Example: "majorCallObject" : &#123; "id" : "&lt;UUID&gt;" &#125; or "majorCallObject" : &#123; "name" : "I 1909 123" &#125;
object	object	No	—	Object by id or by name. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Examples: "object" : &#123; "id" : "&lt;UUID&gt;" &#125; or "object" : &#123; "name" : "OBJ001" &#125; If both object and location are given, object is set and location is ignored.
onHold	boolean	No	—	On hold. On hold date will be filled accordingly. Can only be set by operators. Example: "onHold" : "true"
operator	object	No	—	Operator by id. Can only be set by operators. For partials, if not provided, will be automatically copied from the main incident. Example: "operator": &#123; "id": "&lt;UUID&gt;" &#125;
operatorGroup	object	No	—	Operator group by id. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: "operatorGroup" : &#123; "id" : "&lt;UUID&gt;" &#125;
optionalFields1	object	No	—	The enabled optional fields.
optionalFields2	object	No	—	The enabled optional fields.
priority	object	No	—	Priority by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Will be automatically filled in if you provide impact and/or urgency leading to a unique priority according to your priority matrix, and the same request doesn’t provide a priority. For incidents with a linked SLA, if the priority provided cannot be found in the Service Level Priority List, the duration field of the incident will be emptied. Example: "priority" : &#123; "id" : "&lt;UUID&gt;" &#125; or "priority" : &#123; "name" : "Name of Searchlist" &#125;
processingStatus	object	No	—	Processing status by id or name. Can only be set by operators. Example: "processingStatus" : &#123; "id" : "&lt;UUID&gt;" &#125; or "processingStatus" : &#123; "name" : "Name of Searchlist" &#125;
publishToSsd	boolean	No	—	Whether the incident should be published in the Self Service Desk; only major incidents can be published. Can only be set by operators.
request	string	No	—	Initial request. The following html tags can be used to format the text: <ul> <li><i></li> <li><em></li> <li><b></li> <li><strong></li> <li><u></li> <li><img> BASE64-encoding has to be used. Only pictures up to the size of 450x450 pixels are supported. Allowed picture-formats: gif, png, bmp, pcx, iff, ras, pnm, psd, jpg. Example: <img src=“data:image/png;base64,iVBORw0KGgoAAA…”></li> <li><br></li> <li><p></li> <li><div></li> </ul> Can be set by operators and persons.
responded	boolean	No	—	Whether the incident is responded. SLM-licence is needed. Can only be set by operators. When the setting “Status determines responded” is on, this will be filled automatically (manual setting is prohibited).
responseDate	string	No	—	Response date. SLM-licence is needed. Can only be set by operators. Will automatically be set to current date if left out and “responded : true” is set. Example: "responseDate" : "2015-11-15T14:00:00.000+0200" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000
sla	object	No	—	SLA by id. Can only be set by operators. Example: "sla" : &#123; "id" : "&lt;UUID&gt;" &#125;
subcategory	object	No	—	Subcategory by id or name. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. It is an error to provide both an id and a name. If a subcategory is provided without a category, the corresponding category will be filled in automatically, unless there are multiple matching categories, in which case the request will fail. Examples: "subcategory" : &#123; "id" : "&lt;UUID&gt;" &#125; or "subcategory" : &#123; "name" : "Printer" &#125;
supplier	object	No	—	Supplier by id. Can only be set by operators. Example: "supplier" : &#123; "id" : "&lt;UUID&gt;" &#125;
targetDate	object	No	—	Target date. Can only be set by operators. Example: "targetDate" : "2015-11-15T14:00:00.000+0200" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000
urgency	object	No	—	Urgency by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Example: "urgency" : &#123; "id" : "&lt;UUID&gt;" &#125; or "urgency" : &#123; "name" : "Name of Searchlist" &#125;

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "action": {
      "type": "string",
      "description": "Initial action. The following html tags can be used to format the text: <ul> <li>&lt;i&gt;</li> <li>&lt;em&gt;</li> <li>&lt;b&gt;</li> <li>&lt;strong&gt;</li> <li>&lt;u&gt;</li> <li>&lt;img&gt; BASE64-encoding has to be used. Only pictures up to the size of 450x450 pixels are supported. Allowed picture-formats: gif, png, bmp, pcx, iff, ras, pnm, psd, jpg. Example: &lt;img src=\"data:image/png;base64,iVBORw0KGgoAAA...\"&gt;</li> <li>&lt;br&gt;</li> <li>&lt;p&gt;</li> <li>&lt;div&gt;</li> </ul> Can be set by operators and persons."
    },
    "actionInvisibleForCaller": {
      "type": "boolean",
      "description": "Whether the initial action is invisible for persons. Can only be set by operators."
    },
    "branch": {
      "type": "object",
      "description": "Branch (for Location) by id. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Example: ``` \"branch\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "briefDescription": {
      "type": "string",
      "description": "Brief description. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked."
    },
    "callDate": {
      "type": "string",
      "description": "The date when this call was registed. Usually that's the same as when the incident was created, but it can be useful to change it e.g. when registering a call that came in yesterday. Example: ``` \"callDate\" : \"2015-11-15T14:00:00.000+0200\" ```"
    },
    "caller": {
      "type": "object",
      "description": "``` Using the caller parameter to fill in a registered caller is deprecated, use the callerLookup parameter instead. ``` The caller contact details for this incident. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Is filled in automatically for persons and when the callerLookup parameter is provided. To fill in an unregistered caller, fill in the caller's name: ``` \"caller\" : { \"dynamicName\" : \"Firstname Lastname\" } ``` It is an error to provide both a name and a registered caller.",
      "properties": {
        "branch": {
          "type": "object",
          "description": "The caller branch by id. Can only be set by operators. Example: ``` \"caller\" : { \"branch\" : { \"id\" : \"<UUID>\" }} ```"
        },
        "dynamicName": {
          "type": "string",
          "description": "Dynamic Name of the caller. Can only be set by operators. Can only be changed for unregistered callers. Example: ``` \"caller\" : { \"dynamicName\" : \"Ginneken, Erik van\" } ```"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Phone number of the caller. Can only be set by operators. Example: ``` \"caller\" : { \"phoneNumber\" : \"123 456\" } ```"
        },
        "mobileNumber": {
          "type": "string",
          "description": "Mobile phone number of the caller. Can only be set by operators. Example: ``` \"caller\" : { \"mobileNumber\" : \"123 456\" } ```"
        },
        "email": {
          "type": "string",
          "description": "Email of the caller. Can only be set by operators. Example: ``` \"caller\" : { \"email\" : \"[e-mail]\" } ```"
        },
        "department": {
          "type": "object",
          "description": "Department of the caller by id or name. Can only be set by operators. Example: ``` \"caller\" : { \"department\" : { \"id\" : \"<UUID>\" }} ``` or ``` \"department\" : { \"name\" : \"Name of Searchlist\" } ```"
        },
        "locations": {
          "type": "object",
          "description": "Location of the caller by id. Can only be set by operators. Example: ``` \"caller\" : { \"location\" : { \"id\" : \"<UUID>\" } ```"
        },
        "budgetHolder": {
          "type": "object",
          "description": "Budget holder of the caller by id or name. Can only be set by operators. Example: ``` \"caller\" : { \"budgetHolder\" : { \"id\" : \"<UUID>\" } ``` or ``` \"budgetHolder\" : { \"name\" : \"Name of Searchlist\" } ```"
        },
        "personExtraFieldA": {
          "type": "object",
          "description": "Person extra field a of the caller by id or name. Can only be set by operators. Example: ``` \"caller\" : { \"personExtraFieldA\" : { \"id\" : \"<UUID>\" } ``` or ``` \"personExtraFieldA\" : { \"name\" : \"Name of Searchlist\" } ```"
        },
        "personExtraFieldB": {
          "type": "object",
          "description": "Person extra field b of the caller by id or name. Can only be set by operators. Example: ``` \"caller\" : { \"personExtraFieldB\" : { \"id\" : \"<UUID>\" } ``` or ``` \"personExtraFieldB\" : { \"name\" : \"Name of Searchlist\" } ```"
        }
      }
    },
    "callerLookup": {
      "type": "object",
      "description": "Lookup value for filling in a registered caller's contact details. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. The caller is filled in automatically for persons. Examples: ``` \"callerLookup\" : { \"id\" : \"<UUID>\" } ``` or ``` \"callerLookup\" : { \"email\" : \"[e-mail]\" } ``` It is an error to provide more than one lookup value or to provide an empty callerLookup object.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "callType": {
      "type": "object",
      "description": "Call type by id or name. Can be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: ``` \"callType\" : { \"id\" : \"<UUID>\" } ``` or ``` \"callType\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "category": {
      "type": "object",
      "description": "Call type by id or name. Can be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: ``` \"callType\" : { \"id\" : \"<UUID>\" }``` or ``` \"callType\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "closed": {
      "type": "boolean",
      "description": "Whether the incident is closed. Can only be set by operators. For partials, will be ignored. The value of completed will be used instead."
    },
    "closedDate": {
      "type": "string",
      "description": "Closed date. Can only be set by operators. For partials, will be ignored. The value of completedDate will be used instead. Example: \"closedDate\" : \"2018-11-15T14:00:00.000+0200\" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2018-10-28T10:30:00.000 is equivalent to 2018-10-28T10:30:00.000+0000"
    },
    "closureCode": {
      "type": "object",
      "description": "Closure code by id or name. Can only be set by operators. Example: ``` \"closureCode\" : { \"id\" : \"<UUID>\" } ``` or ``` \"closureCode\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "completed": {
      "type": "boolean",
      "description": "Whether the incident is completed. Can only be set by operators."
    },
    "completedDate": {
      "type": "string",
      "description": "Completed date. Can only be set by operators. Example: \"completedDate\" : \"2018-11-15T14:00:00.000+0200\" The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2018-10-28T10:30:00.000 is equivalent to 2018-10-28T10:30:00.000+0000"
    },
    "costs": {
      "type": "number",
      "description": "Costs. Can only be set by operators. Example: \"costs\" : \"0.15\""
    },
    "duration": {
      "type": "object",
      "description": "Duration by id or name. Can only be set by operators. Example: ``` \"duration\" : { \"id\" : \"<UUID>\" } ``` or ``` \"duration\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "entryType": {
      "type": "object",
      "description": "Entry type by id or name. Can only be set by operators. Example: ``` \"entryType\" : { \"id\" : \"<UUID>\" } ``` or ``` \"entryType\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "externalLink": {
      "type": "object",
      "description": "External Link",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "type": {
          "type": "string",
          "description": "Integer (supplied as string) to identify the external system by. Can only be set by operators. Needs to be supplied together with a valid id in order to create a link. Example: \"externalLink\" : { \"id\" : \"identifier-of-external-system\", \"type\" : \"11\" }"
        },
        "date": {
          "type": "string",
          "description": "Date of the last synchronization. Can only be set by operators. Example: \"externalLink\" : { \"id\" : \"identifier-of-external-system\", \"type\" : \"11\" , \"date\" : \"2018-09-17T17:36:00\" }"
        }
      }
    },
    "externalNumber": {
      "type": "string",
      "description": "External number. Can only be set by operators. For partials, if not provided, will be automatically copied from the main incident."
    },
    "feedbackMessage": {
      "type": "string",
      "description": "Leave feedback message on incident, only available for closed incidents and when feedbackRating is given. Can only be set by operators or the caller of the incident. Example: ``` \"feedbackMessage\" : \"Nice!\" ```"
    },
    "feedbackRating": {
      "type": "number",
      "description": "Rate incident, only available for closed incidents. Can only be set by operators or the caller of the incident. Example: ``` \"feedbackRating\" : \"5\" ```",
      "enum": [
        1,
        2,
        3,
        4,
        5
      ]
    },
    "impact": {
      "type": "object",
      "description": "Impact by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Example: ``` \"impact\" : { \"id\" : \"<UUID>\" } ``` or ``` \"impact\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "location": {
      "type": "object",
      "description": "Location by id. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Example: ``` \"location\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "majorCall": {
      "type": "boolean",
      "description": "Whether the incident is a major call. Can only be set by operators."
    },
    "majorCallObject": {
      "type": "object",
      "description": "Major call by id or number. Can only be set by operators. Example: ``` \"majorCallObject\" : { \"id\" : \"<UUID>\" } ``` or ``` \"majorCallObject\" : { \"name\" : \"I 1909 123\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "object": {
      "type": "object",
      "description": "Object by id or by name. Can only be set by operators. For partial incidents, this field is determined by the main incident and will give an error if provided in the request. Examples: ``` \"object\" : { \"id\" : \"<UUID>\" } ``` or ``` \"object\" : { \"name\" : \"OBJ001\" } ``` If both object and location are given, object is set and location is ignored.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "onHold": {
      "type": "boolean",
      "description": "On hold. On hold date will be filled accordingly. Can only be set by operators. Example: ``` \"onHold\" : \"true\" ```"
    },
    "operator": {
      "type": "object",
      "description": "Operator by id. Can only be set by operators. For partials, if not provided, will be automatically copied from the main incident. Example: ``` \"operator\": { \"id\": \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "operatorGroup": {
      "type": "object",
      "description": "Operator group by id. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. Example: ``` \"operatorGroup\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "optionalFields1": {
      "type": "object",
      "description": "The enabled optional fields.",
      "properties": {
        "boolean1": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean2": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean3": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean4": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean5": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "number1": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number2": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number3": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number4": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number5": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "text1": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text2": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text3": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text4": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text5": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "memo1": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo2": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo3": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo4": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo5": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "date1": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date2": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date3": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date4": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date5": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "searchlist1": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist2": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist3": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist4": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist5": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        }
      }
    },
    "optionalFields2": {
      "type": "object",
      "description": "The enabled optional fields.",
      "properties": {
        "boolean1": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean2": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean3": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean4": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "boolean5": {
          "type": "boolean",
          "description": "One of five possible boolean fields"
        },
        "number1": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number2": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number3": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number4": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "number5": {
          "type": "number",
          "description": "One of five possible number fields"
        },
        "text1": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text2": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text3": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text4": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "text5": {
          "type": "string",
          "description": "One of five possible text fields"
        },
        "memo1": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo2": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo3": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo4": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "memo5": {
          "type": "string",
          "description": "One of five possible memo fields"
        },
        "date1": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date2": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date3": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date4": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "date5": {
          "type": "string",
          "description": "One of five possible date fields"
        },
        "searchlist1": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist2": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist3": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist4": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        },
        "searchlist5": {
          "type": "object",
          "description": "One of five possible searchlist fields. Currently the name of the dropdown item will not be displayed."
        }
      }
    },
    "priority": {
      "type": "object",
      "description": "Priority by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Will be automatically filled in if you provide impact and/or urgency leading to a unique priority according to your priority matrix, and the same request doesn't provide a priority. For incidents with a linked SLA, if the priority provided cannot be found in the Service Level Priority List, the duration field of the incident will be emptied. Example: ``` \"priority\" : { \"id\" : \"<UUID>\" } ``` or ``` \"priority\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "processingStatus": {
      "type": "object",
      "description": "Processing status by id or name. Can only be set by operators. Example: ``` \"processingStatus\" : { \"id\" : \"<UUID>\" } ``` or ``` \"processingStatus\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "publishToSsd": {
      "type": "boolean",
      "description": "Whether the incident should be published in the Self Service Desk; only major incidents can be published. Can only be set by operators."
    },
    "request": {
      "type": "string",
      "description": "Initial request. The following html tags can be used to format the text: <ul> <li>&lt;i&gt;</li> <li>&lt;em&gt;</li> <li>&lt;b&gt;</li> <li>&lt;strong&gt;</li> <li>&lt;u&gt;</li> <li>&lt;img&gt; BASE64-encoding has to be used. Only pictures up to the size of 450x450 pixels are supported. Allowed picture-formats: gif, png, bmp, pcx, iff, ras, pnm, psd, jpg. Example: &lt;img src=\"data:image/png;base64,iVBORw0KGgoAAA...\"&gt;</li> <li>&lt;br&gt;</li> <li>&lt;p&gt;</li> <li>&lt;div&gt;</li> </ul> Can be set by operators and persons."
    },
    "responded": {
      "type": "boolean",
      "description": "Whether the incident is responded. SLM-licence is needed. Can only be set by operators. When the setting \"Status determines responded\" is on, this will be filled automatically (manual setting is prohibited)."
    },
    "responseDate": {
      "type": "string",
      "description": "Response date. SLM-licence is needed. Can only be set by operators. Will automatically be set to current date if left out and \"responded : true\" is set. Example: ``` \"responseDate\" : \"2015-11-15T14:00:00.000+0200\" ``` The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000"
    },
    "sla": {
      "type": "object",
      "description": "SLA by id. Can only be set by operators. Example: ``` \"sla\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "subcategory": {
      "type": "object",
      "description": "Subcategory by id or name. Can be set by operators. For partials, if not provided, will be automatically copied from the main incident. Can be set by persons only when the appropriate setting for the new call form is checked. It is an error to provide both an id and a name. If a subcategory is provided without a category, the corresponding category will be filled in automatically, unless there are multiple matching categories, in which case the request will fail. Examples: ``` \"subcategory\" : { \"id\" : \"<UUID>\" } ``` or ``` \"subcategory\" : { \"name\" : \"Printer\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    },
    "supplier": {
      "type": "object",
      "description": "Supplier by id. Can only be set by operators. Example: ``` \"supplier\" : { \"id\" : \"<UUID>\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "targetDate": {
      "type": "object",
      "description": "Target date. Can only be set by operators. Example: ``` \"targetDate\" : \"2015-11-15T14:00:00.000+0200\" ``` The given time offset will be used. Without a given offset Zulu/UTC time will be assumed. E.g. 2015-10-28T10:30:00.000 is equivalent to 2015-10-28T10:30:00.000+0000",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        }
      }
    },
    "urgency": {
      "type": "object",
      "description": "Urgency by id or name. Can only be set by operators. Cannot be provided for partials as its automatically copied from the main incident. Example: ``` \"urgency\" : { \"id\" : \"<UUID>\" } ``` or ``` \"urgency\" : { \"name\" : \"Name of Searchlist\" } ```",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the item. Either id or name can be used to specify item."
        },
        "name": {
          "type": "string",
          "description": "Name of the item. Either name or id can be used to specify item."
        }
      }
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}