Incident Tag Definitions

Authentication

All BigPanda APIs require Bearer Token Authorization in the call headers.

This API uses the User API Key type of Authorization token.

BigPanda recommends adding Authentication headers only in the secure tool you use to make API calls.

Available routes

Example 1. Create an incident tag definition

curl --request POST \
     --url https://api.bigpanda.io/resources/v2.0/incidents/tags/definitions \
     --header 'Authorization: Bearer <User API Key>' \
     --header 'Content-type: application/json' \
     --data '{
    "name": "Affected Services",
    "description": "Services affected by the incident",
    "type": "MultiValue",
    "active": true,
    "canManualInput": true,
    "enrichment_config": {
      "items": [
        {
        "value": "{alert_tags.url}",
        "condition": "event_type = \"known issue\"",
        "id": 13671
        }
      ]
    }
  }'

curl --request POST \
     --url https://api.bigpanda.io/resources/v2.0/incidents/tags/definitions \
     --header 'Authorization: Bearer <User API Key>' \
     --header 'Content-type: application/json' \
     --data '{
    "name": "Affected Services",
    "description": "Services affected by the incident",
    "type": "MultiValue",
    "active": true,
    "canManualInput": true,
    "enrichment_config": {
      "items": [
        {
        "value": "{alert_tags.url}",
        "condition": "event_type = \"known issue\"",
        "id": 13671
        }
      ]
    }
  }'

Example 2. Retrieve an incident tag definition

curl --request GET \
     --url https://api.bigpanda.io/resources/v2.0/incidents/tags/definitions/<ID> \
     --header 'Authorization: Bearer <User API Key>' \
     --header 'Content-type: application/json'

curl --request GET \
     --url https://eu-api.bigpanda.io/resources/v2.0/incidents/tags/definitions/<ID> \
     --header 'Authorization: Bearer <User API Key>' \
     --header 'Content-type: application/json'

Example 3. Retrieve all incident tag definitions

curl --request GET \
     --url https://api.bigpanda.io/resources/v2.0/incidents/tags/definitions \
     --header 'Authorization: Bearer <User API Key>' \
     --header 'Content-type: application/json'

curl --request GET \
     --url https://eu-api.bigpanda.io/resources/v2.0/incidents/tags/definitions \
     --header 'Authorization: Bearer <User API Key>' \
     --header 'Content-type: application/json'

Example 4. Update an incident tag definition

curl --request PUT \
     --url https://api.bigpanda.io/resources/v2.0/incidents/tags/definitions/<ID> \
     --header 'Authorization: Bearer <User API Key>' \
     --header 'Content-type: application/json' \
     --data '{
    "name": "Priority",
    "description": "Priority for prioritizing incidents",
    "type": "Priority",
    "active": true,
    "canManualInput": 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
        }
      ]
    },
    "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"
        }
      ]
    }
  }'

curl --request PUT \
     --url https://eu-api.bigpanda.io/resources/v2.0/incidents/tags/definitions/<ID> \
     --header 'Authorization: Bearer <User API Key>' \
     --header 'Content-type: application/json' \
     --data '{
    "name": "Priority",
    "description": "Priority for prioritizing incidents",
    "type": "Priority",
    "active": true,
    "canManualInput": 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
        }
      ]
    },
    "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"
        }
      ]
    }
  }'

Example 5. Sample incident tag definition return object

{
  "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"
          }
      ]
  }
}

Incident Tag Definitions Parameters

The Incident Tags Definitions object schema includes the following attributes:

Attribute	Description	Type
id	System-generated unique identifier for the incident tag definition. Determined by the tag name.	String
name	Incident tag definition's name. Unique. 1-20 chars (Required)	String
description	Incident tag definition's description. 0-200 chars (Optional)	String
type	Incident tag definition's type. Can be one of: Text, MultiValue, Priority, ClosedListValuesMulti, ClosedListValuesSingle. (Required)	String
active	Determines if the tag is active or not. Inactive tags can't be set on an incident (Optional)	Boolean
deleted	System flag for tag definitions that have been removed from the system	Boolean
canManualInput	Determines if end users can manually enter or edit the value for the incident tag	Boolean
config	Configuration object for the Priority and List type tags. (Required for Priority and Closed Lists) Attributes ordered_list - array of objects that define display and calculation settings for individual priority levels Incident_tag_values - array of strings that define the value options for a closed-list tag	Object
created_at	The date and time that the incident tag definition was created (Milliseconds, in Unix Epoch format).	Timestamp
created_by	The ID of the user who created the incident tag definition.	String
updated_at	The date and time that the incident tag definition was last updated (Milliseconds, in Unix Epoch format).	Timestamp
updated_by	The ID of the user who last updated the incident tag definition.	String
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 append_matching_items - Whether the automatic enrichment will include the value of all matched conditions. When set to false, only the first matched value is applied. Required for closed-list multi-type tags. (Boolean) Default is false	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
display_name	Defines the name of the level, 1-20 chars, unique.	String
description	Defines the description of the level, 0-200 chars. (Optional)	String
color	Defines the color of the priority level in the UI.	String
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
active	Whether the priority level should be available for incoming incidents	Boolean

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
value	The formula, regex, or text that should be added to incidents that match the condition	String
condition	BPQL filter to define which incidents should receive the value	String
id	System generated field to identify the rule within BigPanda	String

Sample Incident Tag Definition Object

{
  "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"
          }
      ]
  }
}

In this section: