incident_user_defined_fields

Creates, updates, deletes, gets or lists an incident_user_defined_fields resource.

Overview

Name	incident_user_defined_fields
Type	Resource
Id	datadog.service_management.incident_user_defined_fields

Fields

The following fields are returned by SELECT queries:

get_incident_user_defined_field

Name	Datatype	Description
id	string	The unique identifier of the user-defined field. (example: 00000000-0000-0000-0000-000000000000)
attributes	object	Attributes of an incident user-defined field.
relationships	object	Relationships of an incident user-defined field.
type	string	The incident user defined fields type. (user_defined_field) (example: user_defined_field)

list_incident_user_defined_fields

Name	Datatype	Description
id	string	The unique identifier of the user-defined field. (example: 00000000-0000-0000-0000-000000000000)
attributes	object	Attributes of an incident user-defined field.
relationships	object	Relationships of an incident user-defined field.
type	string	The incident user defined fields type. (user_defined_field) (example: user_defined_field)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_incident_user_defined_field	select	field_id	include	Get details of an incident user-defined field.
list_incident_user_defined_fields	select		page[size], page[number], include-deleted, filter[incident-type], include	Get a list of all incident user-defined fields.
create_incident_user_defined_field	insert	data	include	Create an incident user-defined field.
update_incident_user_defined_field	update	field_id, data	include	Update an incident user-defined field.
delete_incident_user_defined_field	delete	field_id		Delete an incident user-defined field.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
field_id	string	The ID of the incident user-defined field.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
filter[incident-type]	string	Filter results to fields associated with the given incident type UUID.
include	string	Comma-separated list of related resources to include. Supported values are "last_modified_by_user", "created_by_user", and "incident_type".
include-deleted	boolean	When true, include soft-deleted fields in the response.
page[number]	integer (int64)	The page number to retrieve, starting at 0.
page[size]	integer (int64)	The number of results to return per page. Must be between 0 and 1000.

SELECT examples

get_incident_user_defined_field

Get details of an incident user-defined field.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_user_defined_fields
WHERE field_id = '{{ field_id }}' -- required
AND include = '{{ include }}'
;

list_incident_user_defined_fields

Get a list of all incident user-defined fields.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_user_defined_fields
WHERE page[size] = '{{ page[size] }}'
AND page[number] = '{{ page[number] }}'
AND include-deleted = '{{ include-deleted }}'
AND filter[incident-type] = '{{ filter[incident-type] }}'
AND include = '{{ include }}'
;

INSERT examples

create_incident_user_defined_field

Create an incident user-defined field.

INSERT INTO datadog.service_management.incident_user_defined_fields (
data,
include
)
SELECT 
'{{ data }}' /* required */,
'{{ include }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: incident_user_defined_fields
props:
  - name: data
    description: |
      Data for creating an incident user-defined field.
    value:
      attributes:
        category: "{{ category }}"
        collected: "{{ collected }}"
        default_value: "{{ default_value }}"
        display_name: "{{ display_name }}"
        name: "{{ name }}"
        ordinal: "{{ ordinal }}"
        required: {{ required }}
        tag_key: "{{ tag_key }}"
        type: {{ type }}
        valid_values:
          - description: "{{ description }}"
            display_name: "{{ display_name }}"
            short_description: "{{ short_description }}"
            value: "{{ value }}"
      relationships:
        incident_type:
          data:
            id: "{{ id }}"
            type: "{{ type }}"
      type: "{{ type }}"
  - name: include
    value: "{{ include }}"
    description: Comma-separated list of related resources to include. Supported values are "last_modified_by_user", "created_by_user", and "incident_type".
    description: Comma-separated list of related resources to include. Supported values are "last_modified_by_user", "created_by_user", and "incident_type".

UPDATE examples

update_incident_user_defined_field

Update an incident user-defined field.

UPDATE datadog.service_management.incident_user_defined_fields
SET 
data = '{{ data }}'
WHERE 
field_id = '{{ field_id }}' --required
AND data = '{{ data }}' --required
AND include = '{{ include}}'
RETURNING
data;

DELETE examples

delete_incident_user_defined_field

Delete an incident user-defined field.

DELETE FROM datadog.service_management.incident_user_defined_fields
WHERE field_id = '{{ field_id }}' --required
;