Skip to main content

Cases

Cases, activity logs and everything attached to them.

Every path on this page is plugin-scoped: {pluginInstalledId} is the id of the module instance you are talking to, from Plugins. A deployment can run more than one instance of the same module, and the id is what tells them apart.

75 endpoints. Every one needs Authorization: Bearer <access token>; see Getting Started.

Permissions

The server authorises every call against the signed-in user's permission keys — the same keys the client is held to. For this module they are the IT* key family. See the Permission Keys reference.

Activity cases​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/activity-casesActivity case view query

Activity statuses​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/activity-statusesActivity status get all
PUTincident-tracker/plugins/{pluginInstalledId}/activity-statusesActivity status save all
DELETEincident-tracker/plugins/{pluginInstalledId}/activity-statuses/{activityStatusId}Activity status remove
GETincident-tracker/plugins/{pluginInstalledId}/activity-statuses/{activityStatusId}Activity status get by id

PUT incident-tracker/plugins/{pluginInstalledId}/activity-statuses​

Activity status save all.

Payload

Request body

[
  {
    "activityStatusId": 42,
    "activityTypeId": 42,
    "dataOwnerId": 42,
    "description": "Example description",
    "isClosed": true,
    "name": "Example"
  }
]

Response

[
  {
    "activityStatusId": 42,
    "activityTypeId": 42,
    "dataOwnerId": 42,
    "description": "Example description",
    "isClosed": true,
    "name": "Example"
  }
]

Activity tracking​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/activity-trackingActivity tracking view query
POSTincident-tracker/plugins/{pluginInstalledId}/activity-trackingActivity tracking action add
DELETEincident-tracker/plugins/{pluginInstalledId}/activity-tracking/{trackingId}Activity tracking action remove

POST incident-tracker/plugins/{pluginInstalledId}/activity-tracking​

Activity tracking action add.

Payload

Request body

{
  "utcOffset": 42,
  "trackingId": 42,
  "action": "string",
  "activityId": 42,
  "dataOwnerId": 42,
  "dataTimeStamp": "2026-10-02T21:14:05Z",
  "historyTypeId": 42,
  "pluginInstalledId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "userId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
}

Aggregate get fields​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/aggregate-get-fieldsAggregate get fields

Aggregate get numeric fields​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/aggregate-get-numeric-fieldsAggregate get numeric fields

Aggregate grouping get fields​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/aggregate-grouping-get-fieldsAggregate grouping get fields

Aggregate grouping get fields2​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/aggregate-grouping-get-fields2Aggregate grouping get fields2

Aggregate grouping submit query​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/aggregate-grouping-submit-queryAggregate grouping submit query

Aggregate grouping summary query​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/aggregate-grouping-summary-queryAggregate grouping summary query

Aggregate numeric segments submit query​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/aggregate-numeric-segments-submit-queryGets all possible numeric aggregated values for the requested aggregate fields, broken up by number of seconds.

Aggregate numeric submit query​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/aggregate-numeric-submit-queryGets all possible numeric aggregated values for the requested aggregate fields

Aggregate report​

MethodPathWhat it does
POSTincident-tracker/plugins/{pluginInstalledId}/aggregate-reportAggregate report

POST incident-tracker/plugins/{pluginInstalledId}/aggregate-report​

Aggregate report.

Payload

Request body

{
  "queryType": "string",
  "entities": [
    "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
  ],
  "columnQueries": [
    {
      "columnName": "Example",
      "columnQuery": "string",
      "columnQueryTypeId": 42,
      "columnQueryId": 42,
      "referenceDenominator": true
    }
  ],
  "uptoTime": "2026-10-02T21:14:05Z",
  "blockMinuteResolution": 42,
  "iterations": 42
}

Response

{
  "whereParameters": [
    "string"
  ],
  "options": [
    "string"
  ],
  "uptoTime": "2026-10-02T21:14:05Z",
  "blockResolution": 42,
  "iterations": 42,
  "aggregateReportGroupItems": [
    {
      "startingTime": "2026-10-02T21:14:05Z",
      "endingTime": "2026-10-02T21:14:05Z",
      "iteration": 42,
      "entities": [
        {}
      ]
    }
  ],
  "processingTime": 42,
  "columnQueries": [
    {
      "columnName": "Example",
      "columnQuery": "string",
      "columnQueryTypeId": 42,
      "columnQueryId": 42,
      "referenceDenominator": true
    }
  ]
}

