Attributes for creating an incident user-defined field.
category
enum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section.
Allowed enum values: what_happened,why_it_happened
collected
enum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields.
Allowed enum values: active,stable,resolved,completed
default_value
string
The default value for the field. Must be one of the valid values when valid_values is set.
display_name
string
The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
name [required]
string
The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods.
ordinal
string
A decimal string representing the field's display order in the UI.
required
boolean
When true, users must fill out this field on incidents.
tag_key
string
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]
enum
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
Allowed enum values: 1,2,3,4,5,6,7,8
valid_values
[object]
The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.
description
string
A detailed description of the valid value.
display_name [required]
string
The human-readable display name for this value.
short_description
string
A short description of the valid value.
value [required]
string
The identifier that is stored when this option is selected.
relationships [required]
object
Relationships for creating an incident user-defined field.
incident_type [required]
object
Relationship to an incident type.
data [required]
object
Relationship to incident type object.
id [required]
string
The incident type's ID.
type [required]
enum
Incident type resource type.
Allowed enum values: incident_types
default: incident_types
type [required]
enum
The incident user defined fields type.
Allowed enum values: user_defined_field
Response containing a single incident user-defined field.
Expand All
フィールド
タイプ
説明
data [required]
object
Data object for an incident user-defined field response.
attributes [required]
object
Attributes of an incident user-defined field.
category [required]
enum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section.
Allowed enum values: what_happened,why_it_happened
collected [required]
enum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields.
Allowed enum values: active,stable,resolved,completed
created [required]
date-time
Timestamp when the field was created.
default_value [required]
string
The default value for the field.
deleted [required]
date-time
Timestamp when the field was soft-deleted, or null if not deleted.
display_name [required]
string
The human-readable name shown in the UI.
metadata [required]
object
Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.
category [required]
string
The category of the autocomplete source.
search_limit_param [required]
string
The query parameter used to limit the number of autocomplete results.
search_params [required]
object
Additional query parameters to include in the search URL.
search_query_param [required]
string
The query parameter used to pass typed input to the search URL.
search_result_path [required]
string
The JSON path to the results in the response body.
search_url [required]
string
The URL used to populate autocomplete options.
modified [required]
date-time
Timestamp when the field was last modified.
name [required]
string
The unique identifier of the field.
ordinal [required]
string
A decimal string representing the field's display order in the UI.
required [required]
boolean
When true, users must fill out this field on incidents.
reserved [required]
boolean
When true, this field is reserved for system use and cannot be deleted.
tag_key [required]
string
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]
int32
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
valid_values [required]
[object]
The list of allowed values for dropdown, multiselect, and autocomplete fields.
description
string
A detailed description of the valid value.
display_name [required]
string
The human-readable display name for this value.
short_description
string
A short description of the valid value.
value [required]
string
The identifier that is stored when this option is selected.
id [required]
string
The unique identifier of the user-defined field.
relationships [required]
object
Relationships of an incident user-defined field.
created_by_user [required]
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
incident_type [required]
object
Relationship to an incident type.
data [required]
object
Relationship to incident type object.
id [required]
string
The incident type's ID.
type [required]
enum
Incident type resource type.
Allowed enum values: incident_types
default: incident_types
last_modified_by_user [required]
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
Users resource type.
Allowed enum values: users
default: users
type [required]
enum
The incident user defined fields type.
Allowed enum values: user_defined_field
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"python3"example.py"
# Create an incident user-defined field returns "CREATED" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.access_token=ENV["DD_BEARER_TOKEN"]config.unstable_operations["v2.create_incident_user_defined_field".to_sym]=trueendapi_instance=DatadogAPIClient::V2::IncidentsAPI.newbody=DatadogAPIClient::V2::IncidentUserDefinedFieldCreateRequest.new({data:DatadogAPIClient::V2::IncidentUserDefinedFieldCreateData.new({attributes:DatadogAPIClient::V2::IncidentUserDefinedFieldAttributesCreateRequest.new({category:DatadogAPIClient::V2::IncidentUserDefinedFieldCategory::WHAT_HAPPENED,collected:DatadogAPIClient::V2::IncidentUserDefinedFieldCollected::ACTIVE,default_value:"critical",display_name:"Root Cause",name:"root_cause",ordinal:"1.5",required:false,tag_key:"datacenter",type:DatadogAPIClient::V2::IncidentUserDefinedFieldFieldType::TEXTBOX,valid_values:[DatadogAPIClient::V2::IncidentUserDefinedFieldValidValue.new({description:"A critical severity incident.",display_name:"Critical",short_description:"Critical",value:"critical",}),],}),relationships:DatadogAPIClient::V2::IncidentUserDefinedFieldCreateRelationships.new({incident_type:DatadogAPIClient::V2::RelationshipToIncidentType.new({data:DatadogAPIClient::V2::RelationshipToIncidentTypeData.new({id:"00000000-0000-0000-0000-000000000000",type:DatadogAPIClient::V2::IncidentTypeType::INCIDENT_TYPES,}),}),}),type:DatadogAPIClient::V2::IncidentUserDefinedFieldType::USER_DEFINED_FIELD,}),})papi_instance.create_incident_user_defined_field(body)
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"rb"example.rb"
// Create an incident user-defined field 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(){body:=datadogV2.IncidentUserDefinedFieldCreateRequest{Data:datadogV2.IncidentUserDefinedFieldCreateData{Attributes:datadogV2.IncidentUserDefinedFieldAttributesCreateRequest{Category:*datadogV2.NewNullableIncidentUserDefinedFieldCategory(datadogV2.INCIDENTUSERDEFINEDFIELDCATEGORY_WHAT_HAPPENED.Ptr()),Collected:*datadogV2.NewNullableIncidentUserDefinedFieldCollected(datadogV2.INCIDENTUSERDEFINEDFIELDCOLLECTED_ACTIVE.Ptr()),DefaultValue:*datadog.NewNullableString(datadog.PtrString("critical")),DisplayName:datadog.PtrString("Root Cause"),Name:"root_cause",Ordinal:*datadog.NewNullableString(datadog.PtrString("1.5")),Required:datadog.PtrBool(false),TagKey:*datadog.NewNullableString(datadog.PtrString("datacenter")),Type:datadogV2.INCIDENTUSERDEFINEDFIELDFIELDTYPE_TEXTBOX,ValidValues:[]datadogV2.IncidentUserDefinedFieldValidValue{{Description:datadog.PtrString("A critical severity incident."),DisplayName:"Critical",ShortDescription:datadog.PtrString("Critical"),Value:"critical",},},},Relationships:datadogV2.IncidentUserDefinedFieldCreateRelationships{IncidentType:datadogV2.RelationshipToIncidentType{Data:datadogV2.RelationshipToIncidentTypeData{Id:"00000000-0000-0000-0000-000000000000",Type:datadogV2.INCIDENTTYPETYPE_INCIDENT_TYPES,},},},Type:datadogV2.INCIDENTUSERDEFINEDFIELDTYPE_USER_DEFINED_FIELD,},}ctx:=datadog.NewDefaultContext(context.Background())ctx=context.WithValue(ctx,datadog.ContextAccessToken,os.Getenv("DD_BEARER_TOKEN"))configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.CreateIncidentUserDefinedField",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewIncidentsApi(apiClient)resp,r,err:=api.CreateIncidentUserDefinedField(ctx,body,*datadogV2.NewCreateIncidentUserDefinedFieldOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `IncidentsApi.CreateIncidentUserDefinedField`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `IncidentsApi.CreateIncidentUserDefinedField`:\n%s\n",responseContent)}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"go run"main.go"
// Create an incident user-defined field returns "CREATED" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.IncidentsApi;importcom.datadog.api.client.v2.model.IncidentTypeType;importcom.datadog.api.client.v2.model.IncidentUserDefinedFieldAttributesCreateRequest;importcom.datadog.api.client.v2.model.IncidentUserDefinedFieldCategory;importcom.datadog.api.client.v2.model.IncidentUserDefinedFieldCollected;importcom.datadog.api.client.v2.model.IncidentUserDefinedFieldCreateData;importcom.datadog.api.client.v2.model.IncidentUserDefinedFieldCreateRelationships;importcom.datadog.api.client.v2.model.IncidentUserDefinedFieldCreateRequest;importcom.datadog.api.client.v2.model.IncidentUserDefinedFieldFieldType;importcom.datadog.api.client.v2.model.IncidentUserDefinedFieldResponse;importcom.datadog.api.client.v2.model.IncidentUserDefinedFieldType;importcom.datadog.api.client.v2.model.IncidentUserDefinedFieldValidValue;importcom.datadog.api.client.v2.model.RelationshipToIncidentType;importcom.datadog.api.client.v2.model.RelationshipToIncidentTypeData;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));defaultClient.setUnstableOperationEnabled("v2.createIncidentUserDefinedField",true);IncidentsApiapiInstance=newIncidentsApi(defaultClient);IncidentUserDefinedFieldCreateRequestbody=newIncidentUserDefinedFieldCreateRequest().data(newIncidentUserDefinedFieldCreateData().attributes(newIncidentUserDefinedFieldAttributesCreateRequest().category(IncidentUserDefinedFieldCategory.WHAT_HAPPENED).collected(IncidentUserDefinedFieldCollected.ACTIVE).defaultValue("critical").displayName("Root Cause").name("root_cause").ordinal("1.5").required(false).tagKey("datacenter").type(IncidentUserDefinedFieldFieldType.TEXTBOX).validValues(Collections.singletonList(newIncidentUserDefinedFieldValidValue().description("A critical severity incident.").displayName("Critical").shortDescription("Critical").value("critical")))).relationships(newIncidentUserDefinedFieldCreateRelationships().incidentType(newRelationshipToIncidentType().data(newRelationshipToIncidentTypeData().id("00000000-0000-0000-0000-000000000000").type(IncidentTypeType.INCIDENT_TYPES)))).type(IncidentUserDefinedFieldType.USER_DEFINED_FIELD));try{IncidentUserDefinedFieldResponseresult=apiInstance.createIncidentUserDefinedField(body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling IncidentsApi#createIncidentUserDefinedField");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"java"Example.java"
// Create an incident user-defined field returns "CREATED" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_incidents::CreateIncidentUserDefinedFieldOptionalParams;usedatadog_api_client::datadogV2::api_incidents::IncidentsAPI;usedatadog_api_client::datadogV2::model::IncidentTypeType;usedatadog_api_client::datadogV2::model::IncidentUserDefinedFieldAttributesCreateRequest;usedatadog_api_client::datadogV2::model::IncidentUserDefinedFieldCategory;usedatadog_api_client::datadogV2::model::IncidentUserDefinedFieldCollected;usedatadog_api_client::datadogV2::model::IncidentUserDefinedFieldCreateData;usedatadog_api_client::datadogV2::model::IncidentUserDefinedFieldCreateRelationships;usedatadog_api_client::datadogV2::model::IncidentUserDefinedFieldCreateRequest;usedatadog_api_client::datadogV2::model::IncidentUserDefinedFieldFieldType;usedatadog_api_client::datadogV2::model::IncidentUserDefinedFieldType;usedatadog_api_client::datadogV2::model::IncidentUserDefinedFieldValidValue;usedatadog_api_client::datadogV2::model::RelationshipToIncidentType;usedatadog_api_client::datadogV2::model::RelationshipToIncidentTypeData;#[tokio::main]asyncfnmain(){letbody=IncidentUserDefinedFieldCreateRequest::new(IncidentUserDefinedFieldCreateData::new(IncidentUserDefinedFieldAttributesCreateRequest::new("root_cause".to_string(),IncidentUserDefinedFieldFieldType::TEXTBOX,).category(Some(IncidentUserDefinedFieldCategory::WHAT_HAPPENED)).collected(Some(IncidentUserDefinedFieldCollected::ACTIVE)).default_value(Some("critical".to_string())).display_name("Root Cause".to_string()).ordinal(Some("1.5".to_string())).required(false).tag_key(Some("datacenter".to_string())).valid_values(vec![IncidentUserDefinedFieldValidValue::new("Critical".to_string(),"critical".to_string(),).description("A critical severity incident.".to_string()).short_description("Critical".to_string())]),IncidentUserDefinedFieldCreateRelationships::new(RelationshipToIncidentType::new(RelationshipToIncidentTypeData::new("00000000-0000-0000-0000-000000000000".to_string(),IncidentTypeType::INCIDENT_TYPES,),)),IncidentUserDefinedFieldType::USER_DEFINED_FIELD,));letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.CreateIncidentUserDefinedField",true);letapi=IncidentsAPI::with_config(configuration);letresp=api.create_incident_user_defined_field(body,CreateIncidentUserDefinedFieldOptionalParams::default(),).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="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Create an incident user-defined field returns "CREATED" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration({authMethods:{AuthZ:{accessToken: process.env.DD_BEARER_TOKENasstring,},},});configuration.unstableOperations["v2.createIncidentUserDefinedField"]=true;constapiInstance=newv2.IncidentsApi(configuration);constparams: v2.IncidentsApiCreateIncidentUserDefinedFieldRequest={body:{data:{attributes:{category:"what_happened",collected:"active",defaultValue:"critical",displayName:"Root Cause",name:"root_cause",ordinal:"1.5",required: false,tagKey:"datacenter",type:3,validValues:[{description:"A critical severity incident.",displayName:"Critical",shortDescription:"Critical",value:"critical",},],},relationships:{incidentType:{data:{id:"00000000-0000-0000-0000-000000000000",type:"incident_types",},},},type:"user_defined_field",},},};apiInstance.createIncidentUserDefinedField(params).then((data: v2.IncidentUserDefinedFieldResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"tsc"example.ts"
パーソナライズされたデモをリクエスト
Datadog を始める
Ask AI
AI-generated responses may be inaccurate. Verify important info.
