Data object for creating a custom attribute configuration.
attributes [required]
object
Attributes required to create a custom attribute configuration.
description
string
A description explaining the purpose and expected values for this custom attribute.
display_name [required]
string
The human-readable label shown in the Case Management UI for this custom attribute.
is_multi [required]
boolean
If true, this attribute accepts an array of values. If false, only a single value is allowed.
key [required]
string
The programmatic key used to reference this custom attribute in search queries and API calls.
type [required]
enum
The data type of the custom attribute, which determines the allowed values and UI input control.
Allowed enum values: URL,TEXT,NUMBER,SELECT
type [required]
enum
JSON:API resource type for custom attribute configurations.
Allowed enum values: custom_attribute
default: custom_attribute
{"data":{"attributes":{"display_name":"AWS Region 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d","is_multi":true,"key":"region_d9fe56bc9274fbb6","type":"NUMBER"},"type":"custom_attribute"}}
Response containing a single custom attribute configuration.
Expand All
항목
유형
설명
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.
attributes
object
Attributes of a custom attribute configuration, defining an organization-specific metadata field that can be added to cases of a given type.
case_type_id [required]
string
The UUID of the case type this custom attribute belongs to.
description
string
A description explaining the purpose and expected values for this custom attribute.
display_name [required]
string
The human-readable label shown in the Case Management UI for this custom attribute.
is_multi [required]
boolean
If true, this attribute accepts an array of values. If false, only a single value is allowed.
key [required]
string
The programmatic key used to reference this custom attribute in search queries and API calls.
type [required]
enum
The data type of the custom attribute, which determines the allowed values and UI input control.
Allowed enum values: URL,TEXT,NUMBER,SELECT
id
string
Custom attribute configs identifier
type
enum
JSON:API resource type for custom attribute configurations.
Allowed enum values: custom_attribute
default: custom_attribute
{"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"}}
// Create custom attribute config for a case type returns "CREATED" responsepackagemainimport("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")funcmain(){// there is a valid "case_type" in the systemCaseTypeID:=os.Getenv("CASE_TYPE_ID")body:=datadogV2.CustomAttributeConfigCreateRequest{Data:datadogV2.CustomAttributeConfigCreate{Attributes:datadogV2.CustomAttributeConfigAttributesCreate{DisplayName:"AWS Region 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",IsMulti:true,Key:"region_d9fe56bc9274fbb6",Type:datadogV2.CUSTOMATTRIBUTETYPE_NUMBER,},Type:datadogV2.CUSTOMATTRIBUTECONFIGRESOURCETYPE_CUSTOM_ATTRIBUTE,},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewCaseManagementAttributeApi(apiClient)resp,r,err:=api.CreateCustomAttributeConfig(ctx,CaseTypeID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `CaseManagementAttributeApi.CreateCustomAttributeConfig`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `CaseManagementAttributeApi.CreateCustomAttributeConfig`:\n%s\n",responseContent)}
// Create custom attribute config for a case type returns "CREATED" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.CaseManagementAttributeApi;importcom.datadog.api.client.v2.model.CustomAttributeConfigAttributesCreate;importcom.datadog.api.client.v2.model.CustomAttributeConfigCreate;importcom.datadog.api.client.v2.model.CustomAttributeConfigCreateRequest;importcom.datadog.api.client.v2.model.CustomAttributeConfigResourceType;importcom.datadog.api.client.v2.model.CustomAttributeConfigResponse;importcom.datadog.api.client.v2.model.CustomAttributeType;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();CaseManagementAttributeApiapiInstance=newCaseManagementAttributeApi(defaultClient);// there is a valid "case_type" in the systemStringCASE_TYPE_ID=System.getenv("CASE_TYPE_ID");CustomAttributeConfigCreateRequestbody=newCustomAttributeConfigCreateRequest().data(newCustomAttributeConfigCreate().attributes(newCustomAttributeConfigAttributesCreate().displayName("AWS Region 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d").isMulti(true).key("region_d9fe56bc9274fbb6").type(CustomAttributeType.NUMBER)).type(CustomAttributeConfigResourceType.CUSTOM_ATTRIBUTE));try{CustomAttributeConfigResponseresult=apiInstance.createCustomAttributeConfig(CASE_TYPE_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling CaseManagementAttributeApi#createCustomAttributeConfig");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Create custom attribute config for a case type returns "CREATED" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.case_management_attribute_apiimportCaseManagementAttributeApifromdatadog_api_client.v2.model.custom_attribute_config_attributes_createimportCustomAttributeConfigAttributesCreatefromdatadog_api_client.v2.model.custom_attribute_config_createimportCustomAttributeConfigCreatefromdatadog_api_client.v2.model.custom_attribute_config_create_requestimportCustomAttributeConfigCreateRequestfromdatadog_api_client.v2.model.custom_attribute_config_resource_typeimportCustomAttributeConfigResourceTypefromdatadog_api_client.v2.model.custom_attribute_typeimportCustomAttributeType# there is a valid "case_type" in the systemCASE_TYPE_ID=environ["CASE_TYPE_ID"]body=CustomAttributeConfigCreateRequest(data=CustomAttributeConfigCreate(attributes=CustomAttributeConfigAttributesCreate(display_name="AWS Region 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",is_multi=True,key="region_d9fe56bc9274fbb6",type=CustomAttributeType.NUMBER,),type=CustomAttributeConfigResourceType.CUSTOM_ATTRIBUTE,),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=CaseManagementAttributeApi(api_client)response=api_instance.create_custom_attribute_config(case_type_id=CASE_TYPE_ID,body=body)print(response)
# Create custom attribute config for a case type returns "CREATED" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::CaseManagementAttributeAPI.new# there is a valid "case_type" in the systemCASE_TYPE_ID=ENV["CASE_TYPE_ID"]body=DatadogAPIClient::V2::CustomAttributeConfigCreateRequest.new({data:DatadogAPIClient::V2::CustomAttributeConfigCreate.new({attributes:DatadogAPIClient::V2::CustomAttributeConfigAttributesCreate.new({display_name:"AWS Region 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",is_multi:true,key:"region_d9fe56bc9274fbb6",type:DatadogAPIClient::V2::CustomAttributeType::NUMBER,}),type:DatadogAPIClient::V2::CustomAttributeConfigResourceType::CUSTOM_ATTRIBUTE,}),})papi_instance.create_custom_attribute_config(CASE_TYPE_ID,body)
// Create custom attribute config for a case type returns "CREATED" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_case_management_attribute::CaseManagementAttributeAPI;usedatadog_api_client::datadogV2::model::CustomAttributeConfigAttributesCreate;usedatadog_api_client::datadogV2::model::CustomAttributeConfigCreate;usedatadog_api_client::datadogV2::model::CustomAttributeConfigCreateRequest;usedatadog_api_client::datadogV2::model::CustomAttributeConfigResourceType;usedatadog_api_client::datadogV2::model::CustomAttributeType;#[tokio::main]asyncfnmain(){// there is a valid "case_type" in the system
letcase_type_id=std::env::var("CASE_TYPE_ID").unwrap();letbody=CustomAttributeConfigCreateRequest::new(CustomAttributeConfigCreate::new(CustomAttributeConfigAttributesCreate::new("AWS Region ".to_string(),true,"region_d9fe56bc9274fbb6".to_string(),CustomAttributeType::NUMBER,),CustomAttributeConfigResourceType::CUSTOM_ATTRIBUTE,));letconfiguration=datadog::Configuration::new();letapi=CaseManagementAttributeAPI::with_config(configuration);letresp=api.create_custom_attribute_config(case_type_id.clone(),body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* Create custom attribute config for a case type returns "CREATED" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.CaseManagementAttributeApi(configuration);// there is a valid "case_type" in the system
constCASE_TYPE_ID=process.env.CASE_TYPE_IDasstring;constparams: v2.CaseManagementAttributeApiCreateCustomAttributeConfigRequest={body:{data:{attributes:{displayName:"AWS Region 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",isMulti: true,key:"region_d9fe56bc9274fbb6",type:"NUMBER",},type:"custom_attribute",},},caseTypeId: CASE_TYPE_ID,};apiInstance.createCustomAttributeConfig(params).then((data: v2.CustomAttributeConfigResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));