Aggregate report2​

MethodPathWhat it does
POSTincident-tracker/plugins/{pluginInstalledId}/aggregate-report2Aggregate report2

POST incident-tracker/plugins/{pluginInstalledId}/aggregate-report2​

Aggregate report2.

Payload

Request body

{
  "queryType": "string",
  "entities": [
    "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
  ],
  "columnQueries": [
    {
      "columnName": "Example",
      "columnQuery": "string",
      "columnQueryTypeId": 42,
      "columnQueryId": 42,
      "referenceDenominator": true
    }
  ],
  "uptoTime": "2026-10-02T21:14:05Z",
  "blockMinuteResolution": 42,
  "iterations": 42,
  "whereParams": [
    "string"
  ],
  "options": [
    "string"
  ]
}

Response

{
  "whereParameters": [
    "string"
  ],
  "options": [
    "string"
  ],
  "uptoTime": "2026-10-02T21:14:05Z",
  "blockResolution": 42,
  "iterations": 42,
  "aggregateReportGroupItems": [
    {
      "startingTime": "2026-10-02T21:14:05Z",
      "endingTime": "2026-10-02T21:14:05Z",
      "iteration": 42,
      "entities": [
        {}
      ]
    }
  ],
  "processingTime": 42,
  "columnQueries": [
    {
      "columnName": "Example",
      "columnQuery": "string",
      "columnQueryTypeId": 42,
      "columnQueryId": 42,
      "referenceDenominator": true
    }
  ]
}

Aggregate submit query​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/aggregate-submit-queryAggregate submit query

Attachments​

MethodPathWhat it does
POSTincident-tracker/plugins/{pluginInstalledId}/attachmentsIncident attachment save
DELETEincident-tracker/plugins/{pluginInstalledId}/attachments/{incidentAttachmentID}Incident attachment remove

POST incident-tracker/plugins/{pluginInstalledId}/attachments​

Incident attachment save.

Payload

Request body

{
  "incidentAttachmentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "attachmentData": "BASE64DATA",
  "attachmentFileName": "Example",
  "dateTimeCreated": "2026-10-02T21:14:05Z",
  "dateTimeUpdated": "2026-10-02T21:14:05Z",
  "fileDescription": "Example description",
  "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "uploadedByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
}

Response

{
  "incidentAttachmentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "attachmentData": "BASE64DATA",
  "attachmentFileName": "Example",
  "dateTimeCreated": "2026-10-02T21:14:05Z",
  "dateTimeUpdated": "2026-10-02T21:14:05Z",
  "fileDescription": "Example description",
  "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "uploadedByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
}

Attributes​

MethodPathWhat it does
POSTincident-tracker/plugins/{pluginInstalledId}/attributes/deleteIncident attributes remove

POST incident-tracker/plugins/{pluginInstalledId}/attributes/delete​

Incident attributes remove.

Payload

Request body

[
  {
    "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "settingKey": "string",
    "doubleValue": 125.5,
    "stringValue": "string"
  }
]

Comments​

MethodPathWhat it does
POSTincident-tracker/plugins/{pluginInstalledId}/commentsIncident comment save
DELETEincident-tracker/plugins/{pluginInstalledId}/comments/{incidentCommentID}Incident comment remove

POST incident-tracker/plugins/{pluginInstalledId}/comments​

Incident comment save.

Payload

Request body

{
  "userName": "Example",
  "utcOffset": 42,
  "incidentCommentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "comment": "string",
  "createdByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "dateTimeCreated": "2026-10-02T21:14:05Z",
  "dateTimeUpdated": "2026-10-02T21:14:05Z",
  "incidentAttachmentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
}

Response

