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. | String | "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" |
deleted | System flag for tag definitions that have been removed from the system | Boolean | "deleted": false |
canManualInput | Determines if end users are able to manually enter or edit the value for the incident tag | Boolean | "canManualInput": true |
config | Configuration object for the Priority type. (Required for Priority) Attributes ordered_list - array of objects that define display and calculation settings for individual priority levels | Object | |
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" |
enrichment_config | Configuration object to add automatic enrichment to the incident tag. Attributes items - array of objects that define automatic enrichment rules for the incident tag | Object |
Ordered List Object
Each of the objects in the ordered_list array will map to an individual priority level. A priority tag can only have up to 10 levels.
Attribute | Description | Type | Example |
---|---|---|---|
display_name | Defines the name of the level, 1-20 chars, unique. | String | "display_name": "P0" |
description | Defines the description of the level, 0-200 chars. (Optional) | String | "description": "Priority 0" |
color | Defines the color of the priority level in the UI. | String | "color": "red" |
order | Defines the order of the levels, used for sorting. We recommend higher numbers for more urgent priority levels to allow for additive automatic calculations | String | "order_id": 1000 |
active | Whether the priority level should be available for incoming incidents | Boolean | "active": true |
Items Object
Each of the objects in the items array is an automatic enrichment rule. Rules will run in order as defined, stopping after the first matched condition.
Attribute | Description | Type | Example |
---|---|---|---|
value | The formula, regex, or text that should be added to incidents that match the condition | String | "value": "{alert_tags.url}" |
condition | BPQL filter to define which incidents should receive the value | String | "condition": "event_type = "known issue" |
id | System generated field to identify the rule within BigPanda | String | "id": 13671 |
{
"id": "itd_priority_1",
"name": "Priority",
"description": "Priority for prioritizing incidents",
"type": "Priority",
"active": true,
"deleted": false,
"canManualInput": true,
"config": {
"ordered_list": [
{
"display_name": "P1",
"description": "Critical",
"color": "red",
"order_id": 1000,
"active": true
},
{
"display_name": "P2",
"description": "Warning",
"color": "orange",
"order_id": 900,
"active": true
},
{
"display_name": "P3",
"description": "Info",
"color": "yellow",
"order_id": 800,
"active": true
},
{
"display_name": "P4",
"description": "Info",
"color": "light blue",
"order_id": 700,
"active": true
},
{
"display_name": "P5",
"description": "Info",
"color": "soft grey",
"order_id": 600,
"active": true
}
]
},
"created_at": 1588697026233,
"created_by": "5eafbc7e16bd4413008db1f8",
"updated_at": 1588697026233,
"updated_by": "5eafbc7e16bd4413008db1f8"
"enrichment_config": {
"items": [
{
"value": "1000",
"condition": "priority = \"p0\"",
"id": "d9e7a648-48b2-4d28-a42d-398a7b0da237"
},
{
"value": "900",
"condition": "priority = \"p1\"",
"id": "08019f7f-11fd-4dac-9931-d35659a9ed29"
},
{
"value": "800",
"condition": "priority = \"p2\"",
"id": "1d3889ce-6529-40e6-8d03-2159054ebc33"
},
{
"value": "700",
"condition": "priority not in [\"p0\",\"p1\",\"p2\"] and actionable = true",
"id": "aa0a67a4-b1a5-4846-80bc-15cd2d956243"
},
{
"value": "600",
"condition": "priority not in [\"p0\",\"p1\",\"p2\"] and actionable = false",
"id": "8f719f46-08da-4e4d-8385-5a3023f8edc6"
}
]
}
}