Pingum Events API (v0.1.0)
Download OpenAPI specification:Download
Rest APIs for Pingum Events - Retrieve and Interact with Events, Status, Tags, and much more!
Update Comment
path Parameters
commentId required | integer <int32> commentId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
comment | string Comment text |
commentHeader | string Header or title describing this comment |
Responses
Request samples
- Payload
{- "comment": "string",
- "commentHeader": "string"
}
Create Dashboard
Create a dashboard with preset filters for returning events
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
auditLog | string |
object (SearchEvents) | |
defaultView | string Enum: "list" "grid" "kanban" "analytics" Default view for the dashboard. 'list' is default selection |
description | string Description of the dashobard |
directLinkName required | string Direct link name for accessing the dashboard |
name required | string Name of the dashboard |
organizationExposed required | boolean Is this dashboard available for all organization members? |
Array of objects (Map«string,string») What columns are shown for this dashboard, and in what order |
Responses
Request samples
- Payload
{- "auditLog": "string",
- "dashboardData": {
- "completedLookBackTimeMillis": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "includeArchived": false,
- "includeComplete": false,
- "pastDue": false,
- "presetDateFilter": "Today",
- "searchText": "string",
- "sortStartDateDesc": false,
- "startDate": "2019-08-24T14:15:22Z",
- "statusIds": [
- 0
], - "tagConditions": [
- [
- 27,
- 87
], - [
- 18
]
]
}, - "defaultView": "list",
- "description": "string",
- "directLinkName": "string",
- "name": "string",
- "organizationExposed": false,
- "selectedColumns": [
- {
- "property1": "string",
- "property2": "string"
}
]
}
Update Dashboard
Update and existing dashboard with new data
path Parameters
dashboardId required | integer <int32> dashboardId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
auditLog | string |
object (SearchEvents) | |
defaultView | string Enum: "list" "grid" "kanban" "analytics" Default view for the dashboard. 'list' is default selection |
description | string Description of the dashobard |
directLinkName | string Direct link name for accessing the dashboard |
name | string Name of the dashboard |
organizationExposed required | boolean Is this dashboard available for all organization members? |
Array of objects (Map«string,string») What columns are shown for this dashboard, and in what order |
Responses
Request samples
- Payload
{- "auditLog": "string",
- "dashboardData": {
- "completedLookBackTimeMillis": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "includeArchived": false,
- "includeComplete": false,
- "pastDue": false,
- "presetDateFilter": "Today",
- "searchText": "string",
- "sortStartDateDesc": false,
- "startDate": "2019-08-24T14:15:22Z",
- "statusIds": [
- 0
], - "tagConditions": [
- [
- 27,
- 87
], - [
- 18
]
]
}, - "defaultView": "list",
- "description": "string",
- "directLinkName": "string",
- "name": "string",
- "organizationExposed": false,
- "selectedColumns": [
- {
- "property1": "string",
- "property2": "string"
}
]
}
Create Event Data
Create a data field that can be used as additional data input when creating events
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
Name is used to display the field. Type is used to determine the input type (value must be one of: (Text, Number)
auditLog | string |
configuration | object Configuration for the event data |
description | string Description of the event data field |
name required | string Field Name of the event data field |
order | integer <int32> Order to display the event data field? |
required | boolean Is the Event Data required? |
type required | string Enum: "Text" "Number" "Date" "Datetime" "User" "Address" "Email" "Phone" "YesNo" Data type for the field |
Responses
Request samples
- Payload
{- "auditLog": "string",
- "configuration": { },
- "description": "string",
- "name": "string",
- "order": 0,
- "required": false,
- "type": "Text"
}
Update Event Data
path Parameters
eventDataId required | integer <int32> eventDataId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
Name is used to display the field. Type is used to determine the input type (value must be one of: (Text, Number)
archived | boolean Is the Event Data archived? |
auditLog | string |
configuration | object Configuration for the event data |
description | string Description of the event data field |
name | string Field Name of the event data field |
order | integer <int32> Order to display the event data field? |
required | boolean Is the Event Data required? |
type | string Enum: "Text" "Number" "Date" "Datetime" "User" "Address" "Email" "Phone" "YesNo" Data type for the field |
Responses
Request samples
- Payload
{- "archived": false,
- "auditLog": "string",
- "configuration": { },
- "description": "string",
- "name": "string",
- "order": 0,
- "required": false,
- "type": "Text"
}
Update EventStatus
path Parameters
eventStatusId required | integer <int32> eventStatusId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
assignment | string Assigned users of status. String representation (following user custom field format) of users in format: '@NAME' |
statusComment | string Comment for event status |
Responses
Request samples
- Payload
{- "assignment": "string",
- "statusComment": "string"
}
Update EventStatus
path Parameters
eventStatusId required | integer <int32> eventStatusId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
assignment | string Assigned users of status. String representation (following user custom field format) of users in format: '@NAME' |
statusComment | string Comment for event status |
Responses
Request samples
- Payload
{- "assignment": "string",
- "statusComment": "string"
}
Get Event Templates
query Parameters
includeArchived | boolean Default: false includeArchived |
search | string search |
page | ref Results page you want to retrieve (0..N) |
size | ref Number of records per page. |
sort | Array of strings Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Responses
Create New Event Template
Create an event template by providing the all required data
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
allowActiveDuplicates | boolean Allow multiple active events created from the event template |
configurableName | boolean Allow the name of the event being created or updated from the template to have a different name? |
configurableStartStatus | boolean Allow the starting status of the event being created or updated from the template to be changed for default |
configurableTags | boolean Allow different tags to be provided when creating events from this event template? |
defaultStartStatusId required | integer <int32> ID of the status events created from this event template will start in |
description | string Description of the event template - also used as the description of events created from this event template |
dueDateDefaultTime | integer <int64> The amount of time in millis to auto create the due date from the submission time |
dueDateWorkingTime | object JSON Map of fields that help calculate the working time for due date calculation |
eventData | Array of integers <int32> List of event data fields that will be available when creating events from this event template |
object JSON Map of event data default values to be displayed on event creation forms when template is selected | |
name required | string Name of the event template - also used as the name of events created from this event template |
tags required | Array of integers <int32> List of tag IDs to be assigned to the events created from this event template |
Array of objects (WorkflowStatus) The statuses an event can flow through and how the event should treat each status change. |
Responses
Request samples
- Payload
{- "allowActiveDuplicates": false,
- "configurableName": false,
- "configurableStartStatus": false,
- "configurableTags": false,
- "defaultStartStatusId": 0,
- "description": "string",
- "dueDateDefaultTime": 0,
- "dueDateWorkingTime": { },
- "eventData": [
- 0
], - "eventDataDefaultValues": {
- "property1": "string",
- "property2": "string"
}, - "name": "string",
- "tags": [
- 0
], - "workflowStatuses": [
- {
- "nextStatusOptions": [
- 0
], - "order": 0,
- "requiredAssignment": false,
- "startingStatus": false,
- "statusCommunication": { },
- "statusId": 0
}
]
}
Search For Event Templates
query Parameters
includeArchived | boolean Default: false includeArchived |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
search | string |
statusIds | Array of integers <int32> |
tagConditions | Array of Array of integers The tagConditions field is a conditional search. It will group lists of tag ids together and ensure we grab events which have any of those tag ids in the list. The search next uses an AND condition to grab any other events which have any of the next array of tag Ids based on the previous serches. Ex: [[1,2],[3,4] would return all Event Templates which have a tag with id 1 OR 2. Then with that subset of events, it will filter the returned list with events which have a tag with id 3 OR 4. Events with Tags: [[1 OR 2] AND [3 OR 4] ... ] |
Responses
Request samples
- Payload
{- "search": "string",
- "statusIds": [
- 0
], - "tagConditions": [
- [
- 27,
- 87
], - [
- 18
]
]
}
Update An Event Template
Update event template fields
path Parameters
eventTemplateId required | integer <int32> eventTemplateId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
allowActiveDuplicates | boolean Allow multiple active events created from the event template |
archived | boolean Is the event template archived |
configurableName | boolean Allow the name of the event being created or updated from the template to have a different name? |
configurableStartStatus | boolean Allow the starting status of the event being created or updated from the template to be changed for default |
configurableTags | boolean Allow different tags to be provided when creating events from this event template? |
defaultStartStatusId | integer <int32> ID of the status events created from this event template will start in |
description | string Description of the event template - also used as the description of events created from this event template |
dueDateDefaultTime | integer <int64> The amount of time in millis to auto create the due date from the submission time |
dueDateWorkingTime | object JSON Map of fields that help calculate the working time for due date calculation |
eventData | Array of integers <int32> JSON Map of event data fields that will be available when creating events from this event template |
object JSON Map of event data default values to be displayed on event creation forms when template is selected | |
name | string Name of the event template - also used as the name of events created from this event template |
tags | Array of integers <int32> List of tag IDs to be assigned to the events created from this event template |
Array of objects (WorkflowStatus) The statuses an event can flow through and how the event should treat each status change. |
Responses
Request samples
- Payload
{- "allowActiveDuplicates": false,
- "archived": false,
- "configurableName": false,
- "configurableStartStatus": false,
- "configurableTags": false,
- "defaultStartStatusId": 0,
- "description": "string",
- "dueDateDefaultTime": 0,
- "dueDateWorkingTime": { },
- "eventData": [
- 0
], - "eventDataDefaultValues": {
- "property1": "string",
- "property2": "string"
}, - "name": "string",
- "tags": [
- 0
], - "workflowStatuses": [
- {
- "nextStatusOptions": [
- 0
], - "order": 0,
- "requiredAssignment": false,
- "startingStatus": false,
- "statusCommunication": { },
- "statusId": 0
}
]
}
Create Event From Event Template
Quickly create and event by providing an event templates pre defined data
path Parameters
eventTemplateId required | integer <int32> eventTemplateId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
X-Timezone | string X-Timezone |
Request Body schema: application/json
request
assignment | string Assigned users of status. String representation (following user custom field format) of users in format: '@NAME' |
description | string Description of the event |
dueDate | string <date-time> Due date of the event |
object JSON Map of event data fields and label values for the event | |
name | string Name of event - override name on event template - only allowed on templates that have configurable name set to true |
startingStatusComment | string Comment for the initial status of the event |
startingStatusId | integer <int32> Starting status id of the event |
tags | Array of integers <int32> List of tag IDs to be assigned to the event. Only provide this field if you want to override the tags already defined for the Event Template |
Responses
Request samples
- Payload
{- "assignment": "string",
- "description": "string",
- "dueDate": "2019-08-24T14:15:22Z",
- "eventData": {
- "property1": {
- "type": "string",
- "value": "string"
}, - "property2": {
- "type": "string",
- "value": "string"
}
}, - "name": "string",
- "startingStatusComment": "string",
- "startingStatusId": 0,
- "tags": [
- 0
]
}
Update Event Upload
Update and existing event upload with a new file.
path Parameters
eventUploadId required | integer <int32> eventUploadId |
query Parameters
displayName | string displayName |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: multipart/form-data
file required | string <binary> file |
Responses
Create Event
Create an event by providing the all required data to do so.
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
X-Timezone | string X-Timezone |
Request Body schema: application/json
request
assignment | string Assigned users of status. String representation (following user custom field format) of users in format: '@NAME' |
description | string Description of the event |
dueDate | string <date-time> Date event is due for completion |
object JSON Map of event data fields and label values for the event | |
name required | string Name of the event |
startingStatusComment | string Comment for the initial status of the event |
startingStatusId required | integer <int32> ID of the status this event will start in |
tags required | Array of integers <int32> List of tag IDs to be assigned to the event |
Responses
Request samples
- Payload
{- "assignment": "string",
- "description": "string",
- "dueDate": "2019-08-24T14:15:22Z",
- "eventData": {
- "property1": {
- "type": "string",
- "value": "string"
}, - "property2": {
- "type": "string",
- "value": "string"
}
}, - "name": "string",
- "startingStatusComment": "string",
- "startingStatusId": 0,
- "tags": [
- 0
]
}
Get Event Activity
query Parameters
auth0UserId | string auth0UserId |
page | ref Results page you want to retrieve (0..N) |
size | ref Number of records per page. |
sort | Array of strings Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Responses
Get Analytics Data for Events
Get Analytics for events by providing filters and search criteria
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
X-Timezone | string X-Timezone |
Request Body schema: application/json
request
completedLookBackTimeMillis | integer <int64> (If including completed events) Number of milliseconds to look back for completed events when searching events |
endDate | string <date-time> Return all event starting before this date - null means no end date filter - dateFilter value must be null for this field to be used |
includeArchived | boolean Include archived events? |
includeComplete | boolean Include completed events? |
pastDue | boolean Only show past due events |
presetDateFilter | string Enum: "Today" "ThisWeek" "ThisMonth" Filter events in time range - null means no time range fitler |
searchText | string Filter result with provided text searching the following fields: Event name/description, Tag name/description, Status name, Comments, and Event Data Fields |
sortStartDateDesc | boolean Sort result by start date descending or ascending |
startDate | string <date-time> Return all event starting after this date - null means no start date filter - dateFilter value must be null for this field to be used |
statusIds | Array of integers <int32> Filter result with events in the provided statuses |
tagConditions | Array of Array of integers The tagConditions field is a conditional search. It will group lists of tag ids together and ensure we grab events which have any of those tag ids in the list. The search next uses an AND condition to grab any other events which have any of the next array of tag Ids based on the previous serches. Ex: [[1,2],[3,4] would return all Events which have a tag with id 1 OR 2. Then with that subset of events, it will filter the returned list with events which have a tag with id 3 OR 4. Events with Tags: [[1 OR 2] AND [3 OR 4] ... ] |
Responses
Request samples
- Payload
{- "completedLookBackTimeMillis": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "includeArchived": false,
- "includeComplete": false,
- "pastDue": false,
- "presetDateFilter": "Today",
- "searchText": "string",
- "sortStartDateDesc": false,
- "startDate": "2019-08-24T14:15:22Z",
- "statusIds": [
- 0
], - "tagConditions": [
- [
- 27,
- 87
], - [
- 18
]
]
}
Export Events
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
X-Timezone | string X-Timezone |
Request Body schema: application/json
request
completedLookBackTimeMillis | integer <int64> (If including completed events) Number of milliseconds to look back for completed events when searching events |
endDate | string <date-time> Return all event starting before this date - null means no end date filter - dateFilter value must be null for this field to be used |
includeArchived | boolean Include archived events? |
includeComplete | boolean Include completed events? |
pastDue | boolean Only show past due events |
presetDateFilter | string Enum: "Today" "ThisWeek" "ThisMonth" Filter events in time range - null means no time range fitler |
searchText | string Filter result with provided text searching the following fields: Event name/description, Tag name/description, Status name, Comments, and Event Data Fields |
sortStartDateDesc | boolean Sort result by start date descending or ascending |
startDate | string <date-time> Return all event starting after this date - null means no start date filter - dateFilter value must be null for this field to be used |
statusIds | Array of integers <int32> Filter result with events in the provided statuses |
tagConditions | Array of Array of integers The tagConditions field is a conditional search. It will group lists of tag ids together and ensure we grab events which have any of those tag ids in the list. The search next uses an AND condition to grab any other events which have any of the next array of tag Ids based on the previous serches. Ex: [[1,2],[3,4] would return all Events which have a tag with id 1 OR 2. Then with that subset of events, it will filter the returned list with events which have a tag with id 3 OR 4. Events with Tags: [[1 OR 2] AND [3 OR 4] ... ] |
Responses
Request samples
- Payload
{- "completedLookBackTimeMillis": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "includeArchived": false,
- "includeComplete": false,
- "pastDue": false,
- "presetDateFilter": "Today",
- "searchText": "string",
- "sortStartDateDesc": false,
- "startDate": "2019-08-24T14:15:22Z",
- "statusIds": [
- 0
], - "tagConditions": [
- [
- 27,
- 87
], - [
- 18
]
]
}
Search Events
Search for events by providing filters and search criteria
query Parameters
page | ref Results page you want to retrieve (0..N) |
size | ref Number of records per page. |
updatedAfter | string <date> Only include events created or updated after this date: ISO format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
X-Timezone | string X-Timezone |
Request Body schema: application/json
request
completedLookBackTimeMillis | integer <int64> (If including completed events) Number of milliseconds to look back for completed events when searching events |
endDate | string <date-time> Return all event starting before this date - null means no end date filter - dateFilter value must be null for this field to be used |
includeArchived | boolean Include archived events? |
includeComplete | boolean Include completed events? |
pastDue | boolean Only show past due events |
presetDateFilter | string Enum: "Today" "ThisWeek" "ThisMonth" Filter events in time range - null means no time range fitler |
searchText | string Filter result with provided text searching the following fields: Event name/description, Tag name/description, Status name, Comments, and Event Data Fields |
sortStartDateDesc | boolean Sort result by start date descending or ascending |
startDate | string <date-time> Return all event starting after this date - null means no start date filter - dateFilter value must be null for this field to be used |
statusIds | Array of integers <int32> Filter result with events in the provided statuses |
tagConditions | Array of Array of integers The tagConditions field is a conditional search. It will group lists of tag ids together and ensure we grab events which have any of those tag ids in the list. The search next uses an AND condition to grab any other events which have any of the next array of tag Ids based on the previous serches. Ex: [[1,2],[3,4] would return all Events which have a tag with id 1 OR 2. Then with that subset of events, it will filter the returned list with events which have a tag with id 3 OR 4. Events with Tags: [[1 OR 2] AND [3 OR 4] ... ] |
Responses
Request samples
- Payload
{- "completedLookBackTimeMillis": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "includeArchived": false,
- "includeComplete": false,
- "pastDue": false,
- "presetDateFilter": "Today",
- "searchText": "string",
- "sortStartDateDesc": false,
- "startDate": "2019-08-24T14:15:22Z",
- "statusIds": [
- 0
], - "tagConditions": [
- [
- 27,
- 87
], - [
- 18
]
]
}
Update Event
Update and existing event with new data.
path Parameters
eventId required | integer <int32> eventId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
X-Timezone | string X-Timezone |
Request Body schema: application/json
request
archived | boolean Is the event archived? |
completeEvent | boolean Is the event complete? |
description | string Description of the event |
dueDate | string <date-time> Date event is due for completion |
object JSON Map of event data fields and label values for the event | |
name | string Name of the event |
pastDueDate | boolean |
tags | Array of integers <int32> List of tag IDs to be assigned to the event |
Responses
Request samples
- Payload
{- "archived": false,
- "completeEvent": false,
- "description": "string",
- "dueDate": "2019-08-24T14:15:22Z",
- "eventData": {
- "property1": {
- "type": "string",
- "value": "string"
}, - "property2": {
- "type": "string",
- "value": "string"
}
}, - "name": "string",
- "pastDueDate": true,
- "tags": [
- 0
]
}
Add Comment to Event
path Parameters
eventId required | integer <int32> eventId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
X-Timezone | string X-Timezone |
Request Body schema: application/json
request
comment | string Comment text |
commentHeader | string Header or title describing this comment |
parentCommentId | integer <int32> ID of parent or in reply to comment |
Responses
Request samples
- Payload
{- "comment": "string",
- "commentHeader": "string",
- "parentCommentId": 0
}
Add/Change Status for Event
Move event to the provided status
path Parameters
eventId required | integer <int32> eventId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
X-Timezone | string X-Timezone |
Request Body schema: application/json
request
assignment | string Assigned users of status. String representation (following user custom field format) of users in format: '@NAME' |
completeEvent required | boolean Is this completing the event? |
statusComment | string Comment for new status of event |
statusId required | integer <int32> ID of the status |
Responses
Request samples
- Payload
{- "assignment": "string",
- "completeEvent": false,
- "statusComment": "string",
- "statusId": 0
}
Add/Change Status for Event
Move event to the provided status
path Parameters
eventId required | integer <int32> eventId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
X-Timezone | string X-Timezone |
Request Body schema: application/json
request
assignment | string Assigned users of status. String representation (following user custom field format) of users in format: '@NAME' |
completeEvent required | boolean Is this completing the event? |
statusComment | string Comment for new status of event |
statusId required | integer <int32> ID of the status |
Responses
Request samples
- Payload
{- "assignment": "string",
- "completeEvent": false,
- "statusComment": "string",
- "statusId": 0
}
Add Event Upload to Event
Upload a file to the event
path Parameters
eventId required | integer <int32> eventId |
query Parameters
displayName | string displayName |
sendNotifications | boolean sendNotifications |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
X-Timezone | string X-Timezone |
Request Body schema: multipart/form-data
file required | string <binary> file |
Responses
Create Events From Form
Create events for the given form and templates.
path Parameters
formId required | string formId |
header Parameters
X-Timezone | string X-Timezone |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
object |
Responses
Request samples
- Payload
{- "createEventFromTemplates": {
- "property1": {
- "assignment": "string",
- "description": "string",
- "dueDate": "2019-08-24T14:15:22Z",
- "eventData": {
- "property1": {
- "type": "string",
- "value": "string"
}, - "property2": {
- "type": "string",
- "value": "string"
}
}, - "name": "string",
- "startingStatusComment": "string",
- "startingStatusId": 0,
- "tags": [
- 0
]
}, - "property2": {
- "assignment": "string",
- "description": "string",
- "dueDate": "2019-08-24T14:15:22Z",
- "eventData": {
- "property1": {
- "type": "string",
- "value": "string"
}, - "property2": {
- "type": "string",
- "value": "string"
}
}, - "name": "string",
- "startingStatusComment": "string",
- "startingStatusId": 0,
- "tags": [
- 0
]
}
}
}
Create Status
Creates a new status that events can be placed into. Status order is used for ordering all statuses.
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
auditLog | string |
endingStatus | boolean Does this status represent the ending status for events? If true, when events are moved to this status they will automatically be completed. |
icon | string Icon for the status. This is a text name of any material icon: https://material.io/tools/icons |
iconColor | string Color for the status icon. Must be 7 characters in length representing hex color. |
name required | string Name of the status |
requireComment | boolean Is a comment required when changing an event to this status. |
statusOrder required | integer <int32> Order of the status in relation to other status. Must be greater than 0. |
Responses
Request samples
- Payload
{- "auditLog": "string",
- "endingStatus": false,
- "icon": "credit_card",
- "iconColor": "#1111111",
- "name": "string",
- "requireComment": false,
- "statusOrder": 0
}
Update Status
path Parameters
statusId required | integer <int32> statusId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
archived | boolean Is the status archived? |
auditLog | string |
endingStatus | boolean Does this status represent the ending status for events? If true, when events are moved to this status they will automatically be completed. |
icon | string Icon for the status. This is a text name of any material icon: https://material.io/tools/icons |
iconColor | string Color for the status icon. Must be 7 characters in length representing hex color. |
name | string Name of the status |
requireComment | boolean Is a comment required when changing an event to this status. |
statusOrder | integer <int32> Order of the status in relation to other status. Must be greater than 0. |
Responses
Request samples
- Payload
{- "archived": false,
- "auditLog": "string",
- "endingStatus": false,
- "icon": "credit_card",
- "iconColor": "#1111111",
- "name": "string",
- "requireComment": false,
- "statusOrder": 0
}
Create Status
Creates a new status that events can be placed into. Status order is used for ordering all statuses.
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
auditLog | string |
endingStatus | boolean Does this status represent the ending status for events? If true, when events are moved to this status they will automatically be completed. |
icon | string Icon for the status. This is a text name of any material icon: https://material.io/tools/icons |
iconColor | string Color for the status icon. Must be 7 characters in length representing hex color. |
name required | string Name of the status |
requireComment | boolean Is a comment required when changing an event to this status. |
statusOrder required | integer <int32> Order of the status in relation to other status. Must be greater than 0. |
Responses
Request samples
- Payload
{- "auditLog": "string",
- "endingStatus": false,
- "icon": "credit_card",
- "iconColor": "#1111111",
- "name": "string",
- "requireComment": false,
- "statusOrder": 0
}
Update Status
path Parameters
statusId required | integer <int32> statusId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
archived | boolean Is the status archived? |
auditLog | string |
endingStatus | boolean Does this status represent the ending status for events? If true, when events are moved to this status they will automatically be completed. |
icon | string Icon for the status. This is a text name of any material icon: https://material.io/tools/icons |
iconColor | string Color for the status icon. Must be 7 characters in length representing hex color. |
name | string Name of the status |
requireComment | boolean Is a comment required when changing an event to this status. |
statusOrder | integer <int32> Order of the status in relation to other status. Must be greater than 0. |
Responses
Request samples
- Payload
{- "archived": false,
- "auditLog": "string",
- "endingStatus": false,
- "icon": "credit_card",
- "iconColor": "#1111111",
- "name": "string",
- "requireComment": false,
- "statusOrder": 0
}
Get All Tag Types
Returns all tag types for tenant.
query Parameters
includeArchived | boolean Default: false includeArchived |
includeTags | boolean Default: false includeTags |
buildHierarchicalList | boolean Default: true buildHierarchicalList |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Responses
Create Tag Type
Create new tag type with provided data.
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
auditLog | string |
description | string Description of the tag type |
icon | string Icon for the tag type. This is a text name of any material icon: https://material.io/tools/icons |
iconColor | string Color for the tag type icon. Must be 7 characters in length representing hex color. |
name required | string Name of the tag type |
Responses
Request samples
- Payload
{- "auditLog": "string",
- "description": "string",
- "icon": "credit_card",
- "iconColor": "#1111111",
- "name": "string"
}
Update Tag Type
Update existing tag type with provided data.
path Parameters
tagTypeId required | integer <int32> tagTypeId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
archived | boolean Is the tag type archived? |
auditLog | string |
description | string Description of the tag type |
icon | string Icon for the tag type. This is a text name of any material icon: https://material.io/tools/icons |
iconColor | string Color for the tag type icon. Must be 7 characters in length representing hex color. |
name | string Name of the tag type |
Responses
Request samples
- Payload
{- "archived": false,
- "auditLog": "string",
- "description": "string",
- "icon": "credit_card",
- "iconColor": "#1111111",
- "name": "string"
}
Get Tags For Tag Type
Returns all tags for tag type. Result can be returned in flat list or in the parent child hierarchy.
path Parameters
tagTypeId required | integer <int32> tagTypeId |
query Parameters
includeArchived | boolean Default: false includeArchived |
buildHierarchicalList | boolean Default: false buildHierarchicalList |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Responses
Create Tag For Tag Type
Creates new tag tied to tag type with provided data.
path Parameters
tagTypeId required | integer <int32> tagTypeId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
name required | string Name of the tag |
parentTagId | integer <int32> ID of parent tag - leave null if there is no parent |
Responses
Request samples
- Payload
{- "name": "string",
- "parentTagId": 0
}
Get All Tags
Returns all tags for tenant. Result can be returned in flat list or in the parent child hierarchy.
query Parameters
includeArchived | boolean Default: false includeArchived |
buildHierarchicalList | boolean Default: false buildHierarchicalList |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Responses
Bulk Update Tags
Update a list of existing tags with new data.
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
archived | boolean Is the tag archived? |
object (PatchTagCustomActions) | |
name | string Name of the tag |
parentTagId | integer <int32> ID of parent tag - leave null if there is no parent |
tagId required | integer <int32> ID of the Tag being updated |
tagTypeId | integer <int32> ID of the tag type associated with this tag |
Responses
Request samples
- Payload
[- {
- "archived": false,
- "customActions": {
- "removeParentTag": false
}, - "name": "string",
- "parentTagId": 0,
- "tagId": 0,
- "tagTypeId": 0
}
]
Update Tag
Update and existing tag with new data.
path Parameters
tagId required | integer <int32> tagId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
archived | boolean Is the tag archived? |
object (PatchTagCustomActions) | |
name | string Name of the tag |
parentTagId | integer <int32> ID of parent tag - leave null if there is no parent |
tagTypeId | integer <int32> ID of the tag type associated with this tag |
Responses
Request samples
- Payload
{- "archived": false,
- "customActions": {
- "removeParentTag": false
}, - "name": "string",
- "parentTagId": 0,
- "tagTypeId": 0
}
Search Events User Is Associated With
Search for events a user is associated with including currently assigned, changed a status, or commented
path Parameters
auth0UserId required | string auth0UserId |
query Parameters
page | ref Results page you want to retrieve (0..N) |
size | ref Number of records per page. |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
X-Timezone | string X-Timezone |
Request Body schema: application/json
request
actionType required | string Enum: "Assigned" "ChangedStatus" Which action type to use when returning events for user? |
includeArchived | boolean Include archived events? |
includeComplete | boolean Include completed events? |
Responses
Request samples
- Payload
{- "actionType": "Assigned",
- "includeArchived": false,
- "includeComplete": false
}
Update Subscriptions for User
path Parameters
auth0UserId required | string auth0UserId |
header Parameters
Authorization required | string Authorization |
X-Tenant required | string X-Tenant |
Request Body schema: application/json
request
object (PatchSubscriptionEntity) | |
object (PatchSubscriptionEntity) |
Responses
Request samples
- Payload
{- "dashboards": {
- "add": [
- 0
], - "remove": [
- 0
]
}, - "eventTemplates": {
- "add": [
- 0
], - "remove": [
- 0
]
}
}