{
  "userName": "Example",
  "utcOffset": 42,
  "incidentCommentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "comment": "string",
  "createdByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "dateTimeCreated": "2026-10-02T21:14:05Z",
  "dateTimeUpdated": "2026-10-02T21:14:05Z",
  "incidentAttachmentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
}

Incident permissions​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/incident-permissionsMaster incident permission get all by permitted id
POSTincident-tracker/plugins/{pluginInstalledId}/incident-permissionsMaster incident permission save

POST incident-tracker/plugins/{pluginInstalledId}/incident-permissions​

Master incident permission save.

Payload

Request body

{
  "masterIncidentId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "permittedId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "grantedPermissionId": 42,
  "idType": 42
}

Response

{
  "masterIncidentId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "permittedId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "grantedPermissionId": 42,
  "idType": 42
}

Incident types​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/incident-typesIncident type get all
POSTincident-tracker/plugins/{pluginInstalledId}/incident-typesIncident type save
DELETEincident-tracker/plugins/{pluginInstalledId}/incident-types/{incidentTypeID}Incident type remove

POST incident-tracker/plugins/{pluginInstalledId}/incident-types​

Incident type save.

Payload

Request body

{
  "incidentTypeID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "name": "Example",
  "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
}

Response

{
  "incidentTypeID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "name": "Example",
  "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
}

Incidents​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/incidentsMaster incidents get all
POSTincident-tracker/plugins/{pluginInstalledId}/incidentsMaster incident save
GETincident-tracker/plugins/{pluginInstalledId}/incidents/{masterIncidentId}Master incident get
DELETEincident-tracker/plugins/{pluginInstalledId}/incidents/{masterIncidentID}Master incident remove
GETincident-tracker/plugins/{pluginInstalledId}/incidents/{masterIncidentID}/attachmentsIncident attachment get all
GETincident-tracker/plugins/{pluginInstalledId}/incidents/{masterIncidentID}/attributesIncident attributes get all
PUTincident-tracker/plugins/{pluginInstalledId}/incidents/{masterIncidentID}/attributesIncident attributes save
GETincident-tracker/plugins/{pluginInstalledId}/incidents/{masterIncidentID}/commentsIncident comment get all
GETincident-tracker/plugins/{pluginInstalledId}/incidents/{masterIncidentID}/mediaIncident media get all
GETincident-tracker/plugins/{pluginInstalledId}/incidents/{masterIncidentId}/permissionsMaster incident permission get all by master incident id
DELETEincident-tracker/plugins/{pluginInstalledId}/incidents/{masterIncidentId}/permissions/{permittedId}Master incident permission remove
PUTincident-tracker/plugins/{pluginInstalledId}/incidents/{masterIncidentId}/personsPersons to master incident
POSTincident-tracker/plugins/{pluginInstalledId}/incidents/queryMaster incident get query params

POST incident-tracker/plugins/{pluginInstalledId}/incidents​

Master incident save.

Payload

Request body

{
  "expectedApiVersion": 42,
  "incidentAttributes": [
    {
      "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "settingKey": "string",
      "doubleValue": 125.5,
      "stringValue": "string"
    }
  ],
  "incidentComments": [
    {
      "userName": "Example",
      "utcOffset": 42,
      "incidentCommentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "comment": "string",
      "createdByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "dateTimeCreated": "2026-10-02T21:14:05Z",
      "dateTimeUpdated": "2026-10-02T21:14:05Z",
      "incidentAttachmentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
    }
  ],
  "incidentMedias": [
    {
      "timeZoneInfoObject": {
        "tzId": "string"
      },
      "timeZoneInfoString": "string",
      "mediaID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "createdByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "dateTimeCreated": "2026-10-02T21:14:05Z",
      "dateTimeUpdated": "2026-10-02T21:14:05Z",
      "incidentServerID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "mediaEndTime": "2026-10-02T21:14:05Z",
      "mediaStartTime": "2026-10-02T21:14:05Z",
      "mediaStatus": 42,
      "mediaStatusMessage": "string",
      "name": "Example",
      "summary": "string",
      "timeZoneId": "string"
    }
  ],
  "userName": "Example",
  "utcOffset": 42,
  "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "activityId": 42,
  "activityNumber": "string",
  "activityStatusId": 42,
  "activityTypeId": 42,
  "caseValue": 125.5,
  "createdByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "dataOwnerId": 42,
  "dateTimeCreated": "2026-10-02T21:14:05Z",
  "dateTimeUpdated": "2026-10-02T21:14:05Z",
  "estimatedLifetimeValue": 125.5,
  "externalReferenceNumber": "string",
  "incidentName": "Example",
  "incidentNumber": 42,
  "incidentSummary": "string",
  "incidentTypeID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "isClosed": true,
  "locationId": 42,
  "masterIncidentIdRef": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "resolutionId": 42,
  "viewerPolicyId": 42
}

