diff --git a/content/en/api/v2/case-management-attribute/examples.json b/content/en/api/v2/case-management-attribute/examples.json index cd2b0e8f5a6..0d2de89b5f6 100644 --- a/content/en/api/v2/case-management-attribute/examples.json +++ b/content/en/api/v2/case-management-attribute/examples.json @@ -18,7 +18,7 @@ } ] }, - "html": "
data
\n[object]
List of custom attribute configs of case type
attributes
\nobject
Custom attribute resource attributes
case_type_id [required]
\nstring
Custom attribute config identifier.
description
\nstring
Custom attribute description.
display_name [required]
\nstring
Custom attribute name.
is_multi [required]
\nboolean
Whether multiple values can be set
key [required]
\nstring
Custom attribute key. This will be the value use to search on this custom attribute
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
id
\nstring
Custom attribute configs identifier
type
\nenum
Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute
default: custom_attribute
data
\n[object]
List of custom attribute configs of case type
attributes
\nobject
Custom attribute resource attributes
case_type_id [required]
\nstring
Custom attribute config identifier.
description
\nstring
Custom attribute description.
display_name [required]
\nstring
Custom attribute name.
is_multi [required]
\nboolean
Whether multiple values can be set
key [required]
\nstring
Custom attribute key. This will be the value use to search on this custom attribute
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
id
\nstring
Custom attribute configs identifier
type
\nenum
Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute
default: custom_attribute
data
\n[object]
List of custom attribute configs of case type
attributes
\nobject
Custom attribute resource attributes
case_type_id [required]
\nstring
Custom attribute config identifier.
description
\nstring
Custom attribute description.
display_name [required]
\nstring
Custom attribute name.
is_multi [required]
\nboolean
Whether multiple values can be set
key [required]
\nstring
Custom attribute key. This will be the value use to search on this custom attribute
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
id
\nstring
Custom attribute configs identifier
type
\nenum
Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute
default: custom_attribute
data
\n[object]
List of custom attribute configs of case type
attributes
\nobject
Custom attribute resource attributes
case_type_id [required]
\nstring
Custom attribute config identifier.
description
\nstring
Custom attribute description.
display_name [required]
\nstring
Custom attribute name.
is_multi [required]
\nboolean
Whether multiple values can be set
key [required]
\nstring
Custom attribute key. This will be the value use to search on this custom attribute
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
id
\nstring
Custom attribute configs identifier
type
\nenum
Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute
default: custom_attribute
data
\nobject
The definition of CustomAttributeConfig object.
attributes
\nobject
Custom attribute resource attributes
case_type_id [required]
\nstring
Custom attribute config identifier.
description
\nstring
Custom attribute description.
display_name [required]
\nstring
Custom attribute name.
is_multi [required]
\nboolean
Whether multiple values can be set
key [required]
\nstring
Custom attribute key. This will be the value use to search on this custom attribute
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
id
\nstring
Custom attribute configs identifier
type
\nenum
Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute
default: custom_attribute
data
\nobject
The definition of CustomAttributeConfig object.
attributes
\nobject
Custom attribute resource attributes
case_type_id [required]
\nstring
Custom attribute config identifier.
description
\nstring
Custom attribute description.
display_name [required]
\nstring
Custom attribute name.
is_multi [required]
\nboolean
Whether multiple values can be set
key [required]
\nstring
Custom attribute key. This will be the value use to search on this custom attribute
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
id
\nstring
Custom attribute configs identifier
type
\nenum
Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute
default: custom_attribute
data [required]
\nobject
Custom attribute config
attributes [required]
\nobject
Custom attribute config resource attributes
description
\nstring
Custom attribute description.
display_name [required]
\nstring
Custom attribute name.
is_multi [required]
\nboolean
Whether multiple values can be set
key [required]
\nstring
Custom attribute key. This will be the value use to search on this custom attribute
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
type [required]
\nenum
Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute
default: custom_attribute
data [required]
\nobject
Custom attribute config
attributes [required]
\nobject
Custom attribute config resource attributes
description
\nstring
Custom attribute description.
display_name [required]
\nstring
Custom attribute name.
is_multi [required]
\nboolean
Whether multiple values can be set
key [required]
\nstring
Custom attribute key. This will be the value use to search on this custom attribute
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
type [required]
\nenum
Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute
default: custom_attribute
data
\n[object]
Cases response data
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
meta
\nobject
Cases response metadata
page
\nobject
Pagination metadata
current
\nint64
Current page number
size
\nint64
Number of cases in current page
total
\nint64
Total number of pages
data
\n[object]
Cases response data
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
meta
\nobject
Cases response metadata
page
\nobject
Pagination metadata
current
\nint64
Current page number
size
\nint64
Number of cases in current page
total
\nint64
Total number of pages
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data [required]
\nobject
Case creation data
attributes [required]
\nobject
Case creation attributes
description
\nstring
Description
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
title [required]
\nstring
Title
type_id [required]
\nstring
Case type UUID
relationships
\nobject
Relationships formed with the case on creation
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project [required]
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data [required]
\nobject
Case creation data
attributes [required]
\nobject
Case creation attributes
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
title [required]
\nstring
Title
type_id [required]
\nstring
Case type UUID
relationships
\nobject
Relationships formed with the case on creation
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project [required]
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data [required]
\nobject
Case update custom attribute
attributes [required]
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data [required]
\nobject
Case update custom attribute
attributes [required]
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
data
\n[object]
Array of results matching the search query.
attributes [required]
\nobject
Object containing the information of a search result.
impacted_sessions
\nint64
Count of sessions impacted by the issue over the queried time window.
impacted_users
\nint64
Count of users impacted by the issue over the queried time window.
total_count
\nint64
Total count of errors that match the issue over the queried time window.
id [required]
\nstring
Search result identifier (matches the nested issue's identifier).
relationships
\nobject
Relationships between the search result and other resources.
issue
\nobject
Relationship between the search result and the corresponding issue.
data [required]
\nobject
The issue the search result corresponds to.
id [required]
\nstring
Issue identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: issue
type [required]
\nenum
Type of the object. \nAllowed enum values: error_tracking_search_result
included
\n[ <oneOf>]
Array of resources related to the search results.
Option 1
\nobject
The issue matching the request.
attributes [required]
\nobject
Object containing the information of an issue.
error_message
\nstring
Error message associated with the issue.
error_type
\nstring
Type of the error that matches the issue.
file_path
\nstring
Path of the file where the issue occurred.
first_seen
\nint64
Timestamp of the first seen error in milliseconds since the Unix epoch.
first_seen_version
\nstring
The application version (for example, git commit hash) where the issue was first observed.
function_name
\nstring
Name of the function where the issue occurred.
is_crash
\nboolean
Error is a crash.
languages
\n[string]
Array of programming languages associated with the issue.
last_seen
\nint64
Timestamp of the last seen error in milliseconds since the Unix epoch.
last_seen_version
\nstring
The application version (for example, git commit hash) where the issue was last observed.
platform
\nenum
Platform associated with the issue. \nAllowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN
service
\nstring
Service name.
state
\nenum
State of the issue \nAllowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED
id [required]
\nstring
Issue identifier.
relationships
\nobject
Relationship between the issue and an assignee, case and/or teams.
assignee
\nobject
Relationship between the issue and assignee.
data [required]
\nobject
The user the issue is assigned to.
id [required]
\nstring
User identifier.
type [required]
\nenum
Type of the object \nAllowed enum values: user
case
\nobject
Relationship between the issue and case.
data [required]
\nobject
The case the issue is attached to.
id [required]
\nstring
Case identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: case
team_owners
\nobject
Relationship between the issue and teams.
data [required]
\n[object]
Array of teams that are owners of the issue.
id [required]
\nstring
Team identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: team
type [required]
\nenum
Type of the object. \nAllowed enum values: issue
Option 2
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL custom attribute
Option 2
\n[string]
Value of multi TEXT/URL custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
Option 3
\nobject
The user to whom the issue is assigned.
attributes [required]
\nobject
Object containing the information of a user.
string
Email of the user.
handle
\nstring
Handle of the user.
name
\nstring
Name of the user.
id [required]
\nstring
User identifier.
type [required]
\nenum
Type of the object \nAllowed enum values: user
Option 4
\nobject
A team that owns an issue.
attributes [required]
\nobject
Object containing the information of a team.
handle
\nstring
The team's identifier.
name
\nstring
The name of the team.
summary
\nstring
A brief summary of the team, derived from its description.
id [required]
\nstring
Team identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: team
data
\n[object]
Array of results matching the search query.
attributes [required]
\nobject
Object containing the information of a search result.
impacted_sessions
\nint64
Count of sessions impacted by the issue over the queried time window.
impacted_users
\nint64
Count of users impacted by the issue over the queried time window.
total_count
\nint64
Total count of errors that match the issue over the queried time window.
id [required]
\nstring
Search result identifier (matches the nested issue's identifier).
relationships
\nobject
Relationships between the search result and other resources.
issue
\nobject
Relationship between the search result and the corresponding issue.
data [required]
\nobject
The issue the search result corresponds to.
id [required]
\nstring
Issue identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: issue
type [required]
\nenum
Type of the object. \nAllowed enum values: error_tracking_search_result
included
\n[ <oneOf>]
Array of resources related to the search results.
Option 1
\nobject
The issue matching the request.
attributes [required]
\nobject
Object containing the information of an issue.
error_message
\nstring
Error message associated with the issue.
error_type
\nstring
Type of the error that matches the issue.
file_path
\nstring
Path of the file where the issue occurred.
first_seen
\nint64
Timestamp of the first seen error in milliseconds since the Unix epoch.
first_seen_version
\nstring
The application version (for example, git commit hash) where the issue was first observed.
function_name
\nstring
Name of the function where the issue occurred.
is_crash
\nboolean
Error is a crash.
languages
\n[string]
Array of programming languages associated with the issue.
last_seen
\nint64
Timestamp of the last seen error in milliseconds since the Unix epoch.
last_seen_version
\nstring
The application version (for example, git commit hash) where the issue was last observed.
platform
\nenum
Platform associated with the issue. \nAllowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN
service
\nstring
Service name.
state
\nenum
State of the issue \nAllowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED
id [required]
\nstring
Issue identifier.
relationships
\nobject
Relationship between the issue and an assignee, case and/or teams.
assignee
\nobject
Relationship between the issue and assignee.
data [required]
\nobject
The user the issue is assigned to.
id [required]
\nstring
User identifier.
type [required]
\nenum
Type of the object \nAllowed enum values: user
case
\nobject
Relationship between the issue and case.
data [required]
\nobject
The case the issue is attached to.
id [required]
\nstring
Case identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: case
team_owners
\nobject
Relationship between the issue and teams.
data [required]
\n[object]
Array of teams that are owners of the issue.
id [required]
\nstring
Team identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: team
type [required]
\nenum
Type of the object. \nAllowed enum values: issue
Option 2
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
The definition of CaseObjectAttributes object.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
Custom attribute values
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
Union of supported value for a custom attribute
Option 1
\nstring
Value of TEXT/URL/SELECT custom attribute
Option 2
\n[string]
Value of multi TEXT/URL/SELECT custom attribute
Option 3
\ndouble
Value of NUMBER custom attribute
Option 4
\n[number]
Values of multi NUMBER custom attribute
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project
data [required]
\nobject
Relationship to project object
id [required]
\nstring
A unique identifier that represents the project
type [required]
\nenum
Project resource type \nAllowed enum values: project
default: project
type [required]
\nenum
Case resource type \nAllowed enum values: case
default: case
Option 3
\nobject
The user to whom the issue is assigned.
attributes [required]
\nobject
Object containing the information of a user.
string
Email of the user.
handle
\nstring
Handle of the user.
name
\nstring
Name of the user.
id [required]
\nstring
User identifier.
type [required]
\nenum
Type of the object \nAllowed enum values: user
Option 4
\nobject
A team that owns an issue.
attributes [required]
\nobject
Object containing the information of a team.
handle
\nstring
The team's identifier.
name
\nstring
The name of the team.
summary
\nstring
A brief summary of the team, derived from its description.
id [required]
\nstring
Team identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: team