Skip to content

Commit 7aefd7c

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Document case management attributes endpoints (#2552)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent b92660b commit 7aefd7c

File tree

64 files changed

+1069
-266
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+1069
-266
lines changed

.generated-info

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"spec_repo_commit": "dcf594e",
3-
"generated": "2025-07-31 09:56:45.381"
2+
"spec_repo_commit": "b75095c",
3+
"generated": "2025-07-31 10:47:08.455"
44
}

.generator/schemas/v2/openapi.yaml

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6891,14 +6891,16 @@ components:
68916891
- data
68926892
type: object
68936893
CaseAttributes:
6894-
description: Case attributes
6894+
description: Case resource attributes
68956895
properties:
68966896
archived_at:
68976897
description: Timestamp of when the case was archived
68986898
format: date-time
68996899
nullable: true
69006900
readOnly: true
69016901
type: string
6902+
attributes:
6903+
$ref: '#/components/schemas/CaseObjectAttributes'
69026904
closed_at:
69036905
description: Timestamp of when the case was closed
69046906
format: date-time
@@ -7003,6 +7005,13 @@ components:
70037005
required:
70047006
- data
70057007
type: object
7008+
CaseObjectAttributes:
7009+
additionalProperties:
7010+
items:
7011+
type: string
7012+
type: array
7013+
description: The definition of `CaseObjectAttributes` object.
7014+
type: object
70067015
CasePriority:
70077016
default: NOT_DEFINED
70087017
description: Case priority
@@ -7098,6 +7107,33 @@ components:
70987107
type: string
70997108
x-enum-varnames:
71007109
- STANDARD
7110+
CaseUpdateAttributes:
7111+
description: Case update attributes
7112+
properties:
7113+
attributes:
7114+
$ref: '#/components/schemas/CaseUpdateAttributesAttributes'
7115+
type:
7116+
$ref: '#/components/schemas/CaseResourceType'
7117+
required:
7118+
- attributes
7119+
- type
7120+
type: object
7121+
CaseUpdateAttributesAttributes:
7122+
description: Case update attributes attributes
7123+
properties:
7124+
attributes:
7125+
$ref: '#/components/schemas/CaseObjectAttributes'
7126+
required:
7127+
- attributes
7128+
type: object
7129+
CaseUpdateAttributesRequest:
7130+
description: Case update attributes request
7131+
properties:
7132+
data:
7133+
$ref: '#/components/schemas/CaseUpdateAttributes'
7134+
required:
7135+
- data
7136+
type: object
71017137
CaseUpdatePriority:
71027138
description: Case priority status
71037139
properties:
@@ -45579,6 +45615,44 @@ paths:
4557945615
summary: Assign case
4558045616
tags:
4558145617
- Case Management
45618+
/api/v2/cases/{case_id}/attributes:
45619+
post:
45620+
description: Update case attributes
45621+
operationId: UpdateAttributes
45622+
parameters:
45623+
- $ref: '#/components/parameters/CaseIDPathParameter'
45624+
requestBody:
45625+
content:
45626+
application/json:
45627+
schema:
45628+
$ref: '#/components/schemas/CaseUpdateAttributesRequest'
45629+
description: Case attributes update payload
45630+
required: true
45631+
responses:
45632+
'200':
45633+
content:
45634+
application/json:
45635+
schema:
45636+
$ref: '#/components/schemas/CaseResponse'
45637+
description: OK
45638+
'400':
45639+
$ref: '#/components/responses/BadRequestResponse'
45640+
'401':
45641+
$ref: '#/components/responses/UnauthorizedResponse'
45642+
'403':
45643+
$ref: '#/components/responses/ForbiddenResponse'
45644+
'404':
45645+
$ref: '#/components/responses/NotFoundResponse'
45646+
'429':
45647+
$ref: '#/components/responses/TooManyRequestsResponse'
45648+
security:
45649+
- apiKeyAuth: []
45650+
appKeyAuth: []
45651+
- AuthZ:
45652+
- cases_write
45653+
summary: Update case attributes
45654+
tags:
45655+
- Case Management
4558245656
/api/v2/cases/{case_id}/priority:
4558345657
post:
4558445658
description: Update case priority
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2024-02-14T18:55:15.159Z"
1+
"2025-07-21T13:52:40.919Z"

cassettes/v2/Case-Management_2486725080/Archive-case-returns-Bad-Request-response_3307115673/recording.har

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@
3838
"url": "https://api.datadoghq.com/api/v2/cases"
3939
},
4040
"response": {
41-
"bodySize": 702,
41+
"bodySize": 838,
4242
"content": {
4343
"mimeType": "application/vnd.api+json",
44-
"size": 702,
45-
"text": "{\"data\":{\"id\":\"4e49aede-4c04-42d3-b5bc-f8eb4c1340df\",\"type\":\"case\",\"attributes\":{\"attributes\":{},\"created_at\":\"2024-02-14T18:55:15.280494299Z\",\"creation_source\":\"MANUAL\",\"description\":\"\",\"insights\":[],\"internal_id\":\"4e49aede-4c04-42d3-b5bc-f8eb4c1340df\",\"key\":\"DDFC-182\",\"priority\":\"P4\",\"public_id\":\"242\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"\"}}]}"
44+
"size": 838,
45+
"text": "{\"data\":{\"id\":\"6706fe66-cabd-4b22-b4c5-dd478bba421a\",\"type\":\"case\",\"attributes\":{\"attributes\":{},\"comment_count\":0,\"created_at\":\"2025-07-21T13:52:41.25066Z\",\"creation_source\":\"MANUAL\",\"custom_attributes\":{},\"description\":\"\",\"insights\":[],\"internal_id\":\"6706fe66-cabd-4b22-b4c5-dd478bba421a\",\"key\":\"DDFC-72317\",\"merge_status\":\"NOT_MERGED\",\"priority\":\"P4\",\"public_id\":\"72377\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\",\"type_id\":\"00000000-0000-0000-0000-000000000001\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"active\":true,\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"frog\"}}]}"
4646
},
4747
"cookies": [],
4848
"headers": [
@@ -51,17 +51,17 @@
5151
"value": "application/vnd.api+json"
5252
}
5353
],
54-
"headersSize": 640,
54+
"headersSize": 663,
5555
"httpVersion": "HTTP/1.1",
5656
"redirectURL": "",
5757
"status": 201,
5858
"statusText": "Created"
5959
},
60-
"startedDateTime": "2024-02-14T18:55:15.167Z",
61-
"time": 122
60+
"startedDateTime": "2025-07-21T13:52:40.926Z",
61+
"time": 397
6262
},
6363
{
64-
"_id": "36abb6ee469d97245458bc30d5a98423",
64+
"_id": "75643134d0d3233903bf06a1fd35338d",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
@@ -88,7 +88,7 @@
8888
"text": "{\"data\":{\"type\":\"project\"}}"
8989
},
9090
"queryString": [],
91-
"url": "https://api.datadoghq.com/api/v2/cases/4e49aede-4c04-42d3-b5bc-f8eb4c1340df/archive"
91+
"url": "https://api.datadoghq.com/api/v2/cases/6706fe66-cabd-4b22-b4c5-dd478bba421a/archive"
9292
},
9393
"response": {
9494
"bodySize": 108,
@@ -104,14 +104,14 @@
104104
"value": "application/vnd.api+json"
105105
}
106106
],
107-
"headersSize": 641,
107+
"headersSize": 664,
108108
"httpVersion": "HTTP/1.1",
109109
"redirectURL": "",
110110
"status": 400,
111111
"statusText": "Bad Request"
112112
},
113-
"startedDateTime": "2024-02-14T18:55:15.299Z",
114-
"time": 69
113+
"startedDateTime": "2025-07-21T13:52:41.332Z",
114+
"time": 372
115115
}
116116
],
117117
"pages": [],
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2024-02-14T18:55:15.378Z"
1+
"2025-07-21T13:52:41.730Z"

cassettes/v2/Case-Management_2486725080/Archive-case-returns-Not-Found-response_3250820290/recording.har

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,14 @@
5151
"value": "application/vnd.api+json"
5252
}
5353
],
54-
"headersSize": 640,
54+
"headersSize": 663,
5555
"httpVersion": "HTTP/1.1",
5656
"redirectURL": "",
5757
"status": 404,
5858
"statusText": "Not Found"
5959
},
60-
"startedDateTime": "2024-02-14T18:55:15.381Z",
61-
"time": 78
60+
"startedDateTime": "2025-07-21T13:52:41.735Z",
61+
"time": 392
6262
}
6363
],
6464
"pages": [],
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2024-02-14T18:55:15.466Z"
1+
"2025-07-21T13:52:42.155Z"