Response

{
  "expectedApiVersion": 42,
  "incidentAttributes": [
    {
      "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "settingKey": "string",
      "doubleValue": 125.5,
      "stringValue": "string"
    }
  ],
  "incidentComments": [
    {
      "userName": "Example",
      "utcOffset": 42,
      "incidentCommentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "comment": "string",
      "createdByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "dateTimeCreated": "2026-10-02T21:14:05Z",
      "dateTimeUpdated": "2026-10-02T21:14:05Z",
      "incidentAttachmentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
    }
  ],
  "incidentMedias": [
    {
      "timeZoneInfoObject": {
        "tzId": "string"
      },
      "timeZoneInfoString": "string",
      "mediaID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "createdByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "dateTimeCreated": "2026-10-02T21:14:05Z",
      "dateTimeUpdated": "2026-10-02T21:14:05Z",
      "incidentServerID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "mediaEndTime": "2026-10-02T21:14:05Z",
      "mediaStartTime": "2026-10-02T21:14:05Z",
      "mediaStatus": 42,
      "mediaStatusMessage": "string",
      "name": "Example",
      "summary": "string",
      "timeZoneId": "string"
    }
  ],
  "userName": "Example",
  "utcOffset": 42,
  "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "activityId": 42,
  "activityNumber": "string",
  "activityStatusId": 42,
  "activityTypeId": 42,
  "caseValue": 125.5,
  "createdByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "dataOwnerId": 42,
  "dateTimeCreated": "2026-10-02T21:14:05Z",
  "dateTimeUpdated": "2026-10-02T21:14:05Z",
  "estimatedLifetimeValue": 125.5,
  "externalReferenceNumber": "string",
  "incidentName": "Example",
  "incidentNumber": 42,
  "incidentSummary": "string",
  "incidentTypeID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "isClosed": true,
  "locationId": 42,
  "masterIncidentIdRef": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "resolutionId": 42,
  "viewerPolicyId": 42
}

PUT incident-tracker/plugins/{pluginInstalledId}/incidents/{masterIncidentID}/attributes​

Incident attributes save.

ParameterInRequiredType
masterIncidentIDpathyesuuid
Payload

Request body

[
  {
    "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "settingKey": "string",
    "doubleValue": 125.5,
    "stringValue": "string"
  }
]

Response

[
  {
    "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "settingKey": "string",
    "doubleValue": 125.5,
    "stringValue": "string"
  }
]

PUT incident-tracker/plugins/{pluginInstalledId}/incidents/{masterIncidentId}/persons​

Persons to master incident.

ParameterInRequiredType
masterIncidentIdpathyesuuid
personIdsquerynoarray
removeAssociationquerynoboolean
Payload

POST incident-tracker/plugins/{pluginInstalledId}/incidents/query​

Master incident get query params.

ParameterInRequiredType
maxRecordsquerynoint32
pagequerynoint32
recordsPerPagequerynoint32
orderByquerynostring
Payload

Request body

[
  "string"
]

Response

