issues
Creates, updates, deletes, gets or lists an issues resource.
Overview
| Name | issues |
| Type | Resource |
| Id | datadog.service_management.issues |
Fields
The following fields are returned by SELECT queries:
- get_issue
| Name | Datatype | Description |
|---|---|---|
id | string | Issue identifier. (example: c1726a66-1f64-11ee-b338-da7ad0900002) |
attributes | object | Object containing the information of an issue. |
relationships | object | Relationship between the issue and an assignee, case and/or teams. |
type | string | Type of the object. (issue) (example: issue) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_issue | select | issue_id | include | Retrieve the full details for a specific error tracking issue, including attributes and relationships. |
search_issues | insert | data | include | Search issues endpoint allows you to programmatically search for issues within your organization. This endpoint returns a list of issues that match a given search query, following the event search syntax. The search results are limited to a maximum of 100 issues per request. |
update_issue_assignee | exec | issue_id, data | Update the assignee of an issue by issue_id. | |
update_issue_state | exec | issue_id, data | Update the state of an issue by issue_id. Use this endpoint to move an issue between states such as OPEN, RESOLVED, or IGNORED. |
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 |
|---|---|---|
issue_id | string | The identifier of the issue. (example: c1726a66-1f64-11ee-b338-da7ad0900002) |
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. |
include | array | Comma-separated list of relationship objects that should be included in the response. Possible values are issue, issue.assignee, issue.case, and issue.team_owners. |
SELECT examples
- get_issue
Retrieve the full details for a specific error tracking issue, including attributes and relationships.
SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.issues
WHERE issue_id = '{{ issue_id }}' -- required
AND include = '{{ include }}'
;
INSERT examples
- search_issues
- Manifest
Search issues endpoint allows you to programmatically search for issues within your organization. This endpoint returns a list of issues that match a given search query, following the event search syntax. The search results are limited to a maximum of 100 issues per request.
INSERT INTO datadog.service_management.issues (
data,
include
)
SELECT
'{{ data }}' /* required */,
'{{ include }}'
RETURNING
data,
included
;
# Description fields are for documentation purposes
- name: issues
props:
- name: data
description: |
Search issues request.
value:
attributes:
assignee_ids:
- "{{ assignee_ids }}"
from: {{ from }}
order_by: "{{ order_by }}"
persona: "{{ persona }}"
query: "{{ query }}"
states:
- "{{ states }}"
team_ids:
- "{{ team_ids }}"
to: {{ to }}
track: "{{ track }}"
type: "{{ type }}"
- name: include
value: "{{ include }}"
description: Comma-separated list of relationship objects that should be included in the response. Possible values are `issue`, `issue.assignee`, `issue.case`, and `issue.team_owners`.
description: Comma-separated list of relationship objects that should be included in the response. Possible values are `issue`, `issue.assignee`, `issue.case`, and `issue.team_owners`.
Lifecycle Methods
EXEC variables use wire (API) names.
- update_issue_assignee
- update_issue_state
Update the assignee of an issue by issue_id.
EXEC datadog.service_management.issues.update_issue_assignee
@issue_id='{{ issue_id }}' --required,
@@json=
'{
"data": "{{ data }}"
}'
;
Update the state of an issue by issue_id. Use this endpoint to move an issue between states such as OPEN, RESOLVED, or IGNORED.
EXEC datadog.service_management.issues.update_issue_state
@issue_id='{{ issue_id }}' --required,
@@json=
'{
"data": "{{ data }}"
}'
;