cassettes/v2/Case-Management_2486725080/Archive-case-returns-OK-response_1644289173/recording.har

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@
3838
"url": "https://api.datadoghq.com/api/v2/cases"
3939
},
4040
"response": {
41-
"bodySize": 702,
41+
"bodySize": 838,
4242
"content": {
4343
"mimeType": "application/vnd.api+json",
44-
"size": 702,
45-
"text": "{\"data\":{\"id\":\"3752309b-6a77-4015-845a-02ff88647b4b\",\"type\":\"case\",\"attributes\":{\"attributes\":{},\"created_at\":\"2024-02-14T18:55:15.546103234Z\",\"creation_source\":\"MANUAL\",\"description\":\"\",\"insights\":[],\"internal_id\":\"3752309b-6a77-4015-845a-02ff88647b4b\",\"key\":\"DDFC-183\",\"priority\":\"P4\",\"public_id\":\"243\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"\"}}]}"
44+
"size": 838,
45+
"text": "{\"data\":{\"id\":\"b074b409-24f8-42ae-b545-b1486429630d\",\"type\":\"case\",\"attributes\":{\"attributes\":{},\"comment_count\":0,\"created_at\":\"2025-07-21T13:52:42.51392Z\",\"creation_source\":\"MANUAL\",\"custom_attributes\":{},\"description\":\"\",\"insights\":[],\"internal_id\":\"b074b409-24f8-42ae-b545-b1486429630d\",\"key\":\"DDFC-72318\",\"merge_status\":\"NOT_MERGED\",\"priority\":\"P4\",\"public_id\":\"72378\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\",\"type_id\":\"00000000-0000-0000-0000-000000000001\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"active\":true,\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"frog\"}}]}"
4646
},
4747
"cookies": [],
4848
"headers": [
@@ -51,17 +51,17 @@
5151
"value": "application/vnd.api+json"
5252
}
5353
],
54-
"headersSize": 640,
54+
"headersSize": 663,
5555
"httpVersion": "HTTP/1.1",
5656
"redirectURL": "",
5757
"status": 201,
5858
"statusText": "Created"
5959
},
60-
"startedDateTime": "2024-02-14T18:55:15.469Z",
61-
"time": 87
60+
"startedDateTime": "2025-07-21T13:52:42.177Z",
61+
"time": 412
6262
},
6363
{
64-
"_id": "1aa9fcd53f894d7a8c83a911899fa23a",
64+
"_id": "f102e9889a3b0592a1d5f6e9c4d2deb8",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
@@ -88,14 +88,14 @@
8888
"text": "{\"data\":{\"type\":\"case\"}}"
8989
},
9090
"queryString": [],
91-
"url": "https://api.datadoghq.com/api/v2/cases/3752309b-6a77-4015-845a-02ff88647b4b/archive"
91+
"url": "https://api.datadoghq.com/api/v2/cases/b074b409-24f8-42ae-b545-b1486429630d/archive"
9292
},
9393
"response": {
94-
"bodySize": 829,
94+
"bodySize": 1012,
9595
"content": {
9696
"mimeType": "application/vnd.api+json",
97-
"size": 829,
98-
"text": "{\"data\":{\"id\":\"3752309b-6a77-4015-845a-02ff88647b4b\",\"type\":\"case\",\"attributes\":{\"archived_at\":\"2024-02-14T18:55:15.641594121Z\",\"attributes\":{},\"created_at\":\"2024-02-14T18:55:15.546103Z\",\"creation_source\":\"MANUAL\",\"description\":\"\",\"insights\":[],\"internal_id\":\"3752309b-6a77-4015-845a-02ff88647b4b\",\"key\":\"DDFC-183\",\"priority\":\"P4\",\"public_id\":\"243\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"modified_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"\"}}]}"
97+
"size": 1012,
98+
"text": "{\"data\":{\"id\":\"b074b409-24f8-42ae-b545-b1486429630d\",\"type\":\"case\",\"attributes\":{\"archived_at\":\"2025-07-21T13:52:42.933945716Z\",\"attributes\":{},\"comment_count\":0,\"created_at\":\"2025-07-21T13:52:42.51392Z\",\"creation_source\":\"MANUAL\",\"custom_attributes\":{},\"description\":\"\",\"insights\":[],\"internal_id\":\"b074b409-24f8-42ae-b545-b1486429630d\",\"key\":\"DDFC-72318\",\"merge_status\":\"NOT_MERGED\",\"modified_at\":\"2025-07-21T13:52:42.933946Z\",\"priority\":\"P4\",\"public_id\":\"72378\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\",\"type_id\":\"00000000-0000-0000-0000-000000000001\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"modified_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"active\":true,\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"frog\"}}]}"
9999
},
100100
"cookies": [],
101101
"headers": [
@@ -104,14 +104,14 @@
104104
"value": "application/vnd.api+json"
105105
}
106106
],
107-
"headersSize": 641,
107+
"headersSize": 665,
108108
"httpVersion": "HTTP/1.1",
109109
"redirectURL": "",
110110
"status": 200,
111111
"statusText": "OK"
112112
},
113-
"startedDateTime": "2024-02-14T18:55:15.563Z",
114-
"time": 79
113+
"startedDateTime": "2025-07-21T13:52:42.597Z",
114+
"time": 412
115115
}
116116
],
117117
"pages": [],
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2024-02-14T18:55:15.651Z"
1+
"2025-07-21T13:52:43.015Z"