{
  "resultsList": [
    {
      "expectedApiVersion": 42,
      "incidentAttributes": [
        {}
      ],
      "incidentComments": [
        {}
      ],
      "incidentMedias": [
        {}
      ],
      "userName": "Example",
      "utcOffset": 42,
      "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "activityId": 42,
      "activityNumber": "string",
      "activityStatusId": 42,
      "activityTypeId": 42,
      "caseValue": 125.5,
      "createdByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "dataOwnerId": 42,
      "dateTimeCreated": "2026-10-02T21:14:05Z",
      "dateTimeUpdated": "2026-10-02T21:14:05Z",
      "estimatedLifetimeValue": 125.5,
      "externalReferenceNumber": "string",
      "incidentName": "Example",
      "incidentNumber": 42,
      "incidentSummary": "string",
      "incidentTypeID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "isClosed": true,
      "locationId": 42,
      "masterIncidentIdRef": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "resolutionId": 42,
      "viewerPolicyId": 42
    }
  ],
  "totalRecordCount": 125.5,
  "currentPage": 42,
  "recordsPerPage": 42,
  "whereParameters": [
    "string"
  ],
  "orderBy": "string",
  "queryTime": 42,
  "queryResults": [
    {
      "expectedApiVersion": 42,
      "incidentAttributes": [
        {}
      ],
      "incidentComments": [
        {}
      ],
      "incidentMedias": [
        {}
      ],
      "userName": "Example",
      "utcOffset": 42,
      "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "activityId": 42,
      "activityNumber": "string",
      "activityStatusId": 42,
      "activityTypeId": 42,
      "caseValue": 125.5,
      "createdByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "dataOwnerId": 42,
      "dateTimeCreated": "2026-10-02T21:14:05Z",
      "dateTimeUpdated": "2026-10-02T21:14:05Z",
      "estimatedLifetimeValue": 125.5,
      "externalReferenceNumber": "string",
      "incidentName": "Example",
      "incidentNumber": 42,
      "incidentSummary": "string",
      "incidentTypeID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "isClosed": true,
      "locationId": 42,
      "masterIncidentIdRef": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "resolutionId": 42,
      "viewerPolicyId": 42
    }
  ],
  "queryID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "timeNewest": "2026-10-02T21:14:05Z",
  "timeOldest": "2026-10-02T21:14:05Z"
}

Job action delete​

MethodPathWhat it does
DELETEincident-tracker/plugins/{pluginInstalledId}/job-action-deleteJob action delete

Job action execute​

MethodPathWhat it does
POSTincident-tracker/plugins/{pluginInstalledId}/job-action-executeJob action execute

POST incident-tracker/plugins/{pluginInstalledId}/job-action-execute​

Job action execute.

Payload

Request body

{
  "jobActionId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
}

Job action get all​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/job-action-get-allJob action get all

Job action get by id​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/job-action-get-by-idJob action get by id

Job action save​

MethodPathWhat it does
POSTincident-tracker/plugins/{pluginInstalledId}/job-action-saveJob action save

POST incident-tracker/plugins/{pluginInstalledId}/job-action-save​

Job action save.

Payload

Request body

{
  "utcOffset": 42,
  "userJobs": [
    {
      "jobId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "cronExpression": "string",
      "jobActionId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "jobName": "Example",
      "jobType": 42,
      "pluginInstalledId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "schedulerJobId": "string",
      "timeZone": "string",
      "userGroupId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "userId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
    }
  ],
  "createdByUserName": "Example",
  "jobActionId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "createdBy": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "createdOn": "2026-10-02T21:14:05Z",
  "jobActionConfig": "string",
  "jobActionType": "string",
  "lastUpdatedOn": "2026-10-02T21:14:05Z",
  "parentId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "parentType": "string"
}

Response

{
  "utcOffset": 42,
  "userJobs": [
    {
      "jobId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "cronExpression": "string",
      "jobActionId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "jobName": "Example",
      "jobType": 42,
      "pluginInstalledId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "schedulerJobId": "string",
      "timeZone": "string",
      "userGroupId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "userId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
    }
  ],
  "createdByUserName": "Example",
  "jobActionId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "createdBy": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "createdOn": "2026-10-02T21:14:05Z",
  "jobActionConfig": "string",
  "jobActionType": "string",
  "lastUpdatedOn": "2026-10-02T21:14:05Z",
  "parentId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "parentType": "string"
}

