Case Management Attribute

View and configure custom attributes within Case Management. See the Case Management page for more information.

Get all custom attributes

v2 (latest)

GET https://api.ap1.datadoghq.com/api/v2/cases/types/custom_attributeshttps://api.ap2.datadoghq.com/api/v2/cases/types/custom_attributeshttps://api.datadoghq.eu/api/v2/cases/types/custom_attributeshttps://api.ddog-gov.com/api/v2/cases/types/custom_attributeshttps://api.datadoghq.com/api/v2/cases/types/custom_attributeshttps://api.us3.datadoghq.com/api/v2/cases/types/custom_attributeshttps://api.us5.datadoghq.com/api/v2/cases/types/custom_attributes

Overview

Get all custom attributes

Response

Custom attribute configs response.

Expand All

Field

Type

Description

data

[object]

List of custom attribute configs of case type

{
  "data": [
    {
      "attributes": {
        "case_type_id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
        "description": "AWS Region, must be a valid region supported by AWS",
        "display_name": "AWS Region",
        "is_multi": true,
        "key": "aws_region",
        "type": "NUMBER"
      },
      "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
      "type": "custom_attribute"
    }
  ]
}

Unauthorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/types/custom_attributes" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                

Get all custom attributes config of case type

v2 (latest)

GET https://api.ap1.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributeshttps://api.ap2.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributeshttps://api.datadoghq.eu/api/v2/cases/types/{case_type_id}/custom_attributeshttps://api.ddog-gov.com/api/v2/cases/types/{case_type_id}/custom_attributeshttps://api.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributeshttps://api.us3.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributeshttps://api.us5.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributes

Overview

Get all custom attribute config of case type

Arguments

Path Parameters

Name

Type

Description

case_type_id [required]

string

Case type’s UUID

Response

Custom attribute configs response.

Expand All

Field

Type

Description

data

[object]

List of custom attribute configs of case type

{
  "data": [
    {
      "attributes": {
        "case_type_id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
        "description": "AWS Region, must be a valid region supported by AWS",
        "display_name": "AWS Region",
        "is_multi": true,
        "key": "aws_region",
        "type": "NUMBER"
      },
      "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
      "type": "custom_attribute"
    }
  ]
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Unauthorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export case_type_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de505"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/types/${case_type_id}/custom_attributes" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                

Create custom attribute config for a case type

v2 (latest)

POST https://api.ap1.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributeshttps://api.ap2.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributeshttps://api.datadoghq.eu/api/v2/cases/types/{case_type_id}/custom_attributeshttps://api.ddog-gov.com/api/v2/cases/types/{case_type_id}/custom_attributeshttps://api.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributeshttps://api.us3.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributeshttps://api.us5.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributes

Overview

Create custom attribute config for a case type

Arguments

Path Parameters

Name

Type

Description

case_type_id [required]

string

Case type’s UUID

Request

Body Data (required)

Custom attribute config payload

Expand All

Field

Type

Description

data [required]

object

Custom attribute config

{
  "data": {
    "attributes": {
      "display_name": "AWS Region 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "is_multi": true,
      "key": "region_d9fe56bc9274fbb6",
      "type": "NUMBER"
    },
    "type": "custom_attribute"
  }
}

Response

CREATED

Custom attribute config response.

Expand All

Field

Type

Description

data

object

The definition of CustomAttributeConfig object.

{
  "data": {
    "attributes": {
      "case_type_id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
      "description": "AWS Region, must be a valid region supported by AWS",
      "display_name": "AWS Region",
      "is_multi": true,
      "key": "aws_region",
      "type": "NUMBER"
    },
    "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
    "type": "custom_attribute"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Unauthorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                          # Path parameters
export case_type_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de505"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/types/${case_type_id}/custom_attributes" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "display_name": "AWS Region 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "is_multi": true,
      "key": "region_d9fe56bc9274fbb6",
      "type": "NUMBER"
    },
    "type": "custom_attribute"
  }
}
EOF

                        

Delete custom attributes config

v2 (latest)

DELETE https://api.ap1.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.ap2.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.datadoghq.eu/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.ddog-gov.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.us3.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.us5.datadoghq.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}

Overview

Delete custom attribute config

Arguments

Path Parameters

Name

Type

Description

case_type_id [required]

string

Case type’s UUID

custom_attribute_id [required]

string

Case Custom attribute’s UUID

Response

No Content

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Unauthorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export case_type_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de505"
export custom_attribute_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de505"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/types/${case_type_id}/custom_attributes/${custom_attribute_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                

Case Management Attribute

Get all custom attributes

Overview

Response

Code Example

Get all custom attributes

Get all custom attributes config of case type

Overview

Arguments

Path Parameters

Response

Code Example

Get all custom attributes config of case type

Create custom attribute config for a case type

Overview

Arguments

Path Parameters

Request

Body Data (required)

Response

Code Example

Create custom attribute config for a case type returns "CREATED" response

Delete custom attributes config

Overview

Arguments

Path Parameters

Response

Code Example

Delete custom attributes config