Update custom attribute config

v2 (latest)

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

PUT 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.us2.ddog-gov.com/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}https://api.uk1.datadoghq.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}

Información general

Updates the display name, description, type, or options of an existing custom attribute configuration for a case type.

OAuth apps require the cases_shared_settings_write authorization scope to access this endpoint.

Argumentos

Parámetros de ruta

Nombre

Tipo

Descripción

case_type_id [required]

string

The UUID of the case type.

custom_attribute_id [required]

string

Case Custom attribute’s UUID

Solicitud

Body Data (required)

Custom attribute config payload.

Expand All

Campo

Tipo

Descripción

data [required]

object

Data object for updating a custom attribute configuration.

{
  "data": {
    "attributes": {
      "description": "Updated description.",
      "display_name": "AWS Region",
      "map_from": "string",
      "type": "NUMBER",
      "type_data": {
        "options": [
          {
            "value": "us-east-1"
          }
        ]
      }
    },
    "type": "custom_attribute"
  }
}

Respuesta

Response containing a single custom attribute configuration.

Expand All

Campo

Tipo

Descripción

data

object

A custom attribute configuration that defines an organization-specific metadata field on cases. Custom attributes are scoped to a case type and can hold text, URLs, numbers, or predefined select options.

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

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Unauthorized

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Forbidden

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Not Found

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

Campo

Tipo

Descripción

errors [required]

[string]

A list of errors.

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

Ejemplo de código

                  ## default
# 

# Path parameters
export case_type_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de505"
export custom_attribute_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de505"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.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 "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": {
      "description": "Updated description.",
      "display_name": "AWS Region"
    },
    "type": "custom_attribute"
  }
}
EOF

                

