- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
View and manage cases and projects within Case Management. See the Case Management page for more information.
POST https://api.ap1.datadoghq.com/api/v2/cases/projectshttps://api.datadoghq.eu/api/v2/cases/projectshttps://api.ddog-gov.com/api/v2/cases/projectshttps://api.datadoghq.com/api/v2/cases/projectshttps://api.us3.datadoghq.com/api/v2/cases/projectshttps://api.us5.datadoghq.com/api/v2/cases/projects
Create a project.
OAuth apps require the cases_write
authorization scope to access this endpoint.
Project payload
항목
유형
설명
data [required]
object
Project create
attributes [required]
object
Project creation attributes
key [required]
string
Project's key. Cannot be "CASE"
name [required]
string
name
type [required]
enum
Project resource type
Allowed enum values: project
default: project
{
"data": {
"attributes": {
"key": "SEC",
"name": "Security Investigation"
},
"type": "project"
}
}
CREATED
Project response
항목
유형
설명
data
object
A Project
attributes [required]
object
Project attributes
key
string
The project's key
name
string
Project's name
id [required]
string
The Project's identifier
relationships
object
Project relationships
member_team
object
Relationship between a team and a team link
data
[object]
Related team links
id [required]
string
The team link's identifier
type [required]
enum
Team link type
Allowed enum values: team_links
default: team_links
links
object
Links attributes.
related
string
Related link.
member_user
object
Relationship to users.
data [required]
[object]
Relationships to user objects.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
type [required]
enum
Project resource type
Allowed enum values: project
default: project
{
"data": {
"attributes": {
"key": "CASEM",
"name": "string"
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"member_team": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001",
"type": "team_links"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
},
"member_user": {
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
]
}
},
"type": "project"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Create a project returns "CREATED" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
body = DatadogAPIClient::V2::ProjectCreateRequest.new({
data: DatadogAPIClient::V2::ProjectCreate.new({
attributes: DatadogAPIClient::V2::ProjectCreateAttributes.new({
key: "SEC",
name: "Security Investigation",
}),
type: DatadogAPIClient::V2::ProjectResourceType::PROJECT,
}),
})
p api_instance.create_project(body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
GET https://api.ap1.datadoghq.com/api/v2/caseshttps://api.datadoghq.eu/api/v2/caseshttps://api.ddog-gov.com/api/v2/caseshttps://api.datadoghq.com/api/v2/caseshttps://api.us3.datadoghq.com/api/v2/caseshttps://api.us5.datadoghq.com/api/v2/cases
Search cases.
OAuth apps require the cases_read
authorization scope to access this endpoint.
이름
유형
설명
page[size]
integer
Size for a given page. The maximum allowed value is 100.
page[number]
integer
Specific page number to return.
sort[field]
enum
Specify which field to sort
Allowed enum values: created_at, priority, status
filter
string
Search query
sort[asc]
boolean
Specify if order is ascending or not
OK
Response with cases
항목
유형
설명
data
[object]
Cases response data
attributes [required]
object
Case attributes
archived_at
date-time
Timestamp of when the case was archived
closed_at
date-time
Timestamp of when the case was closed
created_at
date-time
Timestamp of when the case was created
description
string
Description
jira_issue
object
Jira issue attached to case
result
object
Jira issue information
issue_id
string
Jira issue ID
issue_key
string
Jira issue key
issue_url
string
Jira issue URL
project_key
string
Jira project key
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
string
Key
modified_at
date-time
Timestamp of when the case was last modified
priority
enum
Case priority
Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
object
ServiceNow ticket attached to case
result
object
ServiceNow ticket information
sys_target_link
string
Link to the Incident created on ServiceNow
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
enum
Case status
Allowed enum values: OPEN,IN_PROGRESS,CLOSED
title
string
Title
type
enum
Case type
Allowed enum values: STANDARD
id [required]
string
Case's identifier
relationships
object
Resources related to a case
assignee
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
created_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
modified_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
project
object
Relationship to project
data [required]
object
Relationship to project object
id [required]
string
A unique identifier that represents the project
type [required]
enum
Project resource type
Allowed enum values: project
default: project
type [required]
enum
Case resource type
Allowed enum values: case
default: case
meta
object
Cases response metadata
page
object
Pagination metadata
current
int64
Current page number
size
int64
Number of cases in current page
total
int64
Total number of pages
{
"data": [
{
"attributes": {
"archived_at": "2019-09-19T10:00:00.000Z",
"closed_at": "2019-09-19T10:00:00.000Z",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"jira_issue": {
"result": {
"issue_id": "string",
"issue_key": "string",
"issue_url": "string",
"project_key": "string"
},
"status": "COMPLETED"
},
"key": "CASEM-4523",
"modified_at": "2019-09-19T10:00:00.000Z",
"priority": "NOT_DEFINED",
"service_now_ticket": {
"result": {
"sys_target_link": "string"
},
"status": "COMPLETED"
},
"status": "OPEN",
"title": "Memory leak investigation on API",
"type": "STANDARD"
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"assignee": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"created_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"modified_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"project": {
"data": {
"id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
"type": "project"
}
}
},
"type": "case"
}
],
"meta": {
"page": {
"current": "integer",
"size": "integer",
"total": "integer"
}
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Search cases returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
p api_instance.search_cases()
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
POST https://api.ap1.datadoghq.com/api/v2/caseshttps://api.datadoghq.eu/api/v2/caseshttps://api.ddog-gov.com/api/v2/caseshttps://api.datadoghq.com/api/v2/caseshttps://api.us3.datadoghq.com/api/v2/caseshttps://api.us5.datadoghq.com/api/v2/cases
Create a Case
OAuth apps require the cases_write
authorization scope to access this endpoint.
Case payload
항목
유형
설명
data [required]
object
Case creation data
attributes [required]
object
Case creation attributes
description
string
Description
priority
enum
Case priority
Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
title [required]
string
Title
type [required]
enum
Case type
Allowed enum values: STANDARD
relationships
object
Relationships formed with the case on creation
assignee
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
project [required]
object
Relationship to project
data [required]
object
Relationship to project object
id [required]
string
A unique identifier that represents the project
type [required]
enum
Project resource type
Allowed enum values: project
default: project
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"attributes": {
"priority": "NOT_DEFINED",
"title": "Security breach investigation in 0cfbc5cbc676ee71",
"type": "STANDARD"
},
"relationships": {
"assignee": {
"data": {
"id": "string",
"type": "user"
}
},
"project": {
"data": {
"id": "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
"type": "project"
}
}
},
"type": "case"
}
}
CREATED
Case response
항목
유형
설명
data
object
A case
attributes [required]
object
Case attributes
archived_at
date-time
Timestamp of when the case was archived
closed_at
date-time
Timestamp of when the case was closed
created_at
date-time
Timestamp of when the case was created
description
string
Description
jira_issue
object
Jira issue attached to case
result
object
Jira issue information
issue_id
string
Jira issue ID
issue_key
string
Jira issue key
issue_url
string
Jira issue URL
project_key
string
Jira project key
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
string
Key
modified_at
date-time
Timestamp of when the case was last modified
priority
enum
Case priority
Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
object
ServiceNow ticket attached to case
result
object
ServiceNow ticket information
sys_target_link
string
Link to the Incident created on ServiceNow
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
enum
Case status
Allowed enum values: OPEN,IN_PROGRESS,CLOSED
title
string
Title
type
enum
Case type
Allowed enum values: STANDARD
id [required]
string
Case's identifier
relationships
object
Resources related to a case
assignee
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
created_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
modified_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
project
object
Relationship to project
data [required]
object
Relationship to project object
id [required]
string
A unique identifier that represents the project
type [required]
enum
Project resource type
Allowed enum values: project
default: project
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"attributes": {
"archived_at": "2019-09-19T10:00:00.000Z",
"closed_at": "2019-09-19T10:00:00.000Z",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"jira_issue": {
"result": {
"issue_id": "string",
"issue_key": "string",
"issue_url": "string",
"project_key": "string"
},
"status": "COMPLETED"
},
"key": "CASEM-4523",
"modified_at": "2019-09-19T10:00:00.000Z",
"priority": "NOT_DEFINED",
"service_now_ticket": {
"result": {
"sys_target_link": "string"
},
"status": "COMPLETED"
},
"status": "OPEN",
"title": "Memory leak investigation on API",
"type": "STANDARD"
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"assignee": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"created_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"modified_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"project": {
"data": {
"id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
"type": "project"
}
}
},
"type": "case"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Create a case returns "CREATED" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
# there is a valid "user" in the system
USER_DATA_ID = ENV["USER_DATA_ID"]
body = DatadogAPIClient::V2::CaseCreateRequest.new({
data: DatadogAPIClient::V2::CaseCreate.new({
attributes: DatadogAPIClient::V2::CaseCreateAttributes.new({
priority: DatadogAPIClient::V2::CasePriority::NOT_DEFINED,
title: "Security breach investigation in 0cfbc5cbc676ee71",
type: DatadogAPIClient::V2::CaseType::STANDARD,
}),
relationships: DatadogAPIClient::V2::CaseCreateRelationships.new({
assignee: DatadogAPIClient::V2::NullableUserRelationship.new({
data: DatadogAPIClient::V2::NullableUserRelationshipData.new({
id: USER_DATA_ID,
type: DatadogAPIClient::V2::UserResourceType::USER,
}),
}),
project: DatadogAPIClient::V2::ProjectRelationship.new({
data: DatadogAPIClient::V2::ProjectRelationshipData.new({
id: "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
type: DatadogAPIClient::V2::ProjectResourceType::PROJECT,
}),
}),
}),
type: DatadogAPIClient::V2::CaseResourceType::CASE,
}),
})
p api_instance.create_case(body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
GET https://api.ap1.datadoghq.com/api/v2/cases/projectshttps://api.datadoghq.eu/api/v2/cases/projectshttps://api.ddog-gov.com/api/v2/cases/projectshttps://api.datadoghq.com/api/v2/cases/projectshttps://api.us3.datadoghq.com/api/v2/cases/projectshttps://api.us5.datadoghq.com/api/v2/cases/projects
Get all projects.
OAuth apps require the cases_read
authorization scope to access this endpoint.
OK
Response with projects
항목
유형
설명
data
[object]
Projects response data
attributes [required]
object
Project attributes
key
string
The project's key
name
string
Project's name
id [required]
string
The Project's identifier
relationships
object
Project relationships
member_team
object
Relationship between a team and a team link
data
[object]
Related team links
id [required]
string
The team link's identifier
type [required]
enum
Team link type
Allowed enum values: team_links
default: team_links
links
object
Links attributes.
related
string
Related link.
member_user
object
Relationship to users.
data [required]
[object]
Relationships to user objects.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
type [required]
enum
Project resource type
Allowed enum values: project
default: project
{
"data": [
{
"attributes": {
"key": "CASEM",
"name": "string"
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"member_team": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001",
"type": "team_links"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
},
"member_user": {
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
]
}
},
"type": "project"
}
]
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Get all projects returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
p api_instance.get_projects()
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
GET https://api.ap1.datadoghq.com/api/v2/cases/{case_id}https://api.datadoghq.eu/api/v2/cases/{case_id}https://api.ddog-gov.com/api/v2/cases/{case_id}https://api.datadoghq.com/api/v2/cases/{case_id}https://api.us3.datadoghq.com/api/v2/cases/{case_id}https://api.us5.datadoghq.com/api/v2/cases/{case_id}
Get the details of case by case_id
OAuth apps require the cases_read
authorization scope to access this endpoint.
이름
유형
설명
case_id [required]
string
Case’s UUID or key
OK
Case response
항목
유형
설명
data
object
A case
attributes [required]
object
Case attributes
archived_at
date-time
Timestamp of when the case was archived
closed_at
date-time
Timestamp of when the case was closed
created_at
date-time
Timestamp of when the case was created
description
string
Description
jira_issue
object
Jira issue attached to case
result
object
Jira issue information
issue_id
string
Jira issue ID
issue_key
string
Jira issue key
issue_url
string
Jira issue URL
project_key
string
Jira project key
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
string
Key
modified_at
date-time
Timestamp of when the case was last modified
priority
enum
Case priority
Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
object
ServiceNow ticket attached to case
result
object
ServiceNow ticket information
sys_target_link
string
Link to the Incident created on ServiceNow
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
enum
Case status
Allowed enum values: OPEN,IN_PROGRESS,CLOSED
title
string
Title
type
enum
Case type
Allowed enum values: STANDARD
id [required]
string
Case's identifier
relationships
object
Resources related to a case
assignee
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
created_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
modified_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
project
object
Relationship to project
data [required]
object
Relationship to project object
id [required]
string
A unique identifier that represents the project
type [required]
enum
Project resource type
Allowed enum values: project
default: project
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"attributes": {
"archived_at": "2019-09-19T10:00:00.000Z",
"closed_at": "2019-09-19T10:00:00.000Z",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"jira_issue": {
"result": {
"issue_id": "string",
"issue_key": "string",
"issue_url": "string",
"project_key": "string"
},
"status": "COMPLETED"
},
"key": "CASEM-4523",
"modified_at": "2019-09-19T10:00:00.000Z",
"priority": "NOT_DEFINED",
"service_now_ticket": {
"result": {
"sys_target_link": "string"
},
"status": "COMPLETED"
},
"status": "OPEN",
"title": "Memory leak investigation on API",
"type": "STANDARD"
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"assignee": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"created_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"modified_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"project": {
"data": {
"id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
"type": "project"
}
}
},
"type": "case"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Get the details of a case returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
# there is a valid "case" in the system
CASE_ID = ENV["CASE_ID"]
p api_instance.get_case(CASE_ID)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
GET https://api.ap1.datadoghq.com/api/v2/cases/projects/{project_id}https://api.datadoghq.eu/api/v2/cases/projects/{project_id}https://api.ddog-gov.com/api/v2/cases/projects/{project_id}https://api.datadoghq.com/api/v2/cases/projects/{project_id}https://api.us3.datadoghq.com/api/v2/cases/projects/{project_id}https://api.us5.datadoghq.com/api/v2/cases/projects/{project_id}
Get the details of a project by project_id
.
OAuth apps require the cases_read
authorization scope to access this endpoint.
이름
유형
설명
project_id [required]
string
Project UUID
OK
Project response
항목
유형
설명
data
object
A Project
attributes [required]
object
Project attributes
key
string
The project's key
name
string
Project's name
id [required]
string
The Project's identifier
relationships
object
Project relationships
member_team
object
Relationship between a team and a team link
data
[object]
Related team links
id [required]
string
The team link's identifier
type [required]
enum
Team link type
Allowed enum values: team_links
default: team_links
links
object
Links attributes.
related
string
Related link.
member_user
object
Relationship to users.
data [required]
[object]
Relationships to user objects.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
type [required]
enum
Project resource type
Allowed enum values: project
default: project
{
"data": {
"attributes": {
"key": "CASEM",
"name": "string"
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"member_team": {
"data": [
{
"id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001",
"type": "team_links"
}
],
"links": {
"related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
}
},
"member_user": {
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
]
}
},
"type": "project"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Get the details of a project returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
p api_instance.get_project("project_id")
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
DELETE https://api.ap1.datadoghq.com/api/v2/cases/projects/{project_id}https://api.datadoghq.eu/api/v2/cases/projects/{project_id}https://api.ddog-gov.com/api/v2/cases/projects/{project_id}https://api.datadoghq.com/api/v2/cases/projects/{project_id}https://api.us3.datadoghq.com/api/v2/cases/projects/{project_id}https://api.us5.datadoghq.com/api/v2/cases/projects/{project_id}
Remove a project using the project’s id
.
OAuth apps require the cases_write
authorization scope to access this endpoint.
이름
유형
설명
project_id [required]
string
Project UUID
No Content
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
API error response
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Remove a project returns "No Content" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
api_instance.delete_project("project_id")
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
POST https://api.ap1.datadoghq.com/api/v2/cases/{case_id}/statushttps://api.datadoghq.eu/api/v2/cases/{case_id}/statushttps://api.ddog-gov.com/api/v2/cases/{case_id}/statushttps://api.datadoghq.com/api/v2/cases/{case_id}/statushttps://api.us3.datadoghq.com/api/v2/cases/{case_id}/statushttps://api.us5.datadoghq.com/api/v2/cases/{case_id}/status
Update case status
OAuth apps require the cases_write
authorization scope to access this endpoint.
이름
유형
설명
case_id [required]
string
Case’s UUID or key
Case status update payload
항목
유형
설명
data [required]
object
Case update status
attributes [required]
object
Case update status attributes
status [required]
enum
Case status
Allowed enum values: OPEN,IN_PROGRESS,CLOSED
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"attributes": {
"status": "IN_PROGRESS"
},
"type": "case"
}
}
OK
Case response
항목
유형
설명
data
object
A case
attributes [required]
object
Case attributes
archived_at
date-time
Timestamp of when the case was archived
closed_at
date-time
Timestamp of when the case was closed
created_at
date-time
Timestamp of when the case was created
description
string
Description
jira_issue
object
Jira issue attached to case
result
object
Jira issue information
issue_id
string
Jira issue ID
issue_key
string
Jira issue key
issue_url
string
Jira issue URL
project_key
string
Jira project key
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
string
Key
modified_at
date-time
Timestamp of when the case was last modified
priority
enum
Case priority
Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
object
ServiceNow ticket attached to case
result
object
ServiceNow ticket information
sys_target_link
string
Link to the Incident created on ServiceNow
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
enum
Case status
Allowed enum values: OPEN,IN_PROGRESS,CLOSED
title
string
Title
type
enum
Case type
Allowed enum values: STANDARD
id [required]
string
Case's identifier
relationships
object
Resources related to a case
assignee
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
created_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
modified_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
project
object
Relationship to project
data [required]
object
Relationship to project object
id [required]
string
A unique identifier that represents the project
type [required]
enum
Project resource type
Allowed enum values: project
default: project
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"attributes": {
"archived_at": "2019-09-19T10:00:00.000Z",
"closed_at": "2019-09-19T10:00:00.000Z",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"jira_issue": {
"result": {
"issue_id": "string",
"issue_key": "string",
"issue_url": "string",
"project_key": "string"
},
"status": "COMPLETED"
},
"key": "CASEM-4523",
"modified_at": "2019-09-19T10:00:00.000Z",
"priority": "NOT_DEFINED",
"service_now_ticket": {
"result": {
"sys_target_link": "string"
},
"status": "COMPLETED"
},
"status": "OPEN",
"title": "Memory leak investigation on API",
"type": "STANDARD"
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"assignee": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"created_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"modified_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"project": {
"data": {
"id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
"type": "project"
}
}
},
"type": "case"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Update case status returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
# there is a valid "case" in the system
CASE_ID = ENV["CASE_ID"]
body = DatadogAPIClient::V2::CaseUpdateStatusRequest.new({
data: DatadogAPIClient::V2::CaseUpdateStatus.new({
attributes: DatadogAPIClient::V2::CaseUpdateStatusAttributes.new({
status: DatadogAPIClient::V2::CaseStatus::IN_PROGRESS,
}),
type: DatadogAPIClient::V2::CaseResourceType::CASE,
}),
})
p api_instance.update_status(CASE_ID, body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
POST https://api.ap1.datadoghq.com/api/v2/cases/{case_id}/priorityhttps://api.datadoghq.eu/api/v2/cases/{case_id}/priorityhttps://api.ddog-gov.com/api/v2/cases/{case_id}/priorityhttps://api.datadoghq.com/api/v2/cases/{case_id}/priorityhttps://api.us3.datadoghq.com/api/v2/cases/{case_id}/priorityhttps://api.us5.datadoghq.com/api/v2/cases/{case_id}/priority
Update case priority
OAuth apps require the cases_write
authorization scope to access this endpoint.
이름
유형
설명
case_id [required]
string
Case’s UUID or key
Case priority update payload
항목
유형
설명
data [required]
object
Case priority status
attributes [required]
object
Case update priority attributes
priority [required]
enum
Case priority
Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"attributes": {
"priority": "P3"
},
"type": "case"
}
}
OK
Case response
항목
유형
설명
data
object
A case
attributes [required]
object
Case attributes
archived_at
date-time
Timestamp of when the case was archived
closed_at
date-time
Timestamp of when the case was closed
created_at
date-time
Timestamp of when the case was created
description
string
Description
jira_issue
object
Jira issue attached to case
result
object
Jira issue information
issue_id
string
Jira issue ID
issue_key
string
Jira issue key
issue_url
string
Jira issue URL
project_key
string
Jira project key
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
string
Key
modified_at
date-time
Timestamp of when the case was last modified
priority
enum
Case priority
Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
object
ServiceNow ticket attached to case
result
object
ServiceNow ticket information
sys_target_link
string
Link to the Incident created on ServiceNow
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
enum
Case status
Allowed enum values: OPEN,IN_PROGRESS,CLOSED
title
string
Title
type
enum
Case type
Allowed enum values: STANDARD
id [required]
string
Case's identifier
relationships
object
Resources related to a case
assignee
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
created_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
modified_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
project
object
Relationship to project
data [required]
object
Relationship to project object
id [required]
string
A unique identifier that represents the project
type [required]
enum
Project resource type
Allowed enum values: project
default: project
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"attributes": {
"archived_at": "2019-09-19T10:00:00.000Z",
"closed_at": "2019-09-19T10:00:00.000Z",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"jira_issue": {
"result": {
"issue_id": "string",
"issue_key": "string",
"issue_url": "string",
"project_key": "string"
},
"status": "COMPLETED"
},
"key": "CASEM-4523",
"modified_at": "2019-09-19T10:00:00.000Z",
"priority": "NOT_DEFINED",
"service_now_ticket": {
"result": {
"sys_target_link": "string"
},
"status": "COMPLETED"
},
"status": "OPEN",
"title": "Memory leak investigation on API",
"type": "STANDARD"
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"assignee": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"created_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"modified_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"project": {
"data": {
"id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
"type": "project"
}
}
},
"type": "case"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Update case priority returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
# there is a valid "case" in the system
CASE_ID = ENV["CASE_ID"]
body = DatadogAPIClient::V2::CaseUpdatePriorityRequest.new({
data: DatadogAPIClient::V2::CaseUpdatePriority.new({
attributes: DatadogAPIClient::V2::CaseUpdatePriorityAttributes.new({
priority: DatadogAPIClient::V2::CasePriority::P3,
}),
type: DatadogAPIClient::V2::CaseResourceType::CASE,
}),
})
p api_instance.update_priority(CASE_ID, body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
POST https://api.ap1.datadoghq.com/api/v2/cases/{case_id}/assignhttps://api.datadoghq.eu/api/v2/cases/{case_id}/assignhttps://api.ddog-gov.com/api/v2/cases/{case_id}/assignhttps://api.datadoghq.com/api/v2/cases/{case_id}/assignhttps://api.us3.datadoghq.com/api/v2/cases/{case_id}/assignhttps://api.us5.datadoghq.com/api/v2/cases/{case_id}/assign
Assign case to a user
OAuth apps require the cases_write
authorization scope to access this endpoint.
이름
유형
설명
case_id [required]
string
Case’s UUID or key
Assign case payload
항목
유형
설명
data [required]
object
Case assign
attributes [required]
object
Case assign attributes
assignee_id [required]
string
Assignee's UUID
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"attributes": {
"assignee_id": "string"
},
"type": "case"
}
}
OK
Case response
항목
유형
설명
data
object
A case
attributes [required]
object
Case attributes
archived_at
date-time
Timestamp of when the case was archived
closed_at
date-time
Timestamp of when the case was closed
created_at
date-time
Timestamp of when the case was created
description
string
Description
jira_issue
object
Jira issue attached to case
result
object
Jira issue information
issue_id
string
Jira issue ID
issue_key
string
Jira issue key
issue_url
string
Jira issue URL
project_key
string
Jira project key
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
string
Key
modified_at
date-time
Timestamp of when the case was last modified
priority
enum
Case priority
Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
object
ServiceNow ticket attached to case
result
object
ServiceNow ticket information
sys_target_link
string
Link to the Incident created on ServiceNow
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
enum
Case status
Allowed enum values: OPEN,IN_PROGRESS,CLOSED
title
string
Title
type
enum
Case type
Allowed enum values: STANDARD
id [required]
string
Case's identifier
relationships
object
Resources related to a case
assignee
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
created_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
modified_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
project
object
Relationship to project
data [required]
object
Relationship to project object
id [required]
string
A unique identifier that represents the project
type [required]
enum
Project resource type
Allowed enum values: project
default: project
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"attributes": {
"archived_at": "2019-09-19T10:00:00.000Z",
"closed_at": "2019-09-19T10:00:00.000Z",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"jira_issue": {
"result": {
"issue_id": "string",
"issue_key": "string",
"issue_url": "string",
"project_key": "string"
},
"status": "COMPLETED"
},
"key": "CASEM-4523",
"modified_at": "2019-09-19T10:00:00.000Z",
"priority": "NOT_DEFINED",
"service_now_ticket": {
"result": {
"sys_target_link": "string"
},
"status": "COMPLETED"
},
"status": "OPEN",
"title": "Memory leak investigation on API",
"type": "STANDARD"
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"assignee": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"created_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"modified_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"project": {
"data": {
"id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
"type": "project"
}
}
},
"type": "case"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Assign case returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
# there is a valid "case" in the system
CASE_ID = ENV["CASE_ID"]
# there is a valid "user" in the system
USER_DATA_ID = ENV["USER_DATA_ID"]
body = DatadogAPIClient::V2::CaseAssignRequest.new({
data: DatadogAPIClient::V2::CaseAssign.new({
attributes: DatadogAPIClient::V2::CaseAssignAttributes.new({
assignee_id: USER_DATA_ID,
}),
type: DatadogAPIClient::V2::CaseResourceType::CASE,
}),
})
p api_instance.assign_case(CASE_ID, body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
POST https://api.ap1.datadoghq.com/api/v2/cases/{case_id}/unassignhttps://api.datadoghq.eu/api/v2/cases/{case_id}/unassignhttps://api.ddog-gov.com/api/v2/cases/{case_id}/unassignhttps://api.datadoghq.com/api/v2/cases/{case_id}/unassignhttps://api.us3.datadoghq.com/api/v2/cases/{case_id}/unassignhttps://api.us5.datadoghq.com/api/v2/cases/{case_id}/unassign
Unassign case
OAuth apps require the cases_write
authorization scope to access this endpoint.
이름
유형
설명
case_id [required]
string
Case’s UUID or key
Unassign case payload
항목
유형
설명
data [required]
object
Case empty request data
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"type": "case"
}
}
OK
Case response
항목
유형
설명
data
object
A case
attributes [required]
object
Case attributes
archived_at
date-time
Timestamp of when the case was archived
closed_at
date-time
Timestamp of when the case was closed
created_at
date-time
Timestamp of when the case was created
description
string
Description
jira_issue
object
Jira issue attached to case
result
object
Jira issue information
issue_id
string
Jira issue ID
issue_key
string
Jira issue key
issue_url
string
Jira issue URL
project_key
string
Jira project key
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
string
Key
modified_at
date-time
Timestamp of when the case was last modified
priority
enum
Case priority
Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
object
ServiceNow ticket attached to case
result
object
ServiceNow ticket information
sys_target_link
string
Link to the Incident created on ServiceNow
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
enum
Case status
Allowed enum values: OPEN,IN_PROGRESS,CLOSED
title
string
Title
type
enum
Case type
Allowed enum values: STANDARD
id [required]
string
Case's identifier
relationships
object
Resources related to a case
assignee
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
created_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
modified_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
project
object
Relationship to project
data [required]
object
Relationship to project object
id [required]
string
A unique identifier that represents the project
type [required]
enum
Project resource type
Allowed enum values: project
default: project
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"attributes": {
"archived_at": "2019-09-19T10:00:00.000Z",
"closed_at": "2019-09-19T10:00:00.000Z",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"jira_issue": {
"result": {
"issue_id": "string",
"issue_key": "string",
"issue_url": "string",
"project_key": "string"
},
"status": "COMPLETED"
},
"key": "CASEM-4523",
"modified_at": "2019-09-19T10:00:00.000Z",
"priority": "NOT_DEFINED",
"service_now_ticket": {
"result": {
"sys_target_link": "string"
},
"status": "COMPLETED"
},
"status": "OPEN",
"title": "Memory leak investigation on API",
"type": "STANDARD"
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"assignee": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"created_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"modified_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"project": {
"data": {
"id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
"type": "project"
}
}
},
"type": "case"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Unassign case returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
# there is a valid "case" in the system
CASE_ID = ENV["CASE_ID"]
body = DatadogAPIClient::V2::CaseEmptyRequest.new({
data: DatadogAPIClient::V2::CaseEmpty.new({
type: DatadogAPIClient::V2::CaseResourceType::CASE,
}),
})
p api_instance.unassign_case(CASE_ID, body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
POST https://api.ap1.datadoghq.com/api/v2/cases/{case_id}/archivehttps://api.datadoghq.eu/api/v2/cases/{case_id}/archivehttps://api.ddog-gov.com/api/v2/cases/{case_id}/archivehttps://api.datadoghq.com/api/v2/cases/{case_id}/archivehttps://api.us3.datadoghq.com/api/v2/cases/{case_id}/archivehttps://api.us5.datadoghq.com/api/v2/cases/{case_id}/archive
Archive case
OAuth apps require the cases_write
authorization scope to access this endpoint.
이름
유형
설명
case_id [required]
string
Case’s UUID or key
Archive case payload
항목
유형
설명
data [required]
object
Case empty request data
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"type": "case"
}
}
OK
Case response
항목
유형
설명
data
object
A case
attributes [required]
object
Case attributes
archived_at
date-time
Timestamp of when the case was archived
closed_at
date-time
Timestamp of when the case was closed
created_at
date-time
Timestamp of when the case was created
description
string
Description
jira_issue
object
Jira issue attached to case
result
object
Jira issue information
issue_id
string
Jira issue ID
issue_key
string
Jira issue key
issue_url
string
Jira issue URL
project_key
string
Jira project key
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
string
Key
modified_at
date-time
Timestamp of when the case was last modified
priority
enum
Case priority
Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
object
ServiceNow ticket attached to case
result
object
ServiceNow ticket information
sys_target_link
string
Link to the Incident created on ServiceNow
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
enum
Case status
Allowed enum values: OPEN,IN_PROGRESS,CLOSED
title
string
Title
type
enum
Case type
Allowed enum values: STANDARD
id [required]
string
Case's identifier
relationships
object
Resources related to a case
assignee
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
created_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
modified_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
project
object
Relationship to project
data [required]
object
Relationship to project object
id [required]
string
A unique identifier that represents the project
type [required]
enum
Project resource type
Allowed enum values: project
default: project
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"attributes": {
"archived_at": "2019-09-19T10:00:00.000Z",
"closed_at": "2019-09-19T10:00:00.000Z",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"jira_issue": {
"result": {
"issue_id": "string",
"issue_key": "string",
"issue_url": "string",
"project_key": "string"
},
"status": "COMPLETED"
},
"key": "CASEM-4523",
"modified_at": "2019-09-19T10:00:00.000Z",
"priority": "NOT_DEFINED",
"service_now_ticket": {
"result": {
"sys_target_link": "string"
},
"status": "COMPLETED"
},
"status": "OPEN",
"title": "Memory leak investigation on API",
"type": "STANDARD"
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"assignee": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"created_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"modified_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"project": {
"data": {
"id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
"type": "project"
}
}
},
"type": "case"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Archive case returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
# there is a valid "case" in the system
CASE_ID = ENV["CASE_ID"]
body = DatadogAPIClient::V2::CaseEmptyRequest.new({
data: DatadogAPIClient::V2::CaseEmpty.new({
type: DatadogAPIClient::V2::CaseResourceType::CASE,
}),
})
p api_instance.archive_case(CASE_ID, body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
POST https://api.ap1.datadoghq.com/api/v2/cases/{case_id}/unarchivehttps://api.datadoghq.eu/api/v2/cases/{case_id}/unarchivehttps://api.ddog-gov.com/api/v2/cases/{case_id}/unarchivehttps://api.datadoghq.com/api/v2/cases/{case_id}/unarchivehttps://api.us3.datadoghq.com/api/v2/cases/{case_id}/unarchivehttps://api.us5.datadoghq.com/api/v2/cases/{case_id}/unarchive
Unarchive case
OAuth apps require the cases_write
authorization scope to access this endpoint.
이름
유형
설명
case_id [required]
string
Case’s UUID or key
Unarchive case payload
항목
유형
설명
data [required]
object
Case empty request data
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"type": "case"
}
}
OK
Case response
항목
유형
설명
data
object
A case
attributes [required]
object
Case attributes
archived_at
date-time
Timestamp of when the case was archived
closed_at
date-time
Timestamp of when the case was closed
created_at
date-time
Timestamp of when the case was created
description
string
Description
jira_issue
object
Jira issue attached to case
result
object
Jira issue information
issue_id
string
Jira issue ID
issue_key
string
Jira issue key
issue_url
string
Jira issue URL
project_key
string
Jira project key
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
string
Key
modified_at
date-time
Timestamp of when the case was last modified
priority
enum
Case priority
Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
object
ServiceNow ticket attached to case
result
object
ServiceNow ticket information
sys_target_link
string
Link to the Incident created on ServiceNow
status
enum
Case status
Allowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
enum
Case status
Allowed enum values: OPEN,IN_PROGRESS,CLOSED
title
string
Title
type
enum
Case type
Allowed enum values: STANDARD
id [required]
string
Case's identifier
relationships
object
Resources related to a case
assignee
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
created_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
modified_by
object
Relationship to user.
data [required]
object
Relationship to user object.
id [required]
string
A unique identifier that represents the user.
type [required]
enum
User resource type.
Allowed enum values: user
default: user
project
object
Relationship to project
data [required]
object
Relationship to project object
id [required]
string
A unique identifier that represents the project
type [required]
enum
Project resource type
Allowed enum values: project
default: project
type [required]
enum
Case resource type
Allowed enum values: case
default: case
{
"data": {
"attributes": {
"archived_at": "2019-09-19T10:00:00.000Z",
"closed_at": "2019-09-19T10:00:00.000Z",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"jira_issue": {
"result": {
"issue_id": "string",
"issue_key": "string",
"issue_url": "string",
"project_key": "string"
},
"status": "COMPLETED"
},
"key": "CASEM-4523",
"modified_at": "2019-09-19T10:00:00.000Z",
"priority": "NOT_DEFINED",
"service_now_ticket": {
"result": {
"sys_target_link": "string"
},
"status": "COMPLETED"
},
"status": "OPEN",
"title": "Memory leak investigation on API",
"type": "STANDARD"
},
"id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
"relationships": {
"assignee": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"created_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"modified_by": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
},
"project": {
"data": {
"id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
"type": "project"
}
}
},
"type": "case"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Unarchive case returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new
# there is a valid "case" in the system
CASE_ID = ENV["CASE_ID"]
body = DatadogAPIClient::V2::CaseEmptyRequest.new({
data: DatadogAPIClient::V2::CaseEmpty.new({
type: DatadogAPIClient::V2::CaseResourceType::CASE,
}),
})
p api_instance.unarchive_case(CASE_ID, body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"