Locations​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/locationsLocation get all
PUTincident-tracker/plugins/{pluginInstalledId}/locationsLocation save all
DELETEincident-tracker/plugins/{pluginInstalledId}/locations/{locationId}Location remove
GETincident-tracker/plugins/{pluginInstalledId}/locations/{locationId}Location get by id

PUT incident-tracker/plugins/{pluginInstalledId}/locations​

Location save all.

Payload

Request body

[
  {
    "locationId": 42,
    "dataOwnerId": 42,
    "fullName": "Example",
    "locationParentId": 42,
    "name": "Example"
  }
]

Response

[
  {
    "locationId": 42,
    "dataOwnerId": 42,
    "fullName": "Example",
    "locationParentId": 42,
    "name": "Example"
  }
]

Media​

MethodPathWhat it does
POSTincident-tracker/plugins/{pluginInstalledId}/mediaIncident media save
DELETEincident-tracker/plugins/{pluginInstalledId}/media/{mediaID}Incident media remove
GETincident-tracker/plugins/{pluginInstalledId}/media/{mediaID}Incident media get

POST incident-tracker/plugins/{pluginInstalledId}/media​

Incident media save.

Payload

Request body

{
  "timeZoneInfoObject": {
    "tzId": "string"
  },
  "timeZoneInfoString": "string",
  "mediaID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "createdByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "dateTimeCreated": "2026-10-02T21:14:05Z",
  "dateTimeUpdated": "2026-10-02T21:14:05Z",
  "incidentServerID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "mediaEndTime": "2026-10-02T21:14:05Z",
  "mediaStartTime": "2026-10-02T21:14:05Z",
  "mediaStatus": 42,
  "mediaStatusMessage": "string",
  "name": "Example",
  "summary": "string",
  "timeZoneId": "string"
}

Response

{
  "timeZoneInfoObject": {
    "tzId": "string"
  },
  "timeZoneInfoString": "string",
  "mediaID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "createdByUserID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "dateTimeCreated": "2026-10-02T21:14:05Z",
  "dateTimeUpdated": "2026-10-02T21:14:05Z",
  "incidentServerID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "masterIncidentID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "mediaEndTime": "2026-10-02T21:14:05Z",
  "mediaStartTime": "2026-10-02T21:14:05Z",
  "mediaStatus": 42,
  "mediaStatusMessage": "string",
  "name": "Example",
  "summary": "string",
  "timeZoneId": "string"
}

Persons​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/personsPersons query
PUTincident-tracker/plugins/{pluginInstalledId}/personsPersons save all
DELETEincident-tracker/plugins/{pluginInstalledId}/persons/{personId}Person remove

PUT incident-tracker/plugins/{pluginInstalledId}/persons​

Persons save all.

Payload

Request body

[
  {
    "personId": 42,
    "createdByUserId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "dataOwnerId": 42,
    "personName": "Example",
    "personNumber": "string",
    "personUniqueId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "pluginInstalledId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
  }
]

Response

[
  {
    "personId": 42,
    "createdByUserId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "dataOwnerId": 42,
    "personName": "Example",
    "personNumber": "string",
    "personUniqueId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "pluginInstalledId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
  }
]

Query count query​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/query-count-queryQuery count query

Query get all​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/query-get-allQuery get all

Query get by id​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/query-get-by-idQuery get by id

Query remove​

MethodPathWhat it does
DELETEincident-tracker/plugins/{pluginInstalledId}/query-removeQuery remove

Query save​

MethodPathWhat it does
POSTincident-tracker/plugins/{pluginInstalledId}/query-saveQuery save

POST incident-tracker/plugins/{pluginInstalledId}/query-save​

Query save.

Payload

Request body

{
  "createdByName": "Example",
  "queryId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "alertsEnabled": true,
  "createdByUserId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "dataOwnerID": 42,
  "isDisabled": true,
  "isPrivate": true,
  "queryData": "string",
  "queryDescription": "Example description",
  "queryEditorData": "string",
  "queryName": "Example",
  "queryTypeId": 42,
  "viewId": 42
}

Response

