- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
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"
]
}
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/projects" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"key": "SEC",
"name": "Security Investigation"
},
"type": "project"
}
}
EOF
"""
Create a project returns "CREATED" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.project_create import ProjectCreate
from datadog_api_client.v2.model.project_create_attributes import ProjectCreateAttributes
from datadog_api_client.v2.model.project_create_request import ProjectCreateRequest
from datadog_api_client.v2.model.project_resource_type import ProjectResourceType
body = ProjectCreateRequest(
data=ProjectCreate(
attributes=ProjectCreateAttributes(
key="SEC",
name="Security Investigation",
),
type=ProjectResourceType.PROJECT,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.create_project(body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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"
// Create a project returns "CREATED" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
body := datadogV2.ProjectCreateRequest{
Data: datadogV2.ProjectCreate{
Attributes: datadogV2.ProjectCreateAttributes{
Key: "SEC",
Name: "Security Investigation",
},
Type: datadogV2.PROJECTRESOURCETYPE_PROJECT,
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
resp, r, err := api.CreateProject(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.CreateProject`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.CreateProject`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Create a project returns "CREATED" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.ProjectCreate;
import com.datadog.api.client.v2.model.ProjectCreateAttributes;
import com.datadog.api.client.v2.model.ProjectCreateRequest;
import com.datadog.api.client.v2.model.ProjectResourceType;
import com.datadog.api.client.v2.model.ProjectResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
ProjectCreateRequest body =
new ProjectCreateRequest()
.data(
new ProjectCreate()
.attributes(
new ProjectCreateAttributes().key("SEC").name("Security Investigation"))
.type(ProjectResourceType.PROJECT));
try {
ProjectResponse result = apiInstance.createProject(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#createProject");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
// Create a project returns "CREATED" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
use datadog_api_client::datadogV2::model::ProjectCreate;
use datadog_api_client::datadogV2::model::ProjectCreateAttributes;
use datadog_api_client::datadogV2::model::ProjectCreateRequest;
use datadog_api_client::datadogV2::model::ProjectResourceType;
#[tokio::main]
async fn main() {
let body = ProjectCreateRequest::new(ProjectCreate::new(
ProjectCreateAttributes::new("SEC".to_string(), "Security Investigation".to_string()),
ProjectResourceType::PROJECT,
));
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.create_project(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Create a project returns "CREATED" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
const params: v2.CaseManagementApiCreateProjectRequest = {
body: {
data: {
attributes: {
key: "SEC",
name: "Security Investigation",
},
type: "project",
},
},
};
apiInstance
.createProject(params)
.then((data: v2.ProjectResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"
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"
]
}
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Search cases returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.search_cases()
print(response)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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"
// Search cases returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
use datadog_api_client::datadogV2::api_case_management::SearchCasesOptionalParams;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.search_cases(SearchCasesOptionalParams::default()).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Search cases returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
apiInstance
.searchCases()
.then((data: v2.CasesResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"
// Search cases returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
resp, r, err := api.SearchCases(ctx, *datadogV2.NewSearchCasesOptionalParameters())
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.SearchCases`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.SearchCases`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Search cases returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.CasesResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
try {
CasesResponse result = apiInstance.searchCases();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#searchCases");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
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"
]
}
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"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"
}
}
EOF
// Create a case returns "CREATED" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "user" in the system
UserDataID := os.Getenv("USER_DATA_ID")
body := datadogV2.CaseCreateRequest{
Data: datadogV2.CaseCreate{
Attributes: datadogV2.CaseCreateAttributes{
Priority: datadogV2.CASEPRIORITY_NOT_DEFINED.Ptr(),
Title: "Security breach investigation in 0cfbc5cbc676ee71",
Type: datadogV2.CASETYPE_STANDARD,
},
Relationships: &datadogV2.CaseCreateRelationships{
Assignee: *datadogV2.NewNullableNullableUserRelationship(&datadogV2.NullableUserRelationship{
Data: *datadogV2.NewNullableNullableUserRelationshipData(&datadogV2.NullableUserRelationshipData{
Id: UserDataID,
Type: datadogV2.USERRESOURCETYPE_USER,
}),
}),
Project: datadogV2.ProjectRelationship{
Data: datadogV2.ProjectRelationshipData{
Id: "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
Type: datadogV2.PROJECTRESOURCETYPE_PROJECT,
},
},
},
Type: datadogV2.CASERESOURCETYPE_CASE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
resp, r, err := api.CreateCase(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.CreateCase`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.CreateCase`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Create a case returns "CREATED" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.CaseCreate;
import com.datadog.api.client.v2.model.CaseCreateAttributes;
import com.datadog.api.client.v2.model.CaseCreateRelationships;
import com.datadog.api.client.v2.model.CaseCreateRequest;
import com.datadog.api.client.v2.model.CasePriority;
import com.datadog.api.client.v2.model.CaseResourceType;
import com.datadog.api.client.v2.model.CaseResponse;
import com.datadog.api.client.v2.model.CaseType;
import com.datadog.api.client.v2.model.NullableUserRelationship;
import com.datadog.api.client.v2.model.NullableUserRelationshipData;
import com.datadog.api.client.v2.model.ProjectRelationship;
import com.datadog.api.client.v2.model.ProjectRelationshipData;
import com.datadog.api.client.v2.model.ProjectResourceType;
import com.datadog.api.client.v2.model.UserResourceType;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
// there is a valid "user" in the system
String USER_DATA_ID = System.getenv("USER_DATA_ID");
CaseCreateRequest body =
new CaseCreateRequest()
.data(
new CaseCreate()
.attributes(
new CaseCreateAttributes()
.priority(CasePriority.NOT_DEFINED)
.title("Security breach investigation in 0cfbc5cbc676ee71")
.type(CaseType.STANDARD))
.relationships(
new CaseCreateRelationships()
.assignee(
new NullableUserRelationship()
.data(
new NullableUserRelationshipData()
.id(USER_DATA_ID)
.type(UserResourceType.USER)))
.project(
new ProjectRelationship()
.data(
new ProjectRelationshipData()
.id("d4bbe1af-f36e-42f1-87c1-493ca35c320e")
.type(ProjectResourceType.PROJECT))))
.type(CaseResourceType.CASE));
try {
CaseResponse result = apiInstance.createCase(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#createCase");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
"""
Create a case returns "CREATED" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.case_create import CaseCreate
from datadog_api_client.v2.model.case_create_attributes import CaseCreateAttributes
from datadog_api_client.v2.model.case_create_relationships import CaseCreateRelationships
from datadog_api_client.v2.model.case_create_request import CaseCreateRequest
from datadog_api_client.v2.model.case_priority import CasePriority
from datadog_api_client.v2.model.case_resource_type import CaseResourceType
from datadog_api_client.v2.model.case_type import CaseType
from datadog_api_client.v2.model.nullable_user_relationship import NullableUserRelationship
from datadog_api_client.v2.model.nullable_user_relationship_data import NullableUserRelationshipData
from datadog_api_client.v2.model.project_relationship import ProjectRelationship
from datadog_api_client.v2.model.project_relationship_data import ProjectRelationshipData
from datadog_api_client.v2.model.project_resource_type import ProjectResourceType
from datadog_api_client.v2.model.user_resource_type import UserResourceType
# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]
body = CaseCreateRequest(
data=CaseCreate(
attributes=CaseCreateAttributes(
priority=CasePriority.NOT_DEFINED,
title="Security breach investigation in 0cfbc5cbc676ee71",
type=CaseType.STANDARD,
),
relationships=CaseCreateRelationships(
assignee=NullableUserRelationship(
data=NullableUserRelationshipData(
id=USER_DATA_ID,
type=UserResourceType.USER,
),
),
project=ProjectRelationship(
data=ProjectRelationshipData(
id="d4bbe1af-f36e-42f1-87c1-493ca35c320e",
type=ProjectResourceType.PROJECT,
),
),
),
type=CaseResourceType.CASE,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.create_case(body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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"
// Create a case returns "CREATED" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
use datadog_api_client::datadogV2::model::CaseCreate;
use datadog_api_client::datadogV2::model::CaseCreateAttributes;
use datadog_api_client::datadogV2::model::CaseCreateRelationships;
use datadog_api_client::datadogV2::model::CaseCreateRequest;
use datadog_api_client::datadogV2::model::CasePriority;
use datadog_api_client::datadogV2::model::CaseResourceType;
use datadog_api_client::datadogV2::model::CaseType;
use datadog_api_client::datadogV2::model::NullableUserRelationship;
use datadog_api_client::datadogV2::model::NullableUserRelationshipData;
use datadog_api_client::datadogV2::model::ProjectRelationship;
use datadog_api_client::datadogV2::model::ProjectRelationshipData;
use datadog_api_client::datadogV2::model::ProjectResourceType;
use datadog_api_client::datadogV2::model::UserResourceType;
#[tokio::main]
async fn main() {
// there is a valid "user" in the system
let user_data_id = std::env::var("USER_DATA_ID").unwrap();
let body = CaseCreateRequest::new(
CaseCreate::new(
CaseCreateAttributes::new(
"Security breach investigation in 0cfbc5cbc676ee71".to_string(),
CaseType::STANDARD,
)
.priority(CasePriority::NOT_DEFINED),
CaseResourceType::CASE,
)
.relationships(
CaseCreateRelationships::new(ProjectRelationship::new(ProjectRelationshipData::new(
"d4bbe1af-f36e-42f1-87c1-493ca35c320e".to_string(),
ProjectResourceType::PROJECT,
)))
.assignee(Some(NullableUserRelationship::new(Some(
NullableUserRelationshipData::new(user_data_id.clone(), UserResourceType::USER),
)))),
),
);
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.create_case(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Create a case returns "CREATED" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
// there is a valid "user" in the system
const USER_DATA_ID = process.env.USER_DATA_ID as string;
const params: v2.CaseManagementApiCreateCaseRequest = {
body: {
data: {
attributes: {
priority: "NOT_DEFINED",
title: "Security breach investigation in 0cfbc5cbc676ee71",
type: "STANDARD",
},
relationships: {
assignee: {
data: {
id: USER_DATA_ID,
type: "user",
},
},
project: {
data: {
id: "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
type: "project",
},
},
},
type: "case",
},
},
};
apiInstance
.createCase(params)
.then((data: v2.CaseResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"
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"
]
}
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/projects" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get all projects returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.get_projects()
print(response)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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 all projects returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
resp, r, err := api.GetProjects(ctx)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.GetProjects`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.GetProjects`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Get all projects returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.ProjectsResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
try {
ProjectsResponse result = apiInstance.getProjects();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#getProjects");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
// Get all projects returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.get_projects().await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Get all projects returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
apiInstance
.getProjects()
.then((data: v2.ProjectsResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"
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"
]
}
# Path parameters
export case_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/${case_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get the details of a case returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
# there is a valid "case" in the system
CASE_ID = environ["CASE_ID"]
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.get_case(
case_id=CASE_ID,
)
print(response)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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 the details of a case returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "case" in the system
CaseID := os.Getenv("CASE_ID")
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
resp, r, err := api.GetCase(ctx, CaseID)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.GetCase`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.GetCase`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Get the details of a case returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.CaseResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
// there is a valid "case" in the system
String CASE_ID = System.getenv("CASE_ID");
try {
CaseResponse result = apiInstance.getCase(CASE_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#getCase");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
// Get the details of a case returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
#[tokio::main]
async fn main() {
// there is a valid "case" in the system
let case_id = std::env::var("CASE_ID").unwrap();
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.get_case(case_id.clone()).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Get the details of a case returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
// there is a valid "case" in the system
const CASE_ID = process.env.CASE_ID as string;
const params: v2.CaseManagementApiGetCaseRequest = {
caseId: CASE_ID,
};
apiInstance
.getCase(params)
.then((data: v2.CaseResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"
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"
]
}
# Path parameters
export project_id="e555e290-ed65-49bd-ae18-8acbfcf18db7"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/projects/${project_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get the details of a project returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.get_project(
project_id="project_id",
)
print(response)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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"
// Get the details of a project returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
resp, r, err := api.GetProject(ctx, "project_id")
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.GetProject`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.GetProject`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Get the details of a project returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.ProjectResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
try {
ProjectResponse result = apiInstance.getProject("project_id");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#getProject");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
// Get the details of a project returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.get_project("project_id".to_string()).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Get the details of a project returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
const params: v2.CaseManagementApiGetProjectRequest = {
projectId: "project_id",
};
apiInstance
.getProject(params)
.then((data: v2.ProjectResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"
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"
]
}
# Path parameters
export project_id="e555e290-ed65-49bd-ae18-8acbfcf18db7"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/projects/${project_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Remove a project returns "No Content" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
api_instance.delete_project(
project_id="project_id",
)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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"
// Remove a project returns "No Content" response
package main
import (
"context"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
r, err := api.DeleteProject(ctx, "project_id")
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.DeleteProject`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Remove a project returns "No Content" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
try {
apiInstance.deleteProject("project_id");
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#deleteProject");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
// Remove a project returns "No Content" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.delete_project("project_id".to_string()).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Remove a project returns "No Content" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
const params: v2.CaseManagementApiDeleteProjectRequest = {
projectId: "project_id",
};
apiInstance
.deleteProject(params)
.then((data: any) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"
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"
]
}
# Path parameters
export case_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/${case_id}/status" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"status": "IN_PROGRESS"
},
"type": "case"
}
}
EOF
// Update case status returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "case" in the system
CaseID := os.Getenv("CASE_ID")
body := datadogV2.CaseUpdateStatusRequest{
Data: datadogV2.CaseUpdateStatus{
Attributes: datadogV2.CaseUpdateStatusAttributes{
Status: datadogV2.CASESTATUS_IN_PROGRESS,
},
Type: datadogV2.CASERESOURCETYPE_CASE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
resp, r, err := api.UpdateStatus(ctx, CaseID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.UpdateStatus`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.UpdateStatus`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Update case status returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.CaseResourceType;
import com.datadog.api.client.v2.model.CaseResponse;
import com.datadog.api.client.v2.model.CaseStatus;
import com.datadog.api.client.v2.model.CaseUpdateStatus;
import com.datadog.api.client.v2.model.CaseUpdateStatusAttributes;
import com.datadog.api.client.v2.model.CaseUpdateStatusRequest;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
// there is a valid "case" in the system
String CASE_ID = System.getenv("CASE_ID");
CaseUpdateStatusRequest body =
new CaseUpdateStatusRequest()
.data(
new CaseUpdateStatus()
.attributes(new CaseUpdateStatusAttributes().status(CaseStatus.IN_PROGRESS))
.type(CaseResourceType.CASE));
try {
CaseResponse result = apiInstance.updateStatus(CASE_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#updateStatus");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
"""
Update case status returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.case_resource_type import CaseResourceType
from datadog_api_client.v2.model.case_status import CaseStatus
from datadog_api_client.v2.model.case_update_status import CaseUpdateStatus
from datadog_api_client.v2.model.case_update_status_attributes import CaseUpdateStatusAttributes
from datadog_api_client.v2.model.case_update_status_request import CaseUpdateStatusRequest
# there is a valid "case" in the system
CASE_ID = environ["CASE_ID"]
body = CaseUpdateStatusRequest(
data=CaseUpdateStatus(
attributes=CaseUpdateStatusAttributes(
status=CaseStatus.IN_PROGRESS,
),
type=CaseResourceType.CASE,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.update_status(case_id=CASE_ID, body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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"
// Update case status returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
use datadog_api_client::datadogV2::model::CaseResourceType;
use datadog_api_client::datadogV2::model::CaseStatus;
use datadog_api_client::datadogV2::model::CaseUpdateStatus;
use datadog_api_client::datadogV2::model::CaseUpdateStatusAttributes;
use datadog_api_client::datadogV2::model::CaseUpdateStatusRequest;
#[tokio::main]
async fn main() {
// there is a valid "case" in the system
let case_id = std::env::var("CASE_ID").unwrap();
let body = CaseUpdateStatusRequest::new(CaseUpdateStatus::new(
CaseUpdateStatusAttributes::new(CaseStatus::IN_PROGRESS),
CaseResourceType::CASE,
));
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.update_status(case_id.clone(), body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Update case status returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
// there is a valid "case" in the system
const CASE_ID = process.env.CASE_ID as string;
const params: v2.CaseManagementApiUpdateStatusRequest = {
body: {
data: {
attributes: {
status: "IN_PROGRESS",
},
type: "case",
},
},
caseId: CASE_ID,
};
apiInstance
.updateStatus(params)
.then((data: v2.CaseResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"
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"
]
}
# Path parameters
export case_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/${case_id}/priority" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"priority": "P3"
},
"type": "case"
}
}
EOF
// Update case priority returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "case" in the system
CaseID := os.Getenv("CASE_ID")
body := datadogV2.CaseUpdatePriorityRequest{
Data: datadogV2.CaseUpdatePriority{
Attributes: datadogV2.CaseUpdatePriorityAttributes{
Priority: datadogV2.CASEPRIORITY_P3,
},
Type: datadogV2.CASERESOURCETYPE_CASE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
resp, r, err := api.UpdatePriority(ctx, CaseID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.UpdatePriority`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.UpdatePriority`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Update case priority returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.CasePriority;
import com.datadog.api.client.v2.model.CaseResourceType;
import com.datadog.api.client.v2.model.CaseResponse;
import com.datadog.api.client.v2.model.CaseUpdatePriority;
import com.datadog.api.client.v2.model.CaseUpdatePriorityAttributes;
import com.datadog.api.client.v2.model.CaseUpdatePriorityRequest;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
// there is a valid "case" in the system
String CASE_ID = System.getenv("CASE_ID");
CaseUpdatePriorityRequest body =
new CaseUpdatePriorityRequest()
.data(
new CaseUpdatePriority()
.attributes(new CaseUpdatePriorityAttributes().priority(CasePriority.P3))
.type(CaseResourceType.CASE));
try {
CaseResponse result = apiInstance.updatePriority(CASE_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#updatePriority");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
"""
Update case priority returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.case_priority import CasePriority
from datadog_api_client.v2.model.case_resource_type import CaseResourceType
from datadog_api_client.v2.model.case_update_priority import CaseUpdatePriority
from datadog_api_client.v2.model.case_update_priority_attributes import CaseUpdatePriorityAttributes
from datadog_api_client.v2.model.case_update_priority_request import CaseUpdatePriorityRequest
# there is a valid "case" in the system
CASE_ID = environ["CASE_ID"]
body = CaseUpdatePriorityRequest(
data=CaseUpdatePriority(
attributes=CaseUpdatePriorityAttributes(
priority=CasePriority.P3,
),
type=CaseResourceType.CASE,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.update_priority(case_id=CASE_ID, body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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"
// Update case priority returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
use datadog_api_client::datadogV2::model::CasePriority;
use datadog_api_client::datadogV2::model::CaseResourceType;
use datadog_api_client::datadogV2::model::CaseUpdatePriority;
use datadog_api_client::datadogV2::model::CaseUpdatePriorityAttributes;
use datadog_api_client::datadogV2::model::CaseUpdatePriorityRequest;
#[tokio::main]
async fn main() {
// there is a valid "case" in the system
let case_id = std::env::var("CASE_ID").unwrap();
let body = CaseUpdatePriorityRequest::new(CaseUpdatePriority::new(
CaseUpdatePriorityAttributes::new(CasePriority::P3),
CaseResourceType::CASE,
));
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.update_priority(case_id.clone(), body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Update case priority returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
// there is a valid "case" in the system
const CASE_ID = process.env.CASE_ID as string;
const params: v2.CaseManagementApiUpdatePriorityRequest = {
body: {
data: {
attributes: {
priority: "P3",
},
type: "case",
},
},
caseId: CASE_ID,
};
apiInstance
.updatePriority(params)
.then((data: v2.CaseResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"
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"
]
}
# Path parameters
export case_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/${case_id}/assign" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"assignee_id": "string"
},
"type": "case"
}
}
EOF
// Assign case returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "case" in the system
CaseID := os.Getenv("CASE_ID")
// there is a valid "user" in the system
UserDataID := os.Getenv("USER_DATA_ID")
body := datadogV2.CaseAssignRequest{
Data: datadogV2.CaseAssign{
Attributes: datadogV2.CaseAssignAttributes{
AssigneeId: UserDataID,
},
Type: datadogV2.CASERESOURCETYPE_CASE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
resp, r, err := api.AssignCase(ctx, CaseID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.AssignCase`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.AssignCase`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Assign case returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.CaseAssign;
import com.datadog.api.client.v2.model.CaseAssignAttributes;
import com.datadog.api.client.v2.model.CaseAssignRequest;
import com.datadog.api.client.v2.model.CaseResourceType;
import com.datadog.api.client.v2.model.CaseResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
// there is a valid "case" in the system
String CASE_ID = System.getenv("CASE_ID");
// there is a valid "user" in the system
String USER_DATA_ID = System.getenv("USER_DATA_ID");
CaseAssignRequest body =
new CaseAssignRequest()
.data(
new CaseAssign()
.attributes(new CaseAssignAttributes().assigneeId(USER_DATA_ID))
.type(CaseResourceType.CASE));
try {
CaseResponse result = apiInstance.assignCase(CASE_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#assignCase");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
"""
Assign case returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.case_assign import CaseAssign
from datadog_api_client.v2.model.case_assign_attributes import CaseAssignAttributes
from datadog_api_client.v2.model.case_assign_request import CaseAssignRequest
from datadog_api_client.v2.model.case_resource_type import CaseResourceType
# there is a valid "case" in the system
CASE_ID = environ["CASE_ID"]
# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]
body = CaseAssignRequest(
data=CaseAssign(
attributes=CaseAssignAttributes(
assignee_id=USER_DATA_ID,
),
type=CaseResourceType.CASE,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.assign_case(case_id=CASE_ID, body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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"
// Assign case returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
use datadog_api_client::datadogV2::model::CaseAssign;
use datadog_api_client::datadogV2::model::CaseAssignAttributes;
use datadog_api_client::datadogV2::model::CaseAssignRequest;
use datadog_api_client::datadogV2::model::CaseResourceType;
#[tokio::main]
async fn main() {
// there is a valid "case" in the system
let case_id = std::env::var("CASE_ID").unwrap();
// there is a valid "user" in the system
let user_data_id = std::env::var("USER_DATA_ID").unwrap();
let body = CaseAssignRequest::new(CaseAssign::new(
CaseAssignAttributes::new(user_data_id.clone()),
CaseResourceType::CASE,
));
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.assign_case(case_id.clone(), body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Assign case returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
// there is a valid "case" in the system
const CASE_ID = process.env.CASE_ID as string;
// there is a valid "user" in the system
const USER_DATA_ID = process.env.USER_DATA_ID as string;
const params: v2.CaseManagementApiAssignCaseRequest = {
body: {
data: {
attributes: {
assigneeId: USER_DATA_ID,
},
type: "case",
},
},
caseId: CASE_ID,
};
apiInstance
.assignCase(params)
.then((data: v2.CaseResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"
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"
]
}
# Path parameters
export case_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/${case_id}/unassign" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"type": "case"
}
}
EOF
// Unassign case returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "case" in the system
CaseID := os.Getenv("CASE_ID")
body := datadogV2.CaseEmptyRequest{
Data: datadogV2.CaseEmpty{
Type: datadogV2.CASERESOURCETYPE_CASE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
resp, r, err := api.UnassignCase(ctx, CaseID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.UnassignCase`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.UnassignCase`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Unassign case returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.CaseEmpty;
import com.datadog.api.client.v2.model.CaseEmptyRequest;
import com.datadog.api.client.v2.model.CaseResourceType;
import com.datadog.api.client.v2.model.CaseResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
// there is a valid "case" in the system
String CASE_ID = System.getenv("CASE_ID");
CaseEmptyRequest body =
new CaseEmptyRequest().data(new CaseEmpty().type(CaseResourceType.CASE));
try {
CaseResponse result = apiInstance.unassignCase(CASE_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#unassignCase");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
"""
Unassign case returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.case_empty import CaseEmpty
from datadog_api_client.v2.model.case_empty_request import CaseEmptyRequest
from datadog_api_client.v2.model.case_resource_type import CaseResourceType
# there is a valid "case" in the system
CASE_ID = environ["CASE_ID"]
body = CaseEmptyRequest(
data=CaseEmpty(
type=CaseResourceType.CASE,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.unassign_case(case_id=CASE_ID, body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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"
// Unassign case returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
use datadog_api_client::datadogV2::model::CaseEmpty;
use datadog_api_client::datadogV2::model::CaseEmptyRequest;
use datadog_api_client::datadogV2::model::CaseResourceType;
#[tokio::main]
async fn main() {
// there is a valid "case" in the system
let case_id = std::env::var("CASE_ID").unwrap();
let body = CaseEmptyRequest::new(CaseEmpty::new(CaseResourceType::CASE));
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.unassign_case(case_id.clone(), body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Unassign case returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
// there is a valid "case" in the system
const CASE_ID = process.env.CASE_ID as string;
const params: v2.CaseManagementApiUnassignCaseRequest = {
body: {
data: {
type: "case",
},
},
caseId: CASE_ID,
};
apiInstance
.unassignCase(params)
.then((data: v2.CaseResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"
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"
]
}
# Path parameters
export case_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/${case_id}/archive" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"type": "case"
}
}
EOF
// Archive case returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "case" in the system
CaseID := os.Getenv("CASE_ID")
body := datadogV2.CaseEmptyRequest{
Data: datadogV2.CaseEmpty{
Type: datadogV2.CASERESOURCETYPE_CASE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
resp, r, err := api.ArchiveCase(ctx, CaseID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.ArchiveCase`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.ArchiveCase`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Archive case returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.CaseEmpty;
import com.datadog.api.client.v2.model.CaseEmptyRequest;
import com.datadog.api.client.v2.model.CaseResourceType;
import com.datadog.api.client.v2.model.CaseResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
// there is a valid "case" in the system
String CASE_ID = System.getenv("CASE_ID");
CaseEmptyRequest body =
new CaseEmptyRequest().data(new CaseEmpty().type(CaseResourceType.CASE));
try {
CaseResponse result = apiInstance.archiveCase(CASE_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#archiveCase");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
"""
Archive case returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.case_empty import CaseEmpty
from datadog_api_client.v2.model.case_empty_request import CaseEmptyRequest
from datadog_api_client.v2.model.case_resource_type import CaseResourceType
# there is a valid "case" in the system
CASE_ID = environ["CASE_ID"]
body = CaseEmptyRequest(
data=CaseEmpty(
type=CaseResourceType.CASE,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.archive_case(case_id=CASE_ID, body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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"
// Archive case returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
use datadog_api_client::datadogV2::model::CaseEmpty;
use datadog_api_client::datadogV2::model::CaseEmptyRequest;
use datadog_api_client::datadogV2::model::CaseResourceType;
#[tokio::main]
async fn main() {
// there is a valid "case" in the system
let case_id = std::env::var("CASE_ID").unwrap();
let body = CaseEmptyRequest::new(CaseEmpty::new(CaseResourceType::CASE));
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.archive_case(case_id.clone(), body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Archive case returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
// there is a valid "case" in the system
const CASE_ID = process.env.CASE_ID as string;
const params: v2.CaseManagementApiArchiveCaseRequest = {
body: {
data: {
type: "case",
},
},
caseId: CASE_ID,
};
apiInstance
.archiveCase(params)
.then((data: v2.CaseResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"
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"
]
}
# Path parameters
export case_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/${case_id}/unarchive" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"type": "case"
}
}
EOF
// Unarchive case returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "case" in the system
CaseID := os.Getenv("CASE_ID")
body := datadogV2.CaseEmptyRequest{
Data: datadogV2.CaseEmpty{
Type: datadogV2.CASERESOURCETYPE_CASE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewCaseManagementApi(apiClient)
resp, r, err := api.UnarchiveCase(ctx, CaseID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.UnarchiveCase`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.UnarchiveCase`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
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>" go run "main.go"
// Unarchive case returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.CaseEmpty;
import com.datadog.api.client.v2.model.CaseEmptyRequest;
import com.datadog.api.client.v2.model.CaseResourceType;
import com.datadog.api.client.v2.model.CaseResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
// there is a valid "case" in the system
String CASE_ID = System.getenv("CASE_ID");
CaseEmptyRequest body =
new CaseEmptyRequest().data(new CaseEmpty().type(CaseResourceType.CASE));
try {
CaseResponse result = apiInstance.unarchiveCase(CASE_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CaseManagementApi#unarchiveCase");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
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>" java "Example.java"
"""
Unarchive case returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.case_empty import CaseEmpty
from datadog_api_client.v2.model.case_empty_request import CaseEmptyRequest
from datadog_api_client.v2.model.case_resource_type import CaseResourceType
# there is a valid "case" in the system
CASE_ID = environ["CASE_ID"]
body = CaseEmptyRequest(
data=CaseEmpty(
type=CaseResourceType.CASE,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CaseManagementApi(api_client)
response = api_instance.unarchive_case(case_id=CASE_ID, body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
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>" python3 "example.py"
# 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"
// Unarchive case returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
use datadog_api_client::datadogV2::model::CaseEmpty;
use datadog_api_client::datadogV2::model::CaseEmptyRequest;
use datadog_api_client::datadogV2::model::CaseResourceType;
#[tokio::main]
async fn main() {
// there is a valid "case" in the system
let case_id = std::env::var("CASE_ID").unwrap();
let body = CaseEmptyRequest::new(CaseEmpty::new(CaseResourceType::CASE));
let configuration = datadog::Configuration::new();
let api = CaseManagementAPI::with_config(configuration);
let resp = api.unarchive_case(case_id.clone(), body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
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>" cargo run
/**
* Unarchive case returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.CaseManagementApi(configuration);
// there is a valid "case" in the system
const CASE_ID = process.env.CASE_ID as string;
const params: v2.CaseManagementApiUnarchiveCaseRequest = {
body: {
data: {
type: "case",
},
},
caseId: CASE_ID,
};
apiInstance
.unarchiveCase(params)
.then((data: v2.CaseResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
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>" tsc "example.ts"