Defines the schema for the configuration of incident tags.
API Endpoint | https://api.bigpanda.io/resources/v2.0/incidents/tags/definitions/ |
---|---|
Supported Methods | POST , GET , PUT |
Parameters
The Incident Tags Definitions
object schema includes the following attributes:
Attribute | Description | Type | Example |
---|---|---|---|
id | System-generated unique identifier for the incident tag definition. Determined by the tag name. | UUID | "id": "affected_services" |
name | Incident tag definition's name. Unique. 1-20 chars (Required) | String | "name": "Note" |
description | Incident tag definition's description. 0-200 chars (Optional) | String | "description": "this is a description" |
type | Incident tag definition's type. Can be one of: Text, MultiValue, Priority. (Required) | String | "type": "Text" |
active | Determines if the tag is active or not. Inactive tags can't be set on an incident (Optional) | Boolean | "active": "true" |
config | Additional configs for the Priority type. (Required for Priority) | Object | |
config.ordered_list | Defines the Priority levels and their order. Limited to 10 levels. | Array | |
config.ordered_list[x].display_name | Defines the name of the level, 1-20 chars, unique. | String | |
config.ordered_list[x].description | Defines the description of the level, 0-200 chars. (Optional) | String | |
config.ordered_list[x].order_id | Defines the order of the levels, used for sorting. | Number | |
config.ordered_list[x].active | Defines if a level is active or not. Deactivated levels cannot be set on incidents. | Boolean | |
created_at | The date and time that the incident tag definition was created (Milliseconds, in Unix Epoch format). | Timestamp | "created_at" : 1493922189 |
created_by | The ID of the user who created the incident tag definition. | String | "created_by" : "Administrator 1" |
updated_at | The date and time that the incident tag definition was last updated (Milliseconds, in Unix Epoch format). | Timestamp | "updated_at" : 1372854204 |
updated_by | The ID of the user who last updated the incident tag definition. | String | "updated_by" : "Administrator 2" |
{
"id": "itd_priority_1",
"name": "Priority",
"description": "Priority for prioritizing incidents",
"type": "Priority",
"active": true,
"config": {
"ordered_list": [
{
"display_name": "P1",
"description": "Critical",
"order_id": 1000,
"active": true
},
{
"display_name": "P2",
"description": "Warning",
"order_id": 900,
"active": true
},
{
"display_name": "P3",
"description": "Info",
"order_id": 800,
"active": true
},
{
"display_name": "P4",
"description": "Info",
"order_id": 700,
"active": true
},
{
"display_name": "P5",
"description": "Info",
"order_id": 600,
"active": true
}
]
},
"created_at": 1588697026233,
"created_by": "5eafbc7e16bd4413008db1f8",
"updated_at": 1588697026233,
"updated_by": "5eafbc7e16bd4413008db1f8"
}