{
  "createdByName": "Example",
  "queryId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "alertsEnabled": true,
  "createdByUserId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "dataOwnerID": 42,
  "isDisabled": true,
  "isPrivate": true,
  "queryData": "string",
  "queryDescription": "Example description",
  "queryEditorData": "string",
  "queryName": "Example",
  "queryTypeId": 42,
  "viewId": 42
}

Query subscription add​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/query-subscription-addAllow user to add subscription to different BI events

Query subscription add batch​

MethodPathWhat it does
POSTincident-tracker/plugins/{pluginInstalledId}/query-subscription-add-batchQuery subscription add batch

POST incident-tracker/plugins/{pluginInstalledId}/query-subscription-add-batch​

Query subscription add batch.

Payload

Request body

[
  {
    "queryId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "entityUniqueId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "userId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
  }
]

Query subscription get all​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/query-subscription-get-allAllow user to remove subscription

Query subscription remove​

MethodPathWhat it does
DELETEincident-tracker/plugins/{pluginInstalledId}/query-subscription-removeQuery subscription remove

Query subscription remove batch​

MethodPathWhat it does
POSTincident-tracker/plugins/{pluginInstalledId}/query-subscription-remove-batchQuery subscription remove batch

POST incident-tracker/plugins/{pluginInstalledId}/query-subscription-remove-batch​

Query subscription remove batch.

Payload

Request body

[
  {
    "queryId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "entityUniqueId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "userId": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50"
  }
]

Resolutions​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/resolutionsResolution get all
PUTincident-tracker/plugins/{pluginInstalledId}/resolutionsResolution save all
DELETEincident-tracker/plugins/{pluginInstalledId}/resolutions/{resolutionId}Resolution remove
GETincident-tracker/plugins/{pluginInstalledId}/resolutions/{resolutionId}Resolution get by id

PUT incident-tracker/plugins/{pluginInstalledId}/resolutions​

Resolution save all.

Payload

Request body

[
  {
    "resolutionId": 42,
    "activityTypeId": 42,
    "dataOwnerId": 42,
    "description": "Example description",
    "name": "Example"
  }
]

Response

[
  {
    "resolutionId": 42,
    "activityTypeId": 42,
    "dataOwnerId": 42,
    "description": "Example description",
    "name": "Example"
  }
]

Servers​

MethodPathWhat it does
GETincident-tracker/plugins/{pluginInstalledId}/serversIncident server get all
POSTincident-tracker/plugins/{pluginInstalledId}/serversIncident server save
DELETEincident-tracker/plugins/{pluginInstalledId}/servers/{incidentServerID}Incident server remove
GETincident-tracker/plugins/{pluginInstalledId}/servers/{incidentServerID}Incident server get

POST incident-tracker/plugins/{pluginInstalledId}/servers​

Incident server save.

Payload

Request body

{
  "pluginAssociations": [
    {
      "pluginInstalledID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "pluginType": 42,
      "remoteID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "properties": 42,
      "orderIndex": 42
    }
  ],
  "pluginEntityItem": {
    "pluginInstalledID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "pluginType": 42,
    "remoteID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "properties": 42,
    "orderIndex": 42
  },
  "capabilities": [
    42
  ],
  "incidentServerID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "address": "string",
  "isDisabled": true,
  "mediaMountPoint": "string",
  "mediaTCPPort": 42,
  "name": "Example",
  "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "sslTCPPort": 42,
  "tcpPort": 42,
  "useSsl": true
}

Response

{
  "pluginAssociations": [
    {
      "pluginInstalledID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "pluginType": 42,
      "remoteID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "properties": 42,
      "orderIndex": 42
    }
  ],
  "pluginEntityItem": {
    "pluginInstalledID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "pluginType": 42,
    "remoteID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "properties": 42,
    "orderIndex": 42
  },
  "capabilities": [
    42
  ],
  "incidentServerID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "address": "string",
  "isDisabled": true,
  "mediaMountPoint": "string",
  "mediaTCPPort": 42,
  "name": "Example",
  "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "sslTCPPort": 42,
  "tcpPort": 42,
  "useSsl": true
}
Last updated on by Travis Whidden