Dispatch (0.1.0)
Download OpenAPI specification:Download
Welcome to Dispatch's API documentation! Here you will able to discover all of the ways you can interact with the Dispatch API.
Get Organizations
Get all organizations.
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Organization
Create a new organization.
Request Body schema: application/json
banner_color | string or null <color> (Banner Color) |
banner_enabled | boolean or null (Banner Enabled) Default: false |
banner_text | string or null (Banner Text) >= 3 characters ^(?!\s*$).+ |
default | boolean or null (Default) Default: false |
description | string or null (Description) |
id | integer (Id) ( 0 .. 2147483647 ) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
Responses
Request samples
- Payload
{- "banner_color": "string",
- "banner_enabled": false,
- "banner_text": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "banner_color": "string",
- "banner_enabled": false,
- "banner_text": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "slug": "string"
}
Get Organization
Get an organization.
path Parameters
organization_id required | integer (Organization Id) ( 0 .. 2147483647 ) |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "banner_color": "string",
- "banner_enabled": false,
- "banner_text": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "slug": "string"
}
Update Organization
Update an organization.
path Parameters
organization_id required | integer (Organization Id) ( 0 .. 2147483647 ) |
Request Body schema: application/json
banner_color | string or null <color> (Banner Color) |
banner_enabled | boolean or null (Banner Enabled) Default: false |
banner_text | string or null (Banner Text) >= 3 characters ^(?!\s*$).+ |
default | boolean or null (Default) Default: false |
description | string or null (Description) |
id | integer (Id) ( 0 .. 2147483647 ) |
Responses
Request samples
- Payload
{- "banner_color": "string",
- "banner_enabled": false,
- "banner_text": "string",
- "default": false,
- "description": "string",
- "id": 2147483646
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "banner_color": "string",
- "banner_enabled": false,
- "banner_text": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "slug": "string"
}
Login User
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
email required | string <email> (Email) |
Array of objects (Organizations) Default: [] | |
password required | string (Password) |
Array of objects (Projects) Default: [] |
Responses
Request samples
- Payload
{- "email": "user@example.com",
- "organizations": [ ],
- "password": "string",
- "projects": [ ]
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "projects": [
- {
- "default": false,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "role": "string"
}
], - "token": "string"
}
Register User
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
email required | string <email> (Email) |
Array of objects (Organizations) Default: [] | |
password | string or null (Password) |
Array of objects (Projects) Default: [] |
Responses
Request samples
- Payload
{- "email": "user@example.com",
- "organizations": [ ],
- "password": "string",
- "projects": [ ]
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "token": "string"
}
Get Case Priorities
Returns all case priorities.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Get Case Priorities
Returns all case priorities.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Case Priority
Creates a new case priority.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
color | string or null <color> (Color) |
default | boolean (Default) |
description | string or null (Description) |
enabled | boolean (Enabled) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
page_assignee | boolean (Page Assignee) |
object (ProjectRead) | |
view_order | integer (View Order) |
Responses
Request samples
- Payload
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Get Case Priority
Gets a case priority.
path Parameters
case_priority_id required | integer (Case Priority Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Update Case Priority
Updates an existing case priority.
path Parameters
case_priority_id required | integer (Case Priority Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
color | string or null <color> (Color) |
default | boolean (Default) |
description | string or null (Description) |
enabled | boolean (Enabled) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
page_assignee | boolean (Page Assignee) |
object (ProjectRead) | |
view_order | integer (View Order) |
Responses
Request samples
- Payload
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Get Case Severities
Returns all case severities.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Get Case Severities
Returns all case severities.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Case Severity
Creates a new case severity.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
color | string or null <color> (Color) |
default | boolean (Default) |
description | string or null (Description) |
enabled | boolean (Enabled) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
object (ProjectRead) | |
view_order | integer (View Order) |
Responses
Request samples
- Payload
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Get Case Severity
Gets a case severity.
path Parameters
case_severity_id required | integer (Case Severity Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Update Case Severity
Updates an existing case severity.
path Parameters
case_severity_id required | integer (Case Severity Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
color | string or null <color> (Color) |
default | boolean (Default) |
description | string or null (Description) |
enabled | boolean (Enabled) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
object (ProjectRead) | |
view_order | integer (View Order) |
Responses
Request samples
- Payload
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Get Case Types
Returns all case types.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Get Case Types
Returns all case types.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Case Type
Creates a new case type.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
object (Document) | |
conversation_target | string (Conversation Target) |
default | boolean (Default) Default: false |
description | string or null (Description) |
enabled | boolean (Enabled) |
exclude_from_metrics | boolean (Exclude From Metrics) Default: false |
object (IncidentType) | |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
object (Service) | |
Array of objects (Plugin Metadata) Default: [] | |
object (ProjectRead) | |
visibility | string or null (Visibility) |
Responses
Request samples
- Payload
{- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}
Get Case Type
Gets a case type.
path Parameters
case_type_id required | integer (Case Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}
Update Case Type
Updates an existing case type.
path Parameters
case_type_id required | integer (Case Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
object (Document) | |
conversation_target | string (Conversation Target) |
default | boolean (Default) Default: false |
description | string or null (Description) |
enabled | boolean (Enabled) |
exclude_from_metrics | boolean (Exclude From Metrics) Default: false |
id | integer (Id) ( 0 .. 2147483647 ) |
object (IncidentType) | |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
object (Service) | |
Array of objects (Plugin Metadata) Default: [] | |
object (ProjectRead) | |
visibility | string or null (Visibility) |
Responses
Request samples
- Payload
{- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}
Retrieves a list of cases.
Retrieves all cases.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
include[] | Array of strings (Include[]) Default: [] |
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Creates a new case.
Creates a new case.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
object (ParticipantUpdate) | |
object (CasePriorityRead) | |
object (CaseSeverityRead) | |
object (CaseTypeRead) | |
description | string (Description) |
object (ProjectRead) | |
object (ParticipantUpdate) | |
resolution | string (Resolution) |
resolution_reason | string (CaseResolutionReason) Enum: "False Positive" "User Acknowledged" "Mitigated" "Escalated" An enumeration. |
status | string (CaseStatus) Enum: "New" "Triage" "Escalated" "Closed" An enumeration. |
Array of objects (Tags) Default: [] | |
title required | string (Title) |
visibility | string (Visibility) Enum: "Open" "Restricted" An enumeration. |
Responses
Request samples
- Payload
{- "assignee": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "description": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reporter": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "resolution": "string",
- "resolution_reason": "False Positive",
- "status": "New",
- "tags": [ ],
- "title": "string",
- "visibility": "Open"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "assignee": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "closed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "documents": [ ],
- "duplicates": [ ],
- "escalated_at": "2019-08-24T14:15:22Z",
- "events": [ ],
- "groups": [ ],
- "id": 2147483646,
- "incidents": [ ],
- "name": "string",
- "participants": [ ],
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "related": [ ],
- "reported_at": "2019-08-24T14:15:22Z",
- "resolution": "string",
- "resolution_reason": "False Positive",
- "signal_instances": [ ],
- "status": "New",
- "storage": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tags": [ ],
- "ticket": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "title": "string",
- "triage_at": "2019-08-24T14:15:22Z",
- "visibility": "Open",
- "workflow_instances": [ ]
}
Deletes an existing case and its external resources.
Deletes an existing case and its external resources.
path Parameters
case_id required | integer (Case Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Retrieves a single case.
Retrieves the details of a single case.
path Parameters
case_id required | integer (Case Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "assignee": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "closed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "documents": [ ],
- "duplicates": [ ],
- "escalated_at": "2019-08-24T14:15:22Z",
- "events": [ ],
- "groups": [ ],
- "id": 2147483646,
- "incidents": [ ],
- "name": "string",
- "participants": [ ],
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "related": [ ],
- "reported_at": "2019-08-24T14:15:22Z",
- "resolution": "string",
- "resolution_reason": "False Positive",
- "signal_instances": [ ],
- "status": "New",
- "storage": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tags": [ ],
- "ticket": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "title": "string",
- "triage_at": "2019-08-24T14:15:22Z",
- "visibility": "Open",
- "workflow_instances": [ ]
}
Updates an existing case.
Updates an existing case.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
case_id required | integer (Case Id) ( 0 .. 2147483647 ) |
Request Body schema: application/json
object (ParticipantUpdate) | |
object (CasePriorityBase) | |
object (CaseSeverityBase) | |
object (CaseTypeBase) | |
description | string (Description) |
Array of objects (Duplicates) Default: [] | |
escalated_at | string <date-time> (Escalated At) |
Array of objects (Incidents) Default: [] | |
Array of objects (Related) Default: [] | |
reported_at | string <date-time> (Reported At) |
resolution | string (Resolution) |
resolution_reason | string (CaseResolutionReason) Enum: "False Positive" "User Acknowledged" "Mitigated" "Escalated" An enumeration. |
status | string (CaseStatus) Enum: "New" "Triage" "Escalated" "Closed" An enumeration. |
Array of objects (Tags) Default: [] | |
title required | string (Title) |
triage_at | string <date-time> (Triage At) |
visibility | string (Visibility) Enum: "Open" "Restricted" An enumeration. |
Responses
Request samples
- Payload
{- "assignee": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "description": "string",
- "duplicates": [ ],
- "escalated_at": "2019-08-24T14:15:22Z",
- "incidents": [ ],
- "related": [ ],
- "reported_at": "2019-08-24T14:15:22Z",
- "resolution": "string",
- "resolution_reason": "False Positive",
- "status": "New",
- "tags": [ ],
- "title": "string",
- "triage_at": "2019-08-24T14:15:22Z",
- "visibility": "Open"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "assignee": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "closed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "documents": [ ],
- "duplicates": [ ],
- "escalated_at": "2019-08-24T14:15:22Z",
- "events": [ ],
- "groups": [ ],
- "id": 2147483646,
- "incidents": [ ],
- "name": "string",
- "participants": [ ],
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "related": [ ],
- "reported_at": "2019-08-24T14:15:22Z",
- "resolution": "string",
- "resolution_reason": "False Positive",
- "signal_instances": [ ],
- "status": "New",
- "storage": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tags": [ ],
- "ticket": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "title": "string",
- "triage_at": "2019-08-24T14:15:22Z",
- "visibility": "Open",
- "workflow_instances": [ ]
}
Escalates an existing case.
Escalates an existing case.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
object (ParticipantUpdate) | |
description required | string (Description) |
object (IncidentPriorityCreate) | |
object (IncidentSeverityCreate) | |
object (IncidentTypeCreate) | |
object (ProjectRead) | |
object (ParticipantUpdate) | |
resolution | string (Resolution) |
status | string (IncidentStatus) Enum: "Active" "Stable" "Closed" An enumeration. |
Array of objects (Tags) Default: [] | |
title required | string (Title) |
visibility | string (Visibility) Enum: "Open" "Restricted" An enumeration. |
Responses
Request samples
- Payload
{- "commander": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "description": "string",
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}, - "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reporter": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "resolution": "string",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "visibility": "Open"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "cases": [ ],
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "conference": {
- "conference_challenge": "string",
- "conference_id": "string",
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation": {
- "channel_id": "string",
- "description": "string",
- "id": 2147483646,
- "resource_id": "string",
- "resource_type": "string",
- "thread_id": "string",
- "weblink": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "documents": [ ],
- "duplicates": [ ],
- "events": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "id": 2147483646,
- "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}, - "last_executive_report": {
- "created_at": "2019-08-24T14:15:22Z",
- "details": { },
- "id": 0,
- "type": "Tactical Report"
}, - "last_tactical_report": {
- "created_at": "2019-08-24T14:15:22Z",
- "details": { },
- "id": 0,
- "type": "Tactical Report"
}, - "name": "string",
- "participants": [ ],
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "storage": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tags": [ ],
- "tasks": [ ],
- "terms": [ ],
- "ticket": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "title": "string",
- "total_cost": 0,
- "visibility": "Open",
- "workflow_instances": [ ]
}
Create Alert
Creates a new alert.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
external_link | string or null (External Link) |
id | integer (Id) ( 0 .. 2147483647 ) |
name | string (Name) |
originator | string or null (Originator) |
Responses
Request samples
- Payload
{- "description": "string",
- "external_link": "string",
- "id": 2147483646,
- "name": "string",
- "originator": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "external_link": "string",
- "id": 2147483646,
- "name": "string",
- "originator": "string"
}
Delete Alert
Deletes an alert, returning only an HTTP 200 OK if successful.
path Parameters
alert_id required | integer (Alert Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Alert
Given its unique id, retrieve details about a single alert.
path Parameters
alert_id required | integer (Alert Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "external_link": "string",
- "id": 2147483646,
- "name": "string",
- "originator": "string"
}
Update Alert
Updates an alert.
path Parameters
alert_id required | integer (Alert Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
external_link | string or null (External Link) |
id | integer (Id) ( 0 .. 2147483647 ) |
name | string (Name) |
originator | string or null (Originator) |
Responses
Request samples
- Payload
{- "description": "string",
- "external_link": "string",
- "id": 2147483646,
- "name": "string",
- "originator": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "external_link": "string",
- "id": 2147483646,
- "name": "string",
- "originator": "string"
}
Get Queries
Get all queries, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "description": "string",
- "id": 2147483646,
- "language": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "id": 2147483646,
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "text": "string"
}
], - "total": 0
}
Create Query
Creates a new data query.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
language | string or null (Language) |
name | string (Name) |
required | object (ProjectRead) |
required | object (SourceRead) |
Array of objects (Tags) Default: [] | |
text | string or null (Text) |
Responses
Request samples
- Payload
{- "description": "string",
- "language": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "id": 2147483646,
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "text": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "language": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "id": 2147483646,
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "text": "string"
}
Delete Query
Deletes a data query, returning only an HTTP 200 OK if successful.
path Parameters
query_id required | integer (Query Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Query
Given its unique ID, retrieve details about a single query.
path Parameters
query_id required | integer (Query Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "language": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "id": 2147483646,
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "text": "string"
}
Update Query
Updates a data query.
path Parameters
query_id required | integer (Query Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
id | integer (Id) ( 0 .. 2147483647 ) |
language | string or null (Language) |
name | string (Name) |
required | object (ProjectRead) |
required | object (SourceRead) |
Array of objects (Tags) Default: [] | |
text | string or null (Text) |
Responses
Request samples
- Payload
{- "description": "string",
- "id": 2147483646,
- "language": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "id": 2147483646,
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "text": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "language": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "id": 2147483646,
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "text": "string"
}
Get Sources
Get all sources, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "id": 2147483646,
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}
], - "total": 0
}
Create Source
Creates a new source.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
aggregated | boolean or null (Aggregated) Default: false |
Array of objects (Alerts) Default: [] | |
cost | number (Cost) |
data_last_loaded_at | string or null <date-time> (Last Loaded) |
delay | integer or null (Delay) |
description | string or null (Description) |
documentation | string or null (Documentation) |
external_id | string or null (External Id) |
Array of objects (Incidents) Default: [] | |
links | Array of any (Links) Default: [] |
name | string (Name) |
object or null (Owner) | |
required | object (ProjectRead) |
Array of objects (Queries) Default: [] | |
retention | integer or null (Retention) |
sampling_rate | integer or null (Sampling Rate) ( 1 .. 101 ) Rate at which data is sampled (as a percentage) 100% meaning all data is captured. |
size | integer or null (Size) |
object (SourceDataFormatRead) | |
object (SourceEnvironmentRead) | |
source_schema | string or null (Source Schema) |
object (SourceStatusRead) | |
object (SourceTransportRead) | |
object (SourceTypeRead) | |
Array of objects (Tags) Default: [] |
Responses
Request samples
- Payload
{- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "id": 2147483646,
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}
Delete Source
Deletes a source, returning only an HTTP 200 OK if successful.
path Parameters
source_id required | integer (Source Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Source
Given its unique id, retrieve details about a single source.
path Parameters
source_id required | integer (Source Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "id": 2147483646,
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}
Update Source
Updates a source.
path Parameters
source_id required | integer (Source Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
aggregated | boolean or null (Aggregated) Default: false |
Array of objects (Alerts) Default: [] | |
cost | number (Cost) |
data_last_loaded_at | string or null <date-time> (Last Loaded) |
delay | integer or null (Delay) |
description | string or null (Description) |
documentation | string or null (Documentation) |
external_id | string or null (External Id) |
id | integer (Id) ( 0 .. 2147483647 ) |
Array of objects (Incidents) Default: [] | |
links | Array of any (Links) Default: [] |
name | string (Name) |
object or null (Owner) | |
required | object (ProjectRead) |
Array of objects (Queries) Default: [] | |
retention | integer or null (Retention) |
sampling_rate | integer or null (Sampling Rate) ( 1 .. 101 ) Rate at which data is sampled (as a percentage) 100% meaning all data is captured. |
size | integer or null (Size) |
object (SourceDataFormatRead) | |
object (SourceEnvironmentRead) | |
source_schema | string or null (Source Schema) |
object (SourceStatusRead) | |
object (SourceTransportRead) | |
object (SourceTypeRead) | |
Array of objects (Tags) Default: [] |
Responses
Request samples
- Payload
{- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "id": 2147483646,
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "id": 2147483646,
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}
Get Source Data Formats
Get all source data formats, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
], - "total": 0
}
Create Source Data Format
Creates a new source data format.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
name | string (Name) |
required | object (ProjectRead) |
Responses
Request samples
- Payload
{- "description": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Delete Source Data Format
Delete a source data format, returning only an HTTP 200 OK if successful.
path Parameters
source_data_format_id required | integer (Source Data Format Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Source Data Format
Given its unique id, retrieve details about a source data format.
path Parameters
source_data_format_id required | integer (Source Data Format Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Update Source Data Format
Updates a source data format.
path Parameters
source_data_format_id required | integer (Source Data Format Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
id required | integer (Id) ( 0 .. 2147483647 ) |
name | string (Name) |
Responses
Request samples
- Payload
{- "description": "string",
- "id": 2147483646,
- "name": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Get Source Environments
Get all source_environment environments, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
], - "total": 0
}
Create Source Environment
Creates a new source environment.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
name | string (Name) |
required | object (ProjectRead) |
Responses
Request samples
- Payload
{- "description": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Delete Source Environment
Delete a source environment, returning only an HTTP 200 OK if successful.
path Parameters
source_environment_id required | integer (Source Environment Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Source Environment
Given its unique id, retrieve details about a single source_environment environment.
path Parameters
source_environment_id required | integer (Source Environment Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Update Source Environment
Updates a source environment.
path Parameters
source_environment_id required | integer (Source Environment Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
id required | integer (Id) ( 0 .. 2147483647 ) |
name | string (Name) |
Responses
Request samples
- Payload
{- "description": "string",
- "id": 2147483646,
- "name": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Get Source Statuses
Get all source statuses, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
], - "total": 0
}
Create Source Status
Creates a new source status.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
name | string (Name) |
required | object (ProjectRead) |
Responses
Request samples
- Payload
{- "description": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Delete Source Status
Deletes a source status, returning only an HTTP 200 OK if successful.
path Parameters
source_status_id required | integer (Source Status Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Source Status
Given its unique id, retrieve details about a single source status.
path Parameters
source_status_id required | integer (Source Status Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Update Source Status
Updates a source status.
path Parameters
source_status_id required | integer (Source Status Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
id required | integer (Id) ( 0 .. 2147483647 ) |
name | string (Name) |
Responses
Request samples
- Payload
{- "description": "string",
- "id": 2147483646,
- "name": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Get Source Transports
Get all source transports, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
], - "total": 0
}
Create Source Transport
Creates a new source transport.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
name | string (Name) |
required | object (ProjectRead) |
Responses
Request samples
- Payload
{- "description": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Delete Source Transport
Deletes a source transport, returning only an HTTP 200 OK if successful.
path Parameters
source_transport_id required | integer (Source Transport Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Source Transport
Given its unique id, retrieve details about a single source transport.
path Parameters
source_transport_id required | integer (Source Transport Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Update Source Transport
Updates a source transport.
path Parameters
source_transport_id required | integer (Source Transport Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
id required | integer (Id) ( 0 .. 2147483647 ) |
name | string (Name) |
Responses
Request samples
- Payload
{- "description": "string",
- "id": 2147483646,
- "name": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Get Source Types
Get all source types, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
], - "total": 0
}
Create Source Type
Creates a new source type.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
name | string (Name) |
required | object (ProjectRead) |
Responses
Request samples
- Payload
{- "description": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Delete Source Type
Deletes a source type, returning only an HTTP 200 OK if successful.
path Parameters
source_type_id required | integer (Source Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Source Type
Given its unique id, retrieve details about a single source type.
path Parameters
source_type_id required | integer (Source Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Update Source Type
Updates a source type.
path Parameters
source_type_id required | integer (Source Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
id required | integer (Id) ( 0 .. 2147483647 ) |
name | string (Name) |
Responses
Request samples
- Payload
{- "description": "string",
- "id": 2147483646,
- "name": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Get Definitions
Get all definitions.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Definition
Create a new definition.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
required | object (ProjectRead) |
source | string or null (Source) |
Array of objects (Terms) Default: [] | |
text required | string (Text) |
Responses
Request samples
- Payload
{- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": "string",
- "terms": [ ],
- "text": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 2147483646,
- "source": "string",
- "terms": [
- {
- "id": 2147483646,
- "text": "string"
}
], - "text": "string"
}
Get Definition
Update a definition.
path Parameters
definition_id required | integer (Definition Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 2147483646,
- "source": "string",
- "terms": [
- {
- "id": 2147483646,
- "text": "string"
}
], - "text": "string"
}
Update Definition
Update a definition.
path Parameters
definition_id required | integer (Definition Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
source | string or null (Source) |
Array of objects (Terms) Default: [] | |
text required | string (Text) |
Responses
Request samples
- Payload
{- "source": "string",
- "terms": [ ],
- "text": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 2147483646,
- "source": "string",
- "terms": [
- {
- "id": 2147483646,
- "text": "string"
}
], - "text": "string"
}
Get Documents
Get all documents.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Document
Create a new document.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
created_at | string or null <date-time> (Created At) |
description | string or null (Description) |
evergreen | boolean (Evergreen) Default: false |
evergreen_last_reminder_at | string or null <date-time> (Evergreen Last Reminder At) |
evergreen_owner | string <email> (Evergreen Owner) |
evergreen_reminder_interval | integer (Evergreen Reminder Interval) Default: 90 |
Array of objects (Filters) Default: [] | |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
required | object (ProjectRead) |
resource_id | string or null (Resource Id) |
resource_type | string or null (Resource Type) |
updated_at | string or null <date-time> (Updated At) |
weblink | string or null (Weblink) |
Responses
Request samples
- Payload
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [ ],
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "resource_id": "string",
- "resource_type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [ ],
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "resource_id": "string",
- "resource_type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Get Document
Update a document.
path Parameters
document_id required | integer (Document Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [ ],
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "resource_id": "string",
- "resource_type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Update Document
Update a document.
path Parameters
document_id required | integer (Document Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
created_at | string or null <date-time> (Created At) |
description | string or null (Description) |
evergreen | boolean (Evergreen) Default: false |
evergreen_last_reminder_at | string or null <date-time> (Evergreen Last Reminder At) |
evergreen_owner | string <email> (Evergreen Owner) |
evergreen_reminder_interval | integer (Evergreen Reminder Interval) Default: 90 |
Array of objects (Filters) | |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
resource_id | string or null (Resource Id) |
resource_type | string or null (Resource Type) |
updated_at | string or null <date-time> (Updated At) |
weblink | string or null (Weblink) |
Responses
Request samples
- Payload
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [
- {
- "creator": {
- "email": "user@example.com",
- "id": 2147483646,
- "organizations": [ ],
- "projects": [ ],
- "role": "string"
}, - "description": "string",
- "expression": [
- { }
], - "id": 2147483646,
- "name": "string",
- "subject": "incident"
}
], - "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [ ],
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "resource_id": "string",
- "resource_type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Get Entities
Get all entities, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "description": "string",
- "entity_type": {
- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "regular_expression": "string"
}, - "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": "string",
- "value": "string"
}
], - "total": 0
}
Create Entity
Creates a new entity.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
required | object (EntityTypeCreate) |
id | integer (Id) ( 0 .. 2147483647 ) |
name | string or null (Name) |
required | object (ProjectRead) |
source | string or null (Source) |
value | string or null (Value) |
Responses
Request samples
- Payload
{- "description": "string",
- "entity_type": {
- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "regular_expression": "string"
}, - "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": "string",
- "value": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "entity_type": {
- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "regular_expression": "string"
}, - "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": "string",
- "value": "string"
}
Delete Entity
Deletes a entity, returning only an HTTP 200 OK if successful.
path Parameters
entity_id required | integer (Entity Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Entity
Given its unique id, retrieve details about a single entity.
path Parameters
entity_id required | integer (Entity Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "entity_type": {
- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "regular_expression": "string"
}, - "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": "string",
- "value": "string"
}
Update Entity
Updates an existing entity.
path Parameters
entity_id required | integer (Entity Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
object (EntityTypeUpdate) | |
id | integer (Id) ( 0 .. 2147483647 ) |
name | string or null (Name) |
source | string or null (Source) |
value | string or null (Value) |
Responses
Request samples
- Payload
{- "description": "string",
- "entity_type": {
- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "regular_expression": "string"
}, - "id": 2147483646,
- "name": "string",
- "source": "string",
- "value": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "entity_type": {
- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "regular_expression": "string"
}, - "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": "string",
- "value": "string"
}
Get Entity Types
Get all entities, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "regular_expression": "string"
}
], - "total": 0
}
Create Entity Type
Create a new entity.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
enabled | boolean (Enabled) |
global_find | boolean (Global Find) |
id | integer (Id) ( 0 .. 2147483647 ) |
jpath | string or null (Jpath) |
name | string (Name) >= 3 characters ^(?!\s*$).+ |
required | object (ProjectRead) |
regular_expression | string or null (Regular Expression) |
Responses
Request samples
- Payload
{- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "regular_expression": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "regular_expression": "string"
}
Get Entity Type
Get a entity by its id.
path Parameters
entity_type_id required | integer (Entity Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "regular_expression": "string"
}
Update Entity Type
Update an entity.
path Parameters
entity_type_id required | integer (Entity Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
enabled | boolean (Enabled) |
global_find | boolean (Global Find) |
id | integer (Id) ( 0 .. 2147483647 ) |
jpath | string or null (Jpath) |
name | string (Name) >= 3 characters ^(?!\s*$).+ |
regular_expression | string or null (Regular Expression) |
Responses
Request samples
- Payload
{- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "regular_expression": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "regular_expression": "string"
}
Process Entity Type
Process an entity type.
path Parameters
entity_type_id required | integer (Entity Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
enabled | boolean (Enabled) |
global_find | boolean (Global Find) |
id | integer (Id) ( 0 .. 2147483647 ) |
jpath | string or null (Jpath) |
name | string (Name) >= 3 characters ^(?!\s*$).+ |
regular_expression | string or null (Regular Expression) |
Responses
Request samples
- Payload
{- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "regular_expression": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "enabled": true,
- "global_find": true,
- "id": 2147483646,
- "jpath": "string",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "regular_expression": "string"
}
Get Feedback Entries
Get all feedback entries, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "feedback": "string",
- "id": 2147483646,
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "participant": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "rating": "Very satisfied"
}
], - "total": 0
}
Create Feedback
Create a new feedback entry.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
created_at | string <date-time> (Created At) |
feedback | string or null (Feedback) |
object (IncidentReadMinimal) | |
object (ParticipantRead) | |
rating | string (FeedbackRating) Default: "Very satisfied" Enum: "Very satisfied" "Somewhat satisfied" "Neither satisfied nor dissatisfied" "Somewhat dissatisfied" "Very dissatisfied" An enumeration. |
Responses
Request samples
- Payload
{- "created_at": "2019-08-24T14:15:22Z",
- "feedback": "string",
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "participant": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "rating": "Very satisfied"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "feedback": "string",
- "id": 2147483646,
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "participant": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "rating": "Very satisfied"
}
Delete Feedback
Delete a feedback entry, returning only an HTTP 200 OK if successful.
path Parameters
feedback_id required | integer (Feedback Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Feedback
Get a feedback entry by its id.
path Parameters
feedback_id required | integer (Feedback Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "feedback": "string",
- "id": 2147483646,
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "participant": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "rating": "Very satisfied"
}
Update Feedback
Updates a feedback entry by its id.
path Parameters
feedback_id required | integer (Feedback Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
created_at | string <date-time> (Created At) |
feedback | string or null (Feedback) |
id | integer (Id) ( 0 .. 2147483647 ) |
object (IncidentReadMinimal) | |
object (ParticipantRead) | |
rating | string (FeedbackRating) Default: "Very satisfied" Enum: "Very satisfied" "Somewhat satisfied" "Neither satisfied nor dissatisfied" "Somewhat dissatisfied" "Very dissatisfied" An enumeration. |
Responses
Request samples
- Payload
{- "created_at": "2019-08-24T14:15:22Z",
- "feedback": "string",
- "id": 2147483646,
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "participant": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "rating": "Very satisfied"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "feedback": "string",
- "id": 2147483646,
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "participant": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "rating": "Very satisfied"
}
Get Incident Cost Types
Get all incident cost types, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Incident Cost Type
Create an incident cost type.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
category | string or null (Category) |
created_at | string <date-time> (Created At) |
default | boolean (Default) |
description | string or null (Description) |
details | object (Details) Default: {} |
editable | boolean (Editable) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
required | object (ProjectRead) |
Responses
Request samples
- Payload
{- "category": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default": true,
- "description": "string",
- "details": { },
- "editable": true,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "category": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default": true,
- "description": "string",
- "details": { },
- "editable": true,
- "id": 2147483646,
- "name": "string"
}
Delete Incident Cost Type
Delete an incident cost type, returning only an HTTP 200 OK if successful.
path Parameters
incident_cost_type_id required | integer (Incident Cost Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Incident Cost Type
Get an incident cost type by its id.
path Parameters
incident_cost_type_id required | integer (Incident Cost Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "category": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default": true,
- "description": "string",
- "details": { },
- "editable": true,
- "id": 2147483646,
- "name": "string"
}
Update Incident Cost Type
Update an incident cost type by its id.
path Parameters
incident_cost_type_id required | integer (Incident Cost Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
category | string or null (Category) |
created_at | string <date-time> (Created At) |
default | boolean (Default) |
description | string or null (Description) |
details | object (Details) Default: {} |
editable | boolean (Editable) |
id | integer (Id) ( 0 .. 2147483647 ) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
Responses
Request samples
- Payload
{- "category": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default": true,
- "description": "string",
- "details": { },
- "editable": true,
- "id": 2147483646,
- "name": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "category": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default": true,
- "description": "string",
- "details": { },
- "editable": true,
- "id": 2147483646,
- "name": "string"
}
Get Incident Costs
Get all incident costs, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Incident Cost
Create an incident cost.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
amount | number (Amount) Default: 0 |
required | object (IncidentCostTypeRead) |
required | object (ProjectRead) |
Responses
Request samples
- Payload
{- "amount": 0,
- "incident_cost_type": {
- "category": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default": true,
- "description": "string",
- "details": { },
- "editable": true,
- "id": 2147483646,
- "name": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "amount": 0,
- "id": 2147483646,
- "incident_cost_type": {
- "category": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default": true,
- "description": "string",
- "details": { },
- "editable": true,
- "id": 2147483646,
- "name": "string"
}
}
Delete Incident Cost
Delete an incident cost, returning only an HTTP 200 OK if successful.
path Parameters
incident_cost_id required | integer (Incident Cost Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Incident Cost
Get an incident cost by its id.
path Parameters
incident_cost_id required | integer (Incident Cost Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "amount": 0,
- "id": 2147483646,
- "incident_cost_type": {
- "category": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default": true,
- "description": "string",
- "details": { },
- "editable": true,
- "id": 2147483646,
- "name": "string"
}
}
Update Incident Cost
Update an incident cost by its id.
path Parameters
incident_cost_id required | integer (Incident Cost Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
amount | number (Amount) Default: 0 |
id | integer (Id) ( 0 .. 2147483647 ) |
required | object (IncidentCostTypeRead) |
Responses
Request samples
- Payload
{- "amount": 0,
- "id": 2147483646,
- "incident_cost_type": {
- "category": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default": true,
- "description": "string",
- "details": { },
- "editable": true,
- "id": 2147483646,
- "name": "string"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "amount": 0,
- "id": 2147483646,
- "incident_cost_type": {
- "category": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "default": true,
- "description": "string",
- "details": { },
- "editable": true,
- "id": 2147483646,
- "name": "string"
}
}
Get Incident Priorities
Returns all incident priorities.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Get Incident Priorities
Returns all incident priorities.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Incident Priority
Create a new incident priority.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
color | string or null <color> (Color) |
default | boolean (Default) |
description | string or null (Description) |
enabled | boolean (Enabled) |
executive_report_reminder | integer (Executive Report Reminder) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
page_commander | boolean (Page Commander) |
object (ProjectRead) | |
tactical_report_reminder | integer (Tactical Report Reminder) |
view_order | integer (View Order) |
Responses
Request samples
- Payload
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}
Get Incident Priority
Get an incident priority.
path Parameters
incident_priority_id required | integer (Incident Priority Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}
Update Incident Priority
Update an existing incident priority.
path Parameters
incident_priority_id required | integer (Incident Priority Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
color | string or null <color> (Color) |
default | boolean (Default) |
description | string or null (Description) |
enabled | boolean (Enabled) |
executive_report_reminder | integer (Executive Report Reminder) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
page_commander | boolean (Page Commander) |
object (ProjectRead) | |
tactical_report_reminder | integer (Tactical Report Reminder) |
view_order | integer (View Order) |
Responses
Request samples
- Payload
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}
Get Incident Roles
Get all incident role mappings.
path Parameters
role required | string (ParticipantRoleType) Enum: "Assignee" "Incident Commander" "Liaison" "Scribe" "Participant" "Observer" "Reporter" An enumeration. |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
projectName required | string (Projectname) |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "policies": [ ]
}
Update Incident Role
Update a incident role mapping by its id.
path Parameters
role required | string (ParticipantRoleType) Enum: "Assignee" "Incident Commander" "Liaison" "Scribe" "Participant" "Observer" "Reporter" An enumeration. |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
projectName required | string (Projectname) |
Request Body schema: application/json
required | Array of objects (Policies) | ||||||||||||||||||
Array
|
Responses
Request samples
- Payload
{- "policies": [
- {
- "enabled": true,
- "id": 2147483646,
- "incident_priorities": [
- {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}
], - "incident_types": [
- {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "id": 2147483646,
- "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}
], - "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "order": 0,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "service": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "tags": [
- {
- "description": "string",
- "discoverable": true,
- "external_id": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": "string",
- "tag_type": {
- "description": "string",
- "exclusive": false,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "uri": "string"
}
]
}
]
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "policies": [ ]
}
Get Incident Severities
Returns all incident severities.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Get Incident Severities
Returns all incident severities.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Incident Severity
Creates a new incident severity.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
color | string or null <color> (Color) |
default | boolean (Default) |
description | string or null (Description) |
enabled | boolean (Enabled) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
object (ProjectRead) | |
view_order | integer (View Order) |
Responses
Request samples
- Payload
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Get Incident Severity
Gets an incident severity.
path Parameters
incident_severity_id required | integer (Incident Severity Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Update Incident Severity
Updates an existing incident severity.
path Parameters
incident_severity_id required | integer (Incident Severity Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
color | string or null <color> (Color) |
default | boolean (Default) |
description | string or null (Description) |
enabled | boolean (Enabled) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
object (ProjectRead) | |
view_order | integer (View Order) |
Responses
Request samples
- Payload
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}
Get Incident Types
Returns all incident types.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Get Incident Types
Returns all incident types.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Incident Type
Create a new incident type.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
default | boolean (Default) Default: false |
description | string or null (Description) |
enabled | boolean (Enabled) |
exclude_from_metrics | boolean (Exclude From Metrics) Default: false |
object (Document) | |
object (Document) | |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
Array of objects (Plugin Metadata) Default: [] | |
object (ProjectRead) | |
object (Document) | |
object (Document) | |
visibility | string or null (Visibility) |
Responses
Request samples
- Payload
{- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "id": 2147483646,
- "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}
Get Incident Type
Get an incident type.
path Parameters
incident_type_id required | integer (Incident Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "id": 2147483646,
- "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}
Update Incident Type
Update an existing incident type.
path Parameters
incident_type_id required | integer (Incident Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
default | boolean (Default) Default: false |
description | string or null (Description) |
enabled | boolean (Enabled) |
exclude_from_metrics | boolean (Exclude From Metrics) Default: false |
object (Document) | |
id | integer (Id) ( 0 .. 2147483647 ) |
object (Document) | |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
Array of objects (Plugin Metadata) Default: [] | |
object (ProjectRead) | |
object (Document) | |
object (Document) | |
visibility | string or null (Visibility) |
Responses
Request samples
- Payload
{- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "id": 2147483646,
- "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "id": 2147483646,
- "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}
Retrieve a list of incidents.
Retrieves a list of incidents.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
include[] | Array of strings (Include[]) Default: [] |
expand | boolean (Expand) Default: false |
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Creates a new incident.
Creates a new incident.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
object (ParticipantUpdate) | |
description required | string (Description) |
object (IncidentPriorityCreate) | |
object (IncidentSeverityCreate) | |
object (IncidentTypeCreate) | |
object (ProjectRead) | |
object (ParticipantUpdate) | |
resolution | string (Resolution) |
status | string (IncidentStatus) Enum: "Active" "Stable" "Closed" An enumeration. |
Array of objects (Tags) Default: [] | |
title required | string (Title) |
visibility | string (Visibility) Enum: "Open" "Restricted" An enumeration. |
Responses
Request samples
- Payload
{- "commander": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "description": "string",
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}, - "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reporter": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "resolution": "string",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "visibility": "Open"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "cases": [ ],
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "conference": {
- "conference_challenge": "string",
- "conference_id": "string",
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation": {
- "channel_id": "string",
- "description": "string",
- "id": 2147483646,
- "resource_id": "string",
- "resource_type": "string",
- "thread_id": "string",
- "weblink": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "documents": [ ],
- "duplicates": [ ],
- "events": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "id": 2147483646,
- "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}, - "last_executive_report": {
- "created_at": "2019-08-24T14:15:22Z",
- "details": { },
- "id": 0,
- "type": "Tactical Report"
}, - "last_tactical_report": {
- "created_at": "2019-08-24T14:15:22Z",
- "details": { },
- "id": 0,
- "type": "Tactical Report"
}, - "name": "string",
- "participants": [ ],
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "storage": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tags": [ ],
- "tasks": [ ],
- "terms": [ ],
- "ticket": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "title": "string",
- "total_cost": 0,
- "visibility": "Open",
- "workflow_instances": [ ]
}
Gets incident forecast data.
Gets incident forecast data.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Deletes an incident and its external resources.
Deletes an incident and its external resources.
path Parameters
incident_id required | integer (Incident Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Retrieves a single incident.
Retrieves the details of a single incident.
path Parameters
incident_id required | integer (Incident Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "cases": [ ],
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "conference": {
- "conference_challenge": "string",
- "conference_id": "string",
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation": {
- "channel_id": "string",
- "description": "string",
- "id": 2147483646,
- "resource_id": "string",
- "resource_type": "string",
- "thread_id": "string",
- "weblink": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "documents": [ ],
- "duplicates": [ ],
- "events": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "id": 2147483646,
- "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}, - "last_executive_report": {
- "created_at": "2019-08-24T14:15:22Z",
- "details": { },
- "id": 0,
- "type": "Tactical Report"
}, - "last_tactical_report": {
- "created_at": "2019-08-24T14:15:22Z",
- "details": { },
- "id": 0,
- "type": "Tactical Report"
}, - "name": "string",
- "participants": [ ],
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "storage": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tags": [ ],
- "tasks": [ ],
- "terms": [ ],
- "ticket": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "title": "string",
- "total_cost": 0,
- "visibility": "Open",
- "workflow_instances": [ ]
}
Updates an existing incident.
Updates an existing incident.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
incident_id required | integer (Incident Id) ( 0 .. 2147483647 ) |
Request Body schema: application/json
Array of objects (Cases) Default: [] | |
object (ParticipantUpdate) | |
description required | string (Description) |
Array of objects (Duplicates) Default: [] | |
Array of objects (Incident Costs) Default: [] | |
required | object (IncidentPriorityBase) |
required | object (IncidentSeverityBase) |
required | object (IncidentTypeBase) |
reported_at | string <date-time> (Reported At) |
object (ParticipantUpdate) | |
resolution | string (Resolution) |
stable_at | string <date-time> (Stable At) |
status | string (IncidentStatus) Enum: "Active" "Stable" "Closed" An enumeration. |
Array of objects (Tags) Default: [] | |
Array of objects (Terms) Default: [] | |
title required | string (Title) |
visibility | string (Visibility) Enum: "Open" "Restricted" An enumeration. |
Responses
Request samples
- Payload
{- "cases": [ ],
- "commander": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "description": "string",
- "duplicates": [ ],
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "terms": [ ],
- "title": "string",
- "visibility": "Open"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "cases": [ ],
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "conference": {
- "conference_challenge": "string",
- "conference_id": "string",
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation": {
- "channel_id": "string",
- "description": "string",
- "id": 2147483646,
- "resource_id": "string",
- "resource_type": "string",
- "thread_id": "string",
- "weblink": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "documents": [ ],
- "duplicates": [ ],
- "events": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "executive_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "id": 2147483646,
- "incident_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "name": "string",
- "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "review_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tracking_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "visibility": "string"
}, - "last_executive_report": {
- "created_at": "2019-08-24T14:15:22Z",
- "details": { },
- "id": 0,
- "type": "Tactical Report"
}, - "last_tactical_report": {
- "created_at": "2019-08-24T14:15:22Z",
- "details": { },
- "id": 0,
- "type": "Tactical Report"
}, - "name": "string",
- "participants": [ ],
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "storage": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tags": [ ],
- "tasks": [ ],
- "terms": [ ],
- "ticket": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "title": "string",
- "total_cost": 0,
- "visibility": "Open",
- "workflow_instances": [ ]
}
Adds an individual to an incident.
Adds an individual to an incident.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
incident_id required | integer (Incident Id) ( 0 .. 2147483647 ) |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Creates an executive report.
Creates an executive report.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
incident_id required | integer (Incident Id) ( 0 .. 2147483647 ) |
Request Body schema: application/json
current_status required | string (Current Status) |
next_steps required | string (Next Steps) |
overview required | string (Overview) |
Responses
Request samples
- Payload
{- "current_status": "string",
- "next_steps": "string",
- "overview": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Creates a tactical report.
Creates a tactical report.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
incident_id required | integer (Incident Id) ( 0 .. 2147483647 ) |
Request Body schema: application/json
actions required | string (Actions) |
conditions required | string (Conditions) |
needs required | string (Needs) |
Responses
Request samples
- Payload
{- "actions": "string",
- "conditions": "string",
- "needs": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Subscribes an individual to an incident.
Subscribes an individual to an incident.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
incident_id required | integer (Incident Id) ( 0 .. 2147483647 ) |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Individuals
Retrieve individual contacts.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Individual
Creates a new individual contact.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
company | string or null (Company) |
contact_type | string or null (Contact Type) |
email required | string <email> (Email) |
external_id | string or null (External Id) |
Array of objects (Filters) | |
is_active | boolean (Is Active) Default: true |
is_external | boolean (Is External) Default: false |
mobile_phone | string or null (Mobile Phone) |
name | string or null (Name) |
notes | string or null (Notes) |
office_phone | string or null (Office Phone) |
owner | string or null (Owner) |
required | object (ProjectRead) |
title | string or null (Title) |
weblink | string or null (Weblink) |
Responses
Request samples
- Payload
{- "company": "string",
- "contact_type": "string",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [
- {
- "creator": {
- "email": "user@example.com",
- "id": 2147483646,
- "organizations": [ ],
- "projects": [ ],
- "role": "string"
}, - "description": "string",
- "expression": [
- { }
], - "id": 2147483646,
- "name": "string",
- "subject": "incident"
}
], - "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "title": "string",
- "weblink": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Deletes an individual contact.
Deletes an individual contact.
path Parameters
individual_contact_id required | integer (Individual Contact Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Individual
Gets an individual contact.
path Parameters
individual_contact_id required | integer (Individual Contact Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Updates an individual's contact information.
Updates an individual contact.
path Parameters
individual_contact_id required | integer (Individual Contact Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
company | string or null (Company) |
contact_type | string or null (Contact Type) |
email required | string <email> (Email) |
external_id | string or null (External Id) |
Array of objects (Filters) | |
is_active | boolean (Is Active) Default: true |
is_external | boolean (Is External) Default: false |
mobile_phone | string or null (Mobile Phone) |
name | string or null (Name) |
notes | string or null (Notes) |
office_phone | string or null (Office Phone) |
owner | string or null (Owner) |
title | string or null (Title) |
weblink | string or null (Weblink) |
Responses
Request samples
- Payload
{- "company": "string",
- "contact_type": "string",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [
- {
- "creator": {
- "email": "user@example.com",
- "id": 2147483646,
- "organizations": [ ],
- "projects": [ ],
- "role": "string"
}, - "description": "string",
- "expression": [
- { }
], - "id": 2147483646,
- "name": "string",
- "subject": "incident"
}
], - "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "weblink": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Get Notifications
Get all notifications, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Notification
Create a notification.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
enabled | boolean (Enabled) |
evergreen | boolean (Evergreen) Default: false |
evergreen_last_reminder_at | string or null <date-time> (Evergreen Last Reminder At) |
evergreen_owner | string <email> (Evergreen Owner) |
evergreen_reminder_interval | integer (Evergreen Reminder Interval) Default: 90 |
Array of objects (Filters) | |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
required | object (ProjectRead) |
target required | string (Target) |
type required | string (NotificationTypeEnum) Enum: "conversation" "email" An enumeration. |
Responses
Request samples
- Payload
{- "description": "string",
- "enabled": true,
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [
- {
- "creator": {
- "email": "user@example.com",
- "id": 2147483646,
- "organizations": [ ],
- "projects": [ ],
- "role": "string"
}, - "description": "string",
- "expression": [
- { }
], - "id": 2147483646,
- "name": "string",
- "subject": "incident"
}
], - "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "target": "string",
- "type": "conversation"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": true,
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [
- {
- "creator": {
- "email": "user@example.com",
- "id": 2147483646,
- "organizations": [ ],
- "projects": [ ],
- "role": "string"
}, - "description": "string",
- "expression": [
- { }
], - "id": 2147483646,
- "name": "string",
- "subject": "incident"
}
], - "id": 2147483646,
- "name": "string",
- "target": "string",
- "type": "conversation",
- "updated_at": "2019-08-24T14:15:22Z"
}
Delete Notification
Delete a notification, returning only an HTTP 200 OK if successful.
path Parameters
notification_id required | integer (Notification Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Notification
Get a notification by its id.
path Parameters
notification_id required | integer (Notification Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": true,
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [
- {
- "creator": {
- "email": "user@example.com",
- "id": 2147483646,
- "organizations": [ ],
- "projects": [ ],
- "role": "string"
}, - "description": "string",
- "expression": [
- { }
], - "id": 2147483646,
- "name": "string",
- "subject": "incident"
}
], - "id": 2147483646,
- "name": "string",
- "target": "string",
- "type": "conversation",
- "updated_at": "2019-08-24T14:15:22Z"
}
Update Notification
Update a notification by its id.
path Parameters
notification_id required | integer (Notification Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
enabled | boolean (Enabled) |
evergreen | boolean (Evergreen) Default: false |
evergreen_last_reminder_at | string or null <date-time> (Evergreen Last Reminder At) |
evergreen_owner | string <email> (Evergreen Owner) |
evergreen_reminder_interval | integer (Evergreen Reminder Interval) Default: 90 |
Array of objects (Filters) | |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
target required | string (Target) |
type required | string (NotificationTypeEnum) Enum: "conversation" "email" An enumeration. |
Responses
Request samples
- Payload
{- "description": "string",
- "enabled": true,
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [
- {
- "description": "string",
- "expression": [
- { }
], - "id": 2147483646,
- "name": "string",
- "subject": "incident"
}
], - "name": "string",
- "target": "string",
- "type": "conversation"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": true,
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [
- {
- "creator": {
- "email": "user@example.com",
- "id": 2147483646,
- "organizations": [ ],
- "projects": [ ],
- "role": "string"
}, - "description": "string",
- "expression": [
- { }
], - "id": 2147483646,
- "name": "string",
- "subject": "incident"
}
], - "id": 2147483646,
- "name": "string",
- "target": "string",
- "type": "conversation",
- "updated_at": "2019-08-24T14:15:22Z"
}
Get Plugins
Get all plugins.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Get Plugin Instances
Get all plugin instances.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Plugin Instance
Create a new plugin instance.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
configuration | object (Configuration) |
enabled | boolean (Enabled) |
required | object (PluginRead) |
required | object (ProjectRead) |
Responses
Request samples
- Payload
{- "configuration": { },
- "enabled": true,
- "plugin": {
- "author": "string",
- "author_url": "string",
- "configuration_schema": null,
- "description": "string",
- "id": 2147483646,
- "multiple": true,
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "configuration": { },
- "configuration_schema": null,
- "enabled": true,
- "id": 2147483646,
- "plugin": {
- "author": "string",
- "author_url": "string",
- "configuration_schema": null,
- "description": "string",
- "id": 2147483646,
- "multiple": true,
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Delete Plugin Instances
Deletes an existing plugin instance.
path Parameters
plugin_instance_id required | integer (Plugin Instance Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Plugin Instance
Get a plugin instance.
path Parameters
plugin_instance_id required | integer (Plugin Instance Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "configuration": { },
- "configuration_schema": null,
- "enabled": true,
- "id": 2147483646,
- "plugin": {
- "author": "string",
- "author_url": "string",
- "configuration_schema": null,
- "description": "string",
- "id": 2147483646,
- "multiple": true,
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Update Plugin Instance
Update a plugin instance.
path Parameters
plugin_instance_id required | integer (Plugin Instance Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
configuration | object (Configuration) |
enabled | boolean (Enabled) |
id | integer (Id) ( 0 .. 2147483647 ) |
Responses
Request samples
- Payload
{- "configuration": { },
- "enabled": true,
- "id": 2147483646
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "configuration": { },
- "enabled": true,
- "plugin": {
- "author": "string",
- "author_url": "string",
- "configuration_schema": null,
- "description": "string",
- "id": 2147483646,
- "multiple": true,
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Get Projects
Get all projects.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create a new project.
Create a new project.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
annual_employee_cost | integer (Annual Employee Cost) |
business_year_hours | integer (Business Year Hours) |
color | string or null (Color) |
default | boolean (Default) Default: false |
description | string or null (Description) |
id | integer (Id) ( 0 .. 2147483647 ) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
required | object (OrganizationRead) |
owner_conversation | string or null (Owner Conversation) |
owner_email | string or null <email> (Owner Email) |
Responses
Request samples
- Payload
{- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "organization": {
- "banner_color": "string",
- "banner_enabled": false,
- "banner_text": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "slug": "string"
}, - "owner_conversation": "string",
- "owner_email": "user@example.com"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
Get a project.
Get a project.
path Parameters
project_id required | integer (Project Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
Update Project
Update a project.
path Parameters
project_id required | integer (Project Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
annual_employee_cost | integer (Annual Employee Cost) |
business_year_hours | integer (Business Year Hours) |
color | string or null (Color) |
default | boolean (Default) Default: false |
description | string or null (Description) |
id | integer (Id) ( 0 .. 2147483647 ) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
owner_conversation | string or null (Owner Conversation) |
owner_email | string or null <email> (Owner Email) |
Responses
Request samples
- Payload
{- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
Search
Perform a search.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
type[] required | Array of strings (SearchTypes) Items Enum: "Definition" "Document" "Incident" "IncidentPriority" "IncidentType" "IndividualContact" "Plugin" "Query" "SearchFilter" "Case" "Service" "Source" "Tag" "Task" "TeamContact" "Term" |
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Get Filters
Retrieve filters.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "creator": {
- "email": "user@example.com",
- "id": 2147483646,
- "organizations": [ ],
- "projects": [ ],
- "role": "string"
}, - "description": "string",
- "expression": [
- { }
], - "id": 2147483646,
- "name": "string",
- "subject": "incident"
}
], - "total": 0
}
Create Search Filter
Create a new filter.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
expression required | Array of objects (Expression) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
required | object (ProjectRead) |
subject | string (SearchFilterSubject) Default: "incident" Enum: "case" "incident" An enumeration. |
Responses
Request samples
- Payload
{- "description": "string",
- "expression": [
- { }
], - "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "subject": "incident"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "creator": {
- "email": "user@example.com",
- "id": 2147483646,
- "organizations": [ ],
- "projects": [ ],
- "role": "string"
}, - "description": "string",
- "expression": [
- { }
], - "id": 2147483646,
- "name": "string",
- "subject": "incident"
}
Update Search Filter
Update a search filter.
path Parameters
search_filter_id required | integer (Search Filter Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
expression required | Array of objects (Expression) |
id | integer (Id) ( 0 .. 2147483647 ) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
subject | string (SearchFilterSubject) Default: "incident" Enum: "case" "incident" An enumeration. |
Responses
Request samples
- Payload
{- "description": "string",
- "expression": [
- { }
], - "id": 2147483646,
- "name": "string",
- "subject": "incident"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "creator": {
- "email": "user@example.com",
- "id": 2147483646,
- "organizations": [ ],
- "projects": [ ],
- "role": "string"
}, - "description": "string",
- "expression": [
- { }
], - "id": 2147483646,
- "name": "string",
- "subject": "incident"
}
Get Services
Retrieves all services.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Service
Creates a new service.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
evergreen | boolean (Evergreen) Default: false |
evergreen_last_reminder_at | string or null <date-time> (Evergreen Last Reminder At) |
evergreen_owner | string <email> (Evergreen Owner) |
evergreen_reminder_interval | integer (Evergreen Reminder Interval) Default: 90 |
external_id | string or null (External Id) |
Array of objects (Filters) Default: [] | |
is_active | boolean (Is Active) |
name | string or null (Name) |
required | object (ProjectRead) |
type | string or null (Type) |
Responses
Request samples
- Payload
{- "external_id": "234234",
- "is_active": true,
- "name": "myService",
- "type": "pagerduty"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Get Service
Gets a service.
path Parameters
service_id required | integer (Service Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Update Service
Updates an existing service.
path Parameters
service_id required | integer (Service Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
evergreen | boolean (Evergreen) Default: false |
evergreen_last_reminder_at | string or null <date-time> (Evergreen Last Reminder At) |
evergreen_owner | string <email> (Evergreen Owner) |
evergreen_reminder_interval | integer (Evergreen Reminder Interval) Default: 90 |
external_id | string or null (External Id) |
Array of objects (Filters) Default: [] | |
is_active | boolean (Is Active) |
name | string or null (Name) |
type | string or null (Type) |
Responses
Request samples
- Payload
{- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "is_active": true,
- "name": "string",
- "type": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Get Signals
Get all signal definitions.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "conversation_target": "string",
- "create_case": true,
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": false,
- "entity_types": [ ],
- "external_id": "string",
- "external_url": "string",
- "filters": [ ],
- "id": 2147483646,
- "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "owner": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "variant": "string",
- "workflows": [ ]
}
], - "total": 0
}
Create Signal
Create a new signal.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
object (CasePriorityRead) | |
object (CaseTypeRead) | |
conversation_target | string (Conversation Target) |
create_case | boolean (Create Case) Default: true |
created_at | string <date-time> (Created At) |
description | string (Description) |
enabled | boolean (Enabled) Default: false |
Array of objects (Entity Types) Default: [] | |
external_id required | string (External Id) |
external_url | string (External Url) |
Array of objects (Filters) Default: [] | |
name required | string (Name) |
object (Service) | |
owner required | string (Owner) |
required | object (ProjectRead) |
object (SourceBase) | |
Array of objects (Tags) Default: [] | |
variant | string (Variant) |
Array of objects (Workflows) Default: [] |
Responses
Request samples
- Payload
{- "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "conversation_target": "string",
- "create_case": true,
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": false,
- "entity_types": [ ],
- "external_id": "string",
- "external_url": "string",
- "filters": [ ],
- "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "owner": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "variant": "string",
- "workflows": [ ]
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "conversation_target": "string",
- "create_case": true,
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": false,
- "entity_types": [ ],
- "external_id": "string",
- "external_url": "string",
- "filters": [ ],
- "id": 2147483646,
- "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "owner": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "variant": "string",
- "workflows": [ ]
}
Get Signal Filters
Get all signal filters.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "action": "snooze",
- "description": "string",
- "expiration": "2019-08-24T14:15:22Z",
- "expression": [
- { }
], - "id": 2147483646,
- "mode": "active",
- "name": "string",
- "window": 600
}
], - "total": 0
}
Create Filter
Create a new signal filter.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
action | string (SignalFilterAction) Default: "snooze" Enum: "deduplicate" "snooze" An enumeration. |
description | string or null (Description) |
expiration | string or null <date-time> (Expiration) |
expression required | Array of objects (Expression) |
mode | string (SignalFilterMode) Default: "active" Enum: "active" "monitor" "inactive" "expired" An enumeration. |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
required | object (ProjectRead) |
window | integer (Window) Default: 600 |
Responses
Request samples
- Payload
{- "action": "snooze",
- "description": "string",
- "expiration": "2019-08-24T14:15:22Z",
- "expression": [
- { }
], - "mode": "active",
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "window": 600
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "action": "snooze",
- "description": "string",
- "expiration": "2019-08-24T14:15:22Z",
- "expression": [
- { }
], - "id": 2147483646,
- "mode": "active",
- "name": "string",
- "window": 600
}
Update Filter
Updates an existing signal filter.
path Parameters
signal_filter_id required | integer (Signal Filter Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
action | string (SignalFilterAction) Default: "snooze" Enum: "deduplicate" "snooze" An enumeration. |
description | string or null (Description) |
expiration | string or null <date-time> (Expiration) |
expression required | Array of objects (Expression) |
id required | integer (Id) ( 0 .. 2147483647 ) |
mode | string (SignalFilterMode) Default: "active" Enum: "active" "monitor" "inactive" "expired" An enumeration. |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
window | integer (Window) Default: 600 |
Responses
Request samples
- Payload
{- "action": "snooze",
- "description": "string",
- "expiration": "2019-08-24T14:15:22Z",
- "expression": [
- { }
], - "id": 2147483646,
- "mode": "active",
- "name": "string",
- "window": 600
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "conversation_target": "string",
- "create_case": true,
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": false,
- "entity_types": [ ],
- "external_id": "string",
- "external_url": "string",
- "filters": [ ],
- "id": 2147483646,
- "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "owner": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "variant": "string",
- "workflows": [ ]
}
Get Signal Instances
Get all signal instances.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "case": {
- "assignee": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "closed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "documents": [ ],
- "duplicates": [ ],
- "escalated_at": "2019-08-24T14:15:22Z",
- "events": [ ],
- "groups": [ ],
- "id": 2147483646,
- "incidents": [ ],
- "name": "string",
- "participants": [ ],
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "related": [ ],
- "reported_at": "2019-08-24T14:15:22Z",
- "resolution": "string",
- "resolution_reason": "False Positive",
- "signal_instances": [ ],
- "status": "New",
- "storage": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tags": [ ],
- "ticket": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "title": "string",
- "triage_at": "2019-08-24T14:15:22Z",
- "visibility": "Open",
- "workflow_instances": [ ]
}, - "created_at": "2019-08-24T14:15:22Z",
- "entities": [ ],
- "filter_action": "deduplicate",
- "fingerprint": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "raw": { },
- "signal": {
- "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "conversation_target": "string",
- "create_case": true,
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": false,
- "entity_types": [ ],
- "external_id": "string",
- "external_url": "string",
- "filters": [ ],
- "id": 2147483646,
- "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "owner": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "variant": "string",
- "workflows": [ ]
}
}
], - "total": 0
}
Create Signal Instance
Create a new signal instance.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
object (CaseRead) | |
created_at | string <date-time> (Created At) |
Array of objects (Entities) Default: [] | |
filter_action | string (SignalFilterAction) Enum: "deduplicate" "snooze" An enumeration. |
required | object (ProjectRead) |
raw required | object (Raw) |
object (SignalRead) |
Responses
Request samples
- Payload
{- "case": {
- "assignee": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "closed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "documents": [ ],
- "duplicates": [ ],
- "escalated_at": "2019-08-24T14:15:22Z",
- "events": [ ],
- "groups": [ ],
- "id": 2147483646,
- "incidents": [ ],
- "name": "string",
- "participants": [ ],
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "related": [ ],
- "reported_at": "2019-08-24T14:15:22Z",
- "resolution": "string",
- "resolution_reason": "False Positive",
- "signal_instances": [ ],
- "status": "New",
- "storage": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tags": [ ],
- "ticket": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "title": "string",
- "triage_at": "2019-08-24T14:15:22Z",
- "visibility": "Open",
- "workflow_instances": [ ]
}, - "created_at": "2019-08-24T14:15:22Z",
- "entities": [ ],
- "filter_action": "deduplicate",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "raw": { },
- "signal": {
- "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "conversation_target": "string",
- "create_case": true,
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": false,
- "entity_types": [ ],
- "external_id": "string",
- "external_url": "string",
- "filters": [ ],
- "id": 2147483646,
- "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "owner": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "variant": "string",
- "workflows": [ ]
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "case": {
- "assignee": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "closed_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "documents": [ ],
- "duplicates": [ ],
- "escalated_at": "2019-08-24T14:15:22Z",
- "events": [ ],
- "groups": [ ],
- "id": 2147483646,
- "incidents": [ ],
- "name": "string",
- "participants": [ ],
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "related": [ ],
- "reported_at": "2019-08-24T14:15:22Z",
- "resolution": "string",
- "resolution_reason": "False Positive",
- "signal_instances": [ ],
- "status": "New",
- "storage": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "tags": [ ],
- "ticket": {
- "description": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "title": "string",
- "triage_at": "2019-08-24T14:15:22Z",
- "visibility": "Open",
- "workflow_instances": [ ]
}, - "created_at": "2019-08-24T14:15:22Z",
- "entities": [ ],
- "filter_action": "deduplicate",
- "fingerprint": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "raw": { },
- "signal": {
- "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "conversation_target": "string",
- "create_case": true,
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": false,
- "entity_types": [ ],
- "external_id": "string",
- "external_url": "string",
- "filters": [ ],
- "id": 2147483646,
- "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "owner": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "variant": "string",
- "workflows": [ ]
}
}
Get Signal
Get a signal by it's ID.
path Parameters
signal_id required | integer (Signal Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "conversation_target": "string",
- "create_case": true,
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": false,
- "entity_types": [ ],
- "external_id": "string",
- "external_url": "string",
- "filters": [ ],
- "id": 2147483646,
- "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "owner": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "variant": "string",
- "workflows": [ ]
}
Update Signal
Updates an existing signal.
path Parameters
signal_id required | integer (Signal Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
object (CasePriorityRead) | |
object (CaseTypeRead) | |
conversation_target | string (Conversation Target) |
create_case | boolean (Create Case) Default: true |
created_at | string <date-time> (Created At) |
description | string (Description) |
enabled | boolean (Enabled) Default: false |
Array of objects (Entity Types) Default: [] | |
external_id required | string (External Id) |
external_url | string (External Url) |
Array of objects (Filters) Default: [] | |
id required | integer (Id) ( 0 .. 2147483647 ) |
name required | string (Name) |
object (Service) | |
owner required | string (Owner) |
required | object (ProjectRead) |
object (SourceBase) | |
Array of objects (Tags) Default: [] | |
variant | string (Variant) |
Array of objects (Workflows) Default: [] |
Responses
Request samples
- Payload
{- "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "conversation_target": "string",
- "create_case": true,
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": false,
- "entity_types": [ ],
- "external_id": "string",
- "external_url": "string",
- "filters": [ ],
- "id": 2147483646,
- "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "owner": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "variant": "string",
- "workflows": [ ]
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "case_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "page_assignee": true,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "view_order": 0
}, - "case_type": {
- "case_template_document": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "resource_id": "string",
- "resource_type": "string",
- "weblink": "string"
}, - "conversation_target": "string",
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "incident_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "plugin_metadata": [ ],
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "visibility": "string"
}, - "conversation_target": "string",
- "create_case": true,
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": false,
- "entity_types": [ ],
- "external_id": "string",
- "external_url": "string",
- "filters": [ ],
- "id": 2147483646,
- "name": "string",
- "oncall_service": {
- "description": "string",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string"
}, - "owner": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "source": {
- "aggregated": false,
- "alerts": [ ],
- "cost": 0,
- "data_last_loaded_at": "2019-08-24T14:15:22Z",
- "delay": 0,
- "description": "string",
- "documentation": "string",
- "external_id": "string",
- "incidents": [ ],
- "links": [ ],
- "name": "string",
- "owner": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "name": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "queries": [ ],
- "retention": 0,
- "sampling_rate": 2,
- "size": 0,
- "source_data_format": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_environment": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_schema": "string",
- "source_status": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_transport": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "source_type": {
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "tags": [ ]
}, - "tags": [ ],
- "variant": "string",
- "workflows": [ ]
}
Get Tag Types
Get all tag types, or only those matching a given search term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [
- {
- "description": "string",
- "exclusive": false,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
], - "total": 0
}
Create Tag Type
Create a new tag type.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
exclusive | boolean (Exclusive) Default: false |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
required | object (ProjectRead) |
Responses
Request samples
- Payload
{- "description": "string",
- "exclusive": false,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "exclusive": false,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Get Tag Type
Get a tag type by its id.
path Parameters
tag_type_id required | integer (Tag Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "exclusive": false,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Update Tag Type
Update a tag type.
path Parameters
tag_type_id required | integer (Tag Type Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
description | string or null (Description) |
exclusive | boolean (Exclusive) Default: false |
id | integer (Id) ( 0 .. 2147483647 ) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
Responses
Request samples
- Payload
{- "description": "string",
- "exclusive": false,
- "id": 2147483646,
- "name": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "description": "string",
- "exclusive": false,
- "id": 2147483646,
- "name": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Retrieve a list of all tasks.
Retrieve all tasks.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
include[] | Array of strings (Include[]) Default: [] |
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
null
Create Task
Creates a new task.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
Array of objects (Assignees) Default: [] | |
created_at | string <date-time> (Created At) |
object (ParticipantUpdate) | |
description | string or null (Description) |
required | object (IncidentReadMinimal) |
object (ParticipantUpdate) | |
priority | string or null (Priority) |
resolve_by | string <date-time> (Resolve By) |
resolved_at | string <date-time> (Resolved At) |
resource_id | string or null (Resource Id) |
resource_type | string (Resource Type) |
source | string or null (Source) |
status | string (TaskStatus) Default: "Open" Enum: "Open" "Resolved" An enumeration. |
updated_at | string <date-time> (Updated At) |
weblink | string or null (Weblink) |
Responses
Request samples
- Payload
{- "assignees": [ ],
- "created_at": "2019-08-24T14:15:22Z",
- "creator": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "description": "string",
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "owner": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "priority": "string",
- "resolve_by": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "resource_id": "string",
- "resource_type": "string",
- "source": "string",
- "status": "Open",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "assignees": [ ],
- "created_at": "2019-08-24T14:15:22Z",
- "creator": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "description": "string",
- "id": 2147483646,
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "owner": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "priority": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "resolve_by": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "resource_id": "string",
- "resource_type": "string",
- "source": "string",
- "status": "Open",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Create Task
Creates a new task.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
Array of objects (Assignees) Default: [] | |
created_at | string <date-time> (Created At) |
object (ParticipantUpdate) | |
description | string or null (Description) |
required | object (IncidentReadMinimal) |
object (ParticipantUpdate) | |
priority | string or null (Priority) |
resolve_by | string <date-time> (Resolve By) |
resolved_at | string <date-time> (Resolved At) |
resource_id | string or null (Resource Id) |
resource_type | string (Resource Type) |
source | string or null (Source) |
status | string (TaskStatus) Default: "Open" Enum: "Open" "Resolved" An enumeration. |
updated_at | string <date-time> (Updated At) |
weblink | string or null (Weblink) |
Responses
Request samples
- Payload
{- "assignees": [ ],
- "created_at": "2019-08-24T14:15:22Z",
- "creator": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "description": "string",
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "owner": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "priority": "string",
- "resolve_by": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "resource_id": "string",
- "resource_type": "string",
- "source": "string",
- "status": "Open",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "assignees": [ ],
- "created_at": "2019-08-24T14:15:22Z",
- "creator": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "description": "string",
- "id": 2147483646,
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "owner": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "priority": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "resolve_by": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "resource_id": "string",
- "resource_type": "string",
- "source": "string",
- "status": "Open",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Update Task
Updates an existing task.
path Parameters
task_id required | integer (Task Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
Array of objects (Assignees) Default: [] | |
created_at | string <date-time> (Created At) |
object (ParticipantUpdate) | |
description | string or null (Description) |
required | object (IncidentReadMinimal) |
object (ParticipantUpdate) | |
priority | string or null (Priority) |
resolve_by | string <date-time> (Resolve By) |
resolved_at | string <date-time> (Resolved At) |
resource_id | string or null (Resource Id) |
resource_type | string or null (Resource Type) |
source | string or null (Source) |
status | string (TaskStatus) Default: "Open" Enum: "Open" "Resolved" An enumeration. |
updated_at | string <date-time> (Updated At) |
weblink | string or null (Weblink) |
Responses
Request samples
- Payload
{- "assignees": [ ],
- "created_at": "2019-08-24T14:15:22Z",
- "creator": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "description": "string",
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "owner": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "priority": "string",
- "resolve_by": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "resource_id": "string",
- "resource_type": "string",
- "source": "string",
- "status": "Open",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "assignees": [ ],
- "created_at": "2019-08-24T14:15:22Z",
- "creator": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "description": "string",
- "id": 2147483646,
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "owner": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "priority": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "resolve_by": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "resource_id": "string",
- "resource_type": "string",
- "source": "string",
- "status": "Open",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Update Task
Updates an existing task.
path Parameters
task_id required | integer (Task Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
Array of objects (Assignees) Default: [] | |
created_at | string <date-time> (Created At) |
object (ParticipantUpdate) | |
description | string or null (Description) |
required | object (IncidentReadMinimal) |
object (ParticipantUpdate) | |
priority | string or null (Priority) |
resolve_by | string <date-time> (Resolve By) |
resolved_at | string <date-time> (Resolved At) |
resource_id | string or null (Resource Id) |
resource_type | string or null (Resource Type) |
source | string or null (Source) |
status | string (TaskStatus) Default: "Open" Enum: "Open" "Resolved" An enumeration. |
updated_at | string <date-time> (Updated At) |
weblink | string or null (Weblink) |
Responses
Request samples
- Payload
{- "assignees": [ ],
- "created_at": "2019-08-24T14:15:22Z",
- "creator": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "description": "string",
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "owner": {
- "added_reason": "string",
- "department": "string",
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "team": "string"
}, - "priority": "string",
- "resolve_by": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "resource_id": "string",
- "resource_type": "string",
- "source": "string",
- "status": "Open",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "assignees": [ ],
- "created_at": "2019-08-24T14:15:22Z",
- "creator": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "description": "string",
- "id": 2147483646,
- "incident": {
- "closed_at": "2019-08-24T14:15:22Z",
- "commander": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "commanders_location": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "duplicates": [ ],
- "id": 2147483646,
- "incident_costs": [ ],
- "incident_priority": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "executive_report_reminder": 0,
- "id": 2147483646,
- "name": "string",
- "page_commander": true,
- "tactical_report_reminder": 0,
- "view_order": 0
}, - "incident_severity": {
- "color": "string",
- "default": true,
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string"
}, - "incident_type": {
- "default": false,
- "description": "string",
- "enabled": true,
- "exclude_from_metrics": false,
- "id": 2147483646,
- "name": "string",
- "visibility": "string"
}, - "name": "string",
- "participants_location": "string",
- "participants_team": "string",
- "project": {
- "color": "string",
- "id": 2147483646,
- "name": "string"
}, - "reported_at": "2019-08-24T14:15:22Z",
- "reporter": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "reporters_location": "string",
- "resolution": "string",
- "stable_at": "2019-08-24T14:15:22Z",
- "status": "Active",
- "tags": [ ],
- "title": "string",
- "total_cost": 0,
- "visibility": "Open"
}, - "owner": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "priority": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "resolve_by": "2019-08-24T14:15:22Z",
- "resolved_at": "2019-08-24T14:15:22Z",
- "resource_id": "string",
- "resource_type": "string",
- "source": "string",
- "status": "Open",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Get Teams
Get all team contacts.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Team
Create a new team contact.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
company | string or null (Company) |
contact_type | string or null (Contact Type) |
email required | string <email> (Email) |
evergreen | boolean (Evergreen) Default: false |
evergreen_last_reminder_at | string or null <date-time> (Evergreen Last Reminder At) |
evergreen_owner | string <email> (Evergreen Owner) |
evergreen_reminder_interval | integer (Evergreen Reminder Interval) Default: 90 |
Array of objects (Filters) Default: [] | |
is_active | boolean (Is Active) Default: true |
is_external | boolean (Is External) Default: false |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
notes | string or null (Notes) |
owner | string or null (Owner) |
required | object (ProjectRead) |
Responses
Request samples
- Payload
{- "company": "string",
- "contact_type": "string",
- "email": "user@example.com",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [ ],
- "is_active": true,
- "is_external": false,
- "name": "string",
- "notes": "string",
- "owner": "string",
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "name": "string",
- "notes": "string",
- "owner": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Get Team
Get a team contact.
path Parameters
team_contact_id required | integer (Team Contact Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "name": "string",
- "notes": "string",
- "owner": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Update Team
Update a team contact.
path Parameters
team_contact_id required | integer (Team Contact Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
company | string or null (Company) |
contact_type | string or null (Contact Type) |
email required | string <email> (Email) |
evergreen | boolean (Evergreen) Default: false |
evergreen_last_reminder_at | string or null <date-time> (Evergreen Last Reminder At) |
evergreen_owner | string <email> (Evergreen Owner) |
evergreen_reminder_interval | integer (Evergreen Reminder Interval) Default: 90 |
Array of objects (Filters) Default: [] | |
is_active | boolean (Is Active) Default: true |
is_external | boolean (Is External) Default: false |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
notes | string or null (Notes) |
owner | string or null (Owner) |
Responses
Request samples
- Payload
{- "company": "string",
- "contact_type": "string",
- "email": "user@example.com",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [ ],
- "is_active": true,
- "is_external": false,
- "name": "string",
- "notes": "string",
- "owner": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "evergreen": false,
- "evergreen_last_reminder_at": "2019-08-24T14:15:22Z",
- "evergreen_owner": "user@example.com",
- "evergreen_reminder_interval": 90,
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "name": "string",
- "notes": "string",
- "owner": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Get Terms
Retrieve all terms.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Term
Create a new term.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
Array of objects (Definitions) Default: [] | |
discoverable | boolean (Discoverable) Default: true |
id | integer (Id) ( 0 .. 2147483647 ) |
required | object (ProjectRead) |
text | string or null (Text) |
Responses
Request samples
- Payload
{- "definitions": [ ],
- "discoverable": true,
- "id": 2147483646,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "text": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "definitions": [ ],
- "discoverable": true,
- "id": 2147483646,
- "text": "string"
}
Get Term
Get a term.
path Parameters
term_id required | integer (Term Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "definitions": [ ],
- "discoverable": true,
- "id": 2147483646,
- "text": "string"
}
Update Term
Update a term.
path Parameters
term_id required | integer (Term Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
Array of objects (Definitions) Default: [] | |
discoverable | boolean (Discoverable) Default: true |
id | integer (Id) ( 0 .. 2147483647 ) |
text | string or null (Text) |
Responses
Request samples
- Payload
{- "definitions": [ ],
- "discoverable": true,
- "id": 2147483646,
- "text": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "definitions": [ ],
- "discoverable": true,
- "id": 2147483646,
- "text": "string"
}
Get Users
Get all users.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Get User
Get a user.
path Parameters
user_id required | integer (User Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "email": "user@example.com",
- "id": 2147483646,
- "organizations": [ ],
- "projects": [ ],
- "role": "string"
}
Update User
Update a user.
path Parameters
user_id required | integer (User Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
id required | integer (Id) ( 0 .. 2147483647 ) |
Array of objects (Organizations) | |
password | string or null (Password) |
Array of objects (Projects) | |
role | string or null (Role) |
Responses
Request samples
- Payload
{- "id": 2147483646,
- "organizations": [
- {
- "default": false,
- "organization": {
- "banner_color": "string",
- "banner_enabled": false,
- "banner_text": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "slug": "string"
}, - "role": "string"
}
], - "password": "string",
- "projects": [
- {
- "default": false,
- "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "role": "string"
}
], - "role": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "email": "user@example.com",
- "id": 2147483646,
- "organizations": [ ],
- "projects": [ ],
- "role": "string"
}
Get Workflows
Get all workflows.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
query Parameters
page | integer (Page) ( 0 .. 2147483647 ) Default: 1 |
itemsPerPage | integer (Itemsperpage) ( -2 .. 2147483647 ) Default: 5 |
q | string (Q) non-empty ^[ -~]+$ |
filter | string <json-string> (Filter) Default: [] |
sortBy[] | Array of strings (Sortby[]) Default: [] |
descending[] | Array of booleans (Descending[]) Default: [] |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "items": [ ],
- "total": 0
}
Create Workflow
Create a new workflow.
path Parameters
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
created_at | string <date-time> (Created At) |
description | string or null (Description) |
enabled | boolean (Enabled) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
parameters | Array of objects (Parameters) Default: [] |
required | object (PluginInstanceRead) |
required | object (ProjectRead) |
resource_id required | string (Resource Id) |
updated_at | string <date-time> (Updated At) |
Responses
Request samples
- Payload
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": true,
- "name": "string",
- "parameters": [ ],
- "plugin_instance": {
- "configuration": { },
- "configuration_schema": null,
- "enabled": true,
- "id": 2147483646,
- "plugin": {
- "author": "string",
- "author_url": "string",
- "configuration_schema": null,
- "description": "string",
- "id": 2147483646,
- "multiple": true,
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}, - "resource_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "parameters": [ ],
- "plugin_instance": {
- "configuration": { },
- "configuration_schema": null,
- "enabled": true,
- "id": 2147483646,
- "plugin": {
- "author": "string",
- "author_url": "string",
- "configuration_schema": null,
- "description": "string",
- "id": 2147483646,
- "multiple": true,
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "resource_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Get Workflow Instance
Get a workflow instance.
path Parameters
workflow_instance_id required | integer (Workflow Instance Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "artifacts": [ ],
- "case": {
- "id": 2147483646,
- "name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "creator": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "id": 2147483646,
- "incident": {
- "id": 2147483646,
- "name": "string"
}, - "parameters": [ ],
- "resource_id": "string",
- "resource_type": "string",
- "run_reason": "string",
- "signal": {
- "id": 2147483646,
- "name": "string"
}, - "status": "Submitted",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string",
- "workflow": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "parameters": [ ],
- "plugin_instance": {
- "configuration": { },
- "configuration_schema": null,
- "enabled": true,
- "id": 2147483646,
- "plugin": {
- "author": "string",
- "author_url": "string",
- "configuration_schema": null,
- "description": "string",
- "id": 2147483646,
- "multiple": true,
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "resource_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Get Workflow
Get a workflow.
path Parameters
workflow_id required | integer (Workflow Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "parameters": [ ],
- "plugin_instance": {
- "configuration": { },
- "configuration_schema": null,
- "enabled": true,
- "id": 2147483646,
- "plugin": {
- "author": "string",
- "author_url": "string",
- "configuration_schema": null,
- "description": "string",
- "id": 2147483646,
- "multiple": true,
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "resource_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Update Workflow
Update a workflow.
path Parameters
workflow_id required | integer (Workflow Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
created_at | string <date-time> (Created At) |
description | string or null (Description) |
enabled | boolean (Enabled) |
id | integer (Id) ( 0 .. 2147483647 ) |
name required | string (Name) >= 3 characters ^(?!\s*$).+ |
parameters | Array of objects (Parameters) Default: [] |
required | object (PluginInstanceRead) |
resource_id required | string (Resource Id) |
updated_at | string <date-time> (Updated At) |
Responses
Request samples
- Payload
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "parameters": [ ],
- "plugin_instance": {
- "configuration": { },
- "configuration_schema": null,
- "enabled": true,
- "id": 2147483646,
- "plugin": {
- "author": "string",
- "author_url": "string",
- "configuration_schema": null,
- "description": "string",
- "id": 2147483646,
- "multiple": true,
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "resource_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "parameters": [ ],
- "plugin_instance": {
- "configuration": { },
- "configuration_schema": null,
- "enabled": true,
- "id": 2147483646,
- "plugin": {
- "author": "string",
- "author_url": "string",
- "configuration_schema": null,
- "description": "string",
- "id": 2147483646,
- "multiple": true,
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "resource_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
Run Workflow
Runs a workflow with a given set of parameters.
path Parameters
workflow_id required | integer (Workflow Id) ( 0 .. 2147483647 ) |
organization required | string (Organization) >= 3 characters ^[\w]+(?:_[\w]+)*$ |
Request Body schema: application/json
Array of objects (Artifacts) Default: [] | |
object (WorkflowCase) | |
created_at | string <date-time> (Created At) |
object (ParticipantRead) | |
object (WorkflowIncident) | |
parameters | Array of objects (Parameters) Default: [] |
resource_id | string or null (Resource Id) |
resource_type | string or null (Resource Type) |
run_reason | string or null (Run Reason) |
object (WorkflowSignal) | |
status | string (WorkflowInstanceStatus) Enum: "Submitted" "Created" "Running" "Completed" "Failed" An enumeration. |
updated_at | string <date-time> (Updated At) |
weblink | string or null (Weblink) |
Responses
Request samples
- Payload
{- "artifacts": [ ],
- "case": {
- "id": 2147483646,
- "name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "creator": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "incident": {
- "id": 2147483646,
- "name": "string"
}, - "parameters": [ ],
- "resource_id": "string",
- "resource_type": "string",
- "run_reason": "string",
- "signal": {
- "id": 2147483646,
- "name": "string"
}, - "status": "Submitted",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{- "artifacts": [ ],
- "case": {
- "id": 2147483646,
- "name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "creator": {
- "added_reason": "string",
- "department": "string",
- "id": 2147483646,
- "individual": {
- "company": "string",
- "contact_type": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "user@example.com",
- "external_id": "string",
- "filters": [ ],
- "id": 2147483646,
- "is_active": true,
- "is_external": false,
- "mobile_phone": "string",
- "name": "string",
- "notes": "string",
- "office_phone": "string",
- "owner": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string"
}, - "location": "string",
- "participant_roles": [ ],
- "team": "string"
}, - "id": 2147483646,
- "incident": {
- "id": 2147483646,
- "name": "string"
}, - "parameters": [ ],
- "resource_id": "string",
- "resource_type": "string",
- "run_reason": "string",
- "signal": {
- "id": 2147483646,
- "name": "string"
}, - "status": "Submitted",
- "updated_at": "2019-08-24T14:15:22Z",
- "weblink": "string",
- "workflow": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "enabled": true,
- "id": 2147483646,
- "name": "string",
- "parameters": [ ],
- "plugin_instance": {
- "configuration": { },
- "configuration_schema": null,
- "enabled": true,
- "id": 2147483646,
- "plugin": {
- "author": "string",
- "author_url": "string",
- "configuration_schema": null,
- "description": "string",
- "id": 2147483646,
- "multiple": true,
- "slug": "string",
- "title": "string",
- "type": "string"
}, - "project": {
- "annual_employee_cost": 0,
- "business_year_hours": 0,
- "color": "string",
- "default": false,
- "description": "string",
- "id": 2147483646,
- "name": "string",
- "owner_conversation": "string",
- "owner_email": "user@example.com"
}
}, - "resource_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}