cases

Creates, updates, deletes, gets or lists a cases resource.

Overview

Name	cases
Type	Resource
Id	datadog.service_management.cases

Fields

The following fields are returned by SELECT queries:

get_case

Name	Datatype	Description
id	string	Case's identifier (example: aeadc05e-98a8-11ec-ac2c-da7ad0900001)
attributes	object	Case resource attributes
relationships	object	Resources related to a case
type	string	Case resource type (default: case, example: case)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_case	select	case_id, region		Get the details of case by case_id
create_case	insert	region, data__data		Create a Case
search_cases	exec	region	page[size], page[number], sort[field], filter, sort[asc]	Search cases.
archive_case	exec	case_id, region, data		Archive case
assign_case	exec	case_id, region, data		Assign case to a user
update_attributes	exec	case_id, region, data		Update case attributes
update_priority	exec	case_id, region, data		Update case priority
update_status	exec	case_id, region, data		Update case status
unarchive_case	exec	case_id, region, data		Unarchive case
unassign_case	exec	case_id, region, data		Unassign case

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
case_id	string	Case's UUID or key (example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504)
region	string	(default: datadoghq.com)
filter	string	Search query
page[number]	integer (int64)	Specific page number to return.
page[size]	integer (int64)	Size for a given page. The maximum allowed value is 100.
sort[asc]	boolean	Specify if order is ascending or not
sort[field]	string	Specify which field to sort

SELECT examples

get_case

Get the details of case by case_id

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.cases
WHERE case_id = '{{ case_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_case

Create a Case

INSERT INTO datadog.service_management.cases (
data__data,
region
)
SELECT 
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: cases
  props:
    - name: region
      value: string
      description: Required parameter for the cases resource.
    - name: data
      value: object
      description: |
        Case creation data

Lifecycle Methods

search_cases

Search cases.

EXEC datadog.service_management.cases.search_cases 
@region='{{ region }}' --required, 
@page[size]='{{ page[size] }}', 
@page[number]='{{ page[number] }}', 
@sort[field]='{{ sort[field] }}', 
@filter='{{ filter }}', 
@sort[asc]={{ sort[asc] }}
;

archive_case

Archive case

EXEC datadog.service_management.cases.archive_case 
@case_id='{{ case_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"data": "{{ data }}"
}'
;

assign_case

Assign case to a user

EXEC datadog.service_management.cases.assign_case 
@case_id='{{ case_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"data": "{{ data }}"
}'
;

update_attributes

Update case attributes

EXEC datadog.service_management.cases.update_attributes 
@case_id='{{ case_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"data": "{{ data }}"
}'
;

update_priority

Update case priority

EXEC datadog.service_management.cases.update_priority 
@case_id='{{ case_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"data": "{{ data }}"
}'
;

update_status

Update case status

EXEC datadog.service_management.cases.update_status 
@case_id='{{ case_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"data": "{{ data }}"
}'
;

unarchive_case

Unarchive case

EXEC datadog.service_management.cases.unarchive_case 
@case_id='{{ case_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"data": "{{ data }}"
}'
;

unassign_case

Unassign case

EXEC datadog.service_management.cases.unassign_case 
@case_id='{{ case_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"data": "{{ data }}"
}'
;