Response containing a list of custom attribute configurations.
Expand All
Field
Type
Description
data
[object]
List of custom attribute configs of case type
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"}]}
"""
Get all custom attributes config of case type returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.case_management_attribute_apiimportCaseManagementAttributeApi# there is a valid "case_type" in the systemCASE_TYPE_ID=environ["CASE_TYPE_ID"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=CaseManagementAttributeApi(api_client)response=api_instance.get_all_custom_attribute_configs_by_case_type(case_type_id=CASE_TYPE_ID,)print(response)
# Get all custom attributes config of case type returns "OK" 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"]papi_instance.get_all_custom_attribute_configs_by_case_type(CASE_TYPE_ID)
// Get all custom attributes config of case type returns "OK" 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")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewCaseManagementAttributeApi(apiClient)resp,r,err:=api.GetAllCustomAttributeConfigsByCaseType(ctx,CaseTypeID)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `CaseManagementAttributeApi.GetAllCustomAttributeConfigsByCaseType`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `CaseManagementAttributeApi.GetAllCustomAttributeConfigsByCaseType`:\n%s\n",responseContent)}
// Get all custom attributes config of case type returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.CaseManagementAttributeApi;importcom.datadog.api.client.v2.model.CustomAttributeConfigsResponse;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");try{CustomAttributeConfigsResponseresult=apiInstance.getAllCustomAttributeConfigsByCaseType(CASE_TYPE_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling"+" CaseManagementAttributeApi#getAllCustomAttributeConfigsByCaseType");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get all custom attributes config of case type returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_case_management_attribute::CaseManagementAttributeAPI;#[tokio::main]asyncfnmain(){// there is a valid "case_type" in the system
letcase_type_id=std::env::var("CASE_TYPE_ID").unwrap();letconfiguration=datadog::Configuration::new();letapi=CaseManagementAttributeAPI::with_config(configuration);letresp=api.get_all_custom_attribute_configs_by_case_type(case_type_id.clone()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* Get all custom attributes config of case type returns "OK" 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.CaseManagementAttributeApiGetAllCustomAttributeConfigsByCaseTypeRequest={caseTypeId: CASE_TYPE_ID,};apiInstance.getAllCustomAttributeConfigsByCaseType(params).then((data: v2.CustomAttributeConfigsResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));