incident_impact_fields

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

Overview

Name	incident_impact_fields
Type	Resource
Id	datadog.service_management.incident_impact_fields

Fields

The following fields are returned by SELECT queries:

list_incident_impact_fields

Name	Datatype	Description
id	string (uuid)	The impact field identifier. (example: 00000000-0000-0000-0000-000000000000)
attributes	object	Attributes of an impact field in a response.
relationships	object	Relationships for an impact field.
type	string	Impact field resource type. (impact_fields) (example: impact_fields)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_incident_impact_fields	select			List all impact fields for incidents.
create_incident_impact_field	insert	data		Create an impact field for incidents.
update_incident_impact_field	replace	field_id, data		Update an impact field for incidents.
delete_incident_impact_field	delete	field_id		Delete an impact field for incidents.

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 (uuid)	The UUID of the impact 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.

SELECT examples

list_incident_impact_fields

List all impact fields for incidents.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_impact_fields
;

INSERT examples

create_incident_impact_field

Create an impact field for incidents.

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

Manifest

# Description fields are for documentation purposes
- name: incident_impact_fields
props:
  - name: data
    description: |
      Impact field data in a create request.
    value:
      attributes:
        display_name: "{{ display_name }}"
        field_choices:
          - description: "{{ description }}"
            display_name: "{{ display_name }}"
            value: "{{ value }}"
        field_type: "{{ field_type }}"
        name: "{{ name }}"
        tag_key: "{{ tag_key }}"
      relationships:
        incident_type:
          data:
            id: "{{ id }}"
            type: "{{ type }}"
      type: "{{ type }}"

REPLACE examples

update_incident_impact_field

Update an impact field for incidents.

REPLACE datadog.service_management.incident_impact_fields
SET 
data = '{{ data }}'
WHERE 
field_id = '{{ field_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data,
included;

DELETE examples

delete_incident_impact_field

Delete an impact field for incidents.

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