"""
Update custom attribute config returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_attribute_api import CaseManagementAttributeApi
from datadog_api_client.v2.model.custom_attribute_config_resource_type import CustomAttributeConfigResourceType
from datadog_api_client.v2.model.custom_attribute_config_update import CustomAttributeConfigUpdate
from datadog_api_client.v2.model.custom_attribute_config_update_attributes import CustomAttributeConfigUpdateAttributes
from datadog_api_client.v2.model.custom_attribute_config_update_request import CustomAttributeConfigUpdateRequest
from datadog_api_client.v2.model.custom_attribute_select_option import CustomAttributeSelectOption
from datadog_api_client.v2.model.custom_attribute_type import CustomAttributeType
from datadog_api_client.v2.model.custom_attribute_type_data import CustomAttributeTypeData

body = CustomAttributeConfigUpdateRequest(
    data=CustomAttributeConfigUpdate(
        attributes=CustomAttributeConfigUpdateAttributes(
            description="Updated description.",
            display_name="AWS Region",
            type=CustomAttributeType.NUMBER,
            type_data=CustomAttributeTypeData(
                options=[
                    CustomAttributeSelectOption(
                        value="us-east-1",
                    ),
                ],
            ),
        ),
        type=CustomAttributeConfigResourceType.CUSTOM_ATTRIBUTE,
    ),
)

configuration = Configuration()
configuration.unstable_operations["update_custom_attribute_config"] = True
with ApiClient(configuration) as api_client:
    api_instance = CaseManagementAttributeApi(api_client)
    response = api_instance.update_custom_attribute_config(
        case_type_id="case_type_id", custom_attribute_id="custom_attribute_id", body=body
    )

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"

# Update custom attribute config returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.update_custom_attribute_config".to_sym] = true
end
api_instance = DatadogAPIClient::V2::CaseManagementAttributeAPI.new

body = DatadogAPIClient::V2::CustomAttributeConfigUpdateRequest.new({
  data: DatadogAPIClient::V2::CustomAttributeConfigUpdate.new({
    attributes: DatadogAPIClient::V2::CustomAttributeConfigUpdateAttributes.new({
      description: "Updated description.",
      display_name: "AWS Region",
      type: DatadogAPIClient::V2::CustomAttributeType::NUMBER,
      type_data: DatadogAPIClient::V2::CustomAttributeTypeData.new({
        options: [
          DatadogAPIClient::V2::CustomAttributeSelectOption.new({
            value: "us-east-1",
          }),
        ],
      }),
    }),
    type: DatadogAPIClient::V2::CustomAttributeConfigResourceType::CUSTOM_ATTRIBUTE,
  }),
})
p api_instance.update_custom_attribute_config("case_type_id", "custom_attribute_id", body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"

// Update custom attribute config returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.CustomAttributeConfigUpdateRequest{
		Data: datadogV2.CustomAttributeConfigUpdate{
			Attributes: &datadogV2.CustomAttributeConfigUpdateAttributes{
				Description: datadog.PtrString("Updated description."),
				DisplayName: datadog.PtrString("AWS Region"),
				Type:        datadogV2.CUSTOMATTRIBUTETYPE_NUMBER.Ptr(),
				TypeData: &datadogV2.CustomAttributeTypeData{
					Options: []datadogV2.CustomAttributeSelectOption{
						{
							Value: "us-east-1",
						},
					},
				},
			},
			Type: datadogV2.CUSTOMATTRIBUTECONFIGRESOURCETYPE_CUSTOM_ATTRIBUTE,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.UpdateCustomAttributeConfig", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewCaseManagementAttributeApi(apiClient)
	resp, r, err := api.UpdateCustomAttributeConfig(ctx, "case_type_id", "custom_attribute_id", body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementAttributeApi.UpdateCustomAttributeConfig`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `CaseManagementAttributeApi.UpdateCustomAttributeConfig`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"

// Update custom attribute config returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementAttributeApi;
import com.datadog.api.client.v2.model.CustomAttributeConfigResourceType;
import com.datadog.api.client.v2.model.CustomAttributeConfigResponse;
import com.datadog.api.client.v2.model.CustomAttributeConfigUpdate;
import com.datadog.api.client.v2.model.CustomAttributeConfigUpdateAttributes;
import com.datadog.api.client.v2.model.CustomAttributeConfigUpdateRequest;
import com.datadog.api.client.v2.model.CustomAttributeSelectOption;
import com.datadog.api.client.v2.model.CustomAttributeType;
import com.datadog.api.client.v2.model.CustomAttributeTypeData;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.updateCustomAttributeConfig", true);
    CaseManagementAttributeApi apiInstance = new CaseManagementAttributeApi(defaultClient);

    CustomAttributeConfigUpdateRequest body =
        new CustomAttributeConfigUpdateRequest()
            .data(
                new CustomAttributeConfigUpdate()
                    .attributes(
                        new CustomAttributeConfigUpdateAttributes()
                            .description("Updated description.")
                            .displayName("AWS Region")
                            .type(CustomAttributeType.NUMBER)
                            .typeData(
                                new CustomAttributeTypeData()
                                    .options(
                                        Collections.singletonList(
                                            new CustomAttributeSelectOption().value("us-east-1")))))
                    .type(CustomAttributeConfigResourceType.CUSTOM_ATTRIBUTE));

    try {
      CustomAttributeConfigResponse result =
          apiInstance.updateCustomAttributeConfig(
              "f98a5a5b-e0ff-45d4-b2f5-afe6e74de505", "f98a5a5b-e0ff-45d4-b2f5-afe6e74de505", body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling CaseManagementAttributeApi#updateCustomAttributeConfig");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"

// Update custom attribute config returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management_attribute::CaseManagementAttributeAPI;
use datadog_api_client::datadogV2::model::CustomAttributeConfigResourceType;
use datadog_api_client::datadogV2::model::CustomAttributeConfigUpdate;
use datadog_api_client::datadogV2::model::CustomAttributeConfigUpdateAttributes;
use datadog_api_client::datadogV2::model::CustomAttributeConfigUpdateRequest;
use datadog_api_client::datadogV2::model::CustomAttributeSelectOption;
use datadog_api_client::datadogV2::model::CustomAttributeType;
use datadog_api_client::datadogV2::model::CustomAttributeTypeData;

#[tokio::main]
async fn main() {
    let body = CustomAttributeConfigUpdateRequest::new(
        CustomAttributeConfigUpdate::new(CustomAttributeConfigResourceType::CUSTOM_ATTRIBUTE)
            .attributes(
                CustomAttributeConfigUpdateAttributes::new()
                    .description("Updated description.".to_string())
                    .display_name("AWS Region".to_string())
                    .type_(CustomAttributeType::NUMBER)
                    .type_data(CustomAttributeTypeData::new().options(vec![
                        CustomAttributeSelectOption::new("us-east-1".to_string()),
                    ])),
            ),
    );
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.UpdateCustomAttributeConfig", true);
    let api = CaseManagementAttributeAPI::with_config(configuration);
    let resp = api
        .update_custom_attribute_config(
            "case_type_id".to_string(),
            "custom_attribute_id".to_string(),
            body,
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run

/**
 * Update custom attribute config returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.updateCustomAttributeConfig"] = true;
const apiInstance = new v2.CaseManagementAttributeApi(configuration);

const params: v2.CaseManagementAttributeApiUpdateCustomAttributeConfigRequest =
  {
    body: {
      data: {
        attributes: {
          description: "Updated description.",
          displayName: "AWS Region",
          type: "NUMBER",
          typeData: {
            options: [
              {
                value: "us-east-1",
              },
            ],
          },
        },
        type: "custom_attribute",
      },
    },
    caseTypeId: "case_type_id",
    customAttributeId: "custom_attribute_id",
  };

apiInstance
  .updateCustomAttributeConfig(params)
  .then((data: v2.CustomAttributeConfigResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"

Update custom attribute config

Información general

Argumentos

Parámetros de ruta

Solicitud

Body Data (required)

Respuesta

Ejemplo de código

Update custom attribute config

Update custom attribute config

Instructions

Update custom attribute config

Instructions

Update custom attribute config

Instructions

Update custom attribute config

Instructions

Update custom attribute config

Instructions

Update custom attribute config

Instructions

How can I help you today?