cassettes/v2/Case-Management_2486725080/Assign-case-returns-Bad-Request-response_1562814608/recording.har

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@
3838
"url": "https://api.datadoghq.com/api/v2/cases"
3939
},
4040
"response": {
41-
"bodySize": 702,
41+
"bodySize": 839,
4242
"content": {
4343
"mimeType": "application/vnd.api+json",
44-
"size": 702,
45-
"text": "{\"data\":{\"id\":\"cf2e3b59-d504-4714-9853-38e4ceddb858\",\"type\":\"case\",\"attributes\":{\"attributes\":{},\"created_at\":\"2024-02-14T18:55:15.728783622Z\",\"creation_source\":\"MANUAL\",\"description\":\"\",\"insights\":[],\"internal_id\":\"cf2e3b59-d504-4714-9853-38e4ceddb858\",\"key\":\"DDFC-184\",\"priority\":\"P4\",\"public_id\":\"244\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"\"}}]}"
44+
"size": 839,
45+
"text": "{\"data\":{\"id\":\"510b0121-1477-43c0-8986-78f011016d48\",\"type\":\"case\",\"attributes\":{\"attributes\":{},\"comment_count\":0,\"created_at\":\"2025-07-21T13:52:43.335245Z\",\"creation_source\":\"MANUAL\",\"custom_attributes\":{},\"description\":\"\",\"insights\":[],\"internal_id\":\"510b0121-1477-43c0-8986-78f011016d48\",\"key\":\"DDFC-72319\",\"merge_status\":\"NOT_MERGED\",\"priority\":\"P4\",\"public_id\":\"72379\",\"status\":\"OPEN\",\"title\":\"My new case\",\"type\":\"STANDARD\",\"type_id\":\"00000000-0000-0000-0000-000000000001\"},\"relationships\":{\"created_by\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\"}},\"project\":{\"data\":{\"id\":\"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\"type\":\"project\"}}}},\"included\":[{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"user\",\"attributes\":{\"active\":true,\"email\":\"[email protected]\",\"handle\":\"[email protected]\",\"name\":\"frog\"}}]}"
4646
},
4747
"cookies": [],
4848
"headers": [
@@ -51,17 +51,17 @@
5151
"value": "application/vnd.api+json"
5252
}
5353
],
54-
"headersSize": 640,
54+
"headersSize": 663,
5555
"httpVersion": "HTTP/1.1",
5656
"redirectURL": "",
5757
"status": 201,
5858
"statusText": "Created"
5959
},
60-
"startedDateTime": "2024-02-14T18:55:15.655Z",
61-
"time": 81
60+
"startedDateTime": "2025-07-21T13:52:43.017Z",
61+
"time": 384
6262
},
6363
{
64-
"_id": "ca5f66cb321f82c3eca16ff6645a4670",
64+
"_id": "389b3a16ce3121bf75a0da30a1d8d867",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
@@ -88,14 +88,14 @@
8888
"text": "{\"data\":{\"attributes\":{\"assignee_id\":\"invalid-uuid\"},\"type\":\"case\"}}"
8989
},
9090
"queryString": [],
91-
"url": "https://api.datadoghq.com/api/v2/cases/cf2e3b59-d504-4714-9853-38e4ceddb858/assign"
91+
"url": "https://api.datadoghq.com/api/v2/cases/510b0121-1477-43c0-8986-78f011016d48/assign"
9292
},
9393
"response": {
94-
"bodySize": 166,
94+
"bodySize": 51,
9595
"content": {
9696
"mimeType": "application/vnd.api+json",
97-
"size": 166,
98-
"text": "{\"errors\":[{\"code\":\"invalid_command\",\"title\":\"error when validating input command: 'assigneeid' field must be an uuid\",\"meta\":{\"entity\":\"assigneeid\",\"rule\":\"uuid\"}}]}"
97+
"size": 51,
98+
"text": "{\"errors\":[{\"status\":\"400\",\"title\":\"Bad Request\"}]}"
9999
},
100100
"cookies": [],
101101
"headers": [
@@ -104,14 +104,14 @@
104104
"value": "application/vnd.api+json"
105105
}
106106
],
107-
"headersSize": 641,
107+
"headersSize": 663,
108108
"httpVersion": "HTTP/1.1",
109109
"redirectURL": "",
110110
"status": 400,
111111
"statusText": "Bad Request"
112112
},
113-
"startedDateTime": "2024-02-14T18:55:15.752Z",
114-
"time": 72
113+
"startedDateTime": "2025-07-21T13:52:43.407Z",
114+
"time": 399
115115
}
116116
],
117117
"pages": [],

0 commit comments

Comments
 (0)