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": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of custom attribute configs of case type

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Custom attribute resource attributes

\n
\n
\n
\n
\n
\n

case_type_id [required]

\n
\n

string

\n

Custom attribute config identifier.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Custom attribute description.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

Custom attribute name.

\n
\n \n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

Whether multiple values can be set

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

Custom attribute key. This will be the value use to search on this custom attribute

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Custom attribute configs identifier

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute

default: custom_attribute

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of custom attribute configs of case type

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Custom attribute resource attributes

\n
\n
\n
\n
\n
\n

case_type_id [required]

\n
\n

string

\n

Custom attribute config identifier.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Custom attribute description.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

Custom attribute name.

\n
\n \n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

Whether multiple values can be set

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

Custom attribute key. This will be the value use to search on this custom attribute

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Custom attribute configs identifier

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute

default: custom_attribute

\n
\n \n
\n
\n
\n
" }, "401": { "json": { @@ -70,7 +70,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of custom attribute configs of case type

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Custom attribute resource attributes

\n
\n
\n
\n
\n
\n

case_type_id [required]

\n
\n

string

\n

Custom attribute config identifier.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Custom attribute description.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

Custom attribute name.

\n
\n \n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

Whether multiple values can be set

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

Custom attribute key. This will be the value use to search on this custom attribute

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Custom attribute configs identifier

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute

default: custom_attribute

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of custom attribute configs of case type

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Custom attribute resource attributes

\n
\n
\n
\n
\n
\n

case_type_id [required]

\n
\n

string

\n

Custom attribute config identifier.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Custom attribute description.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

Custom attribute name.

\n
\n \n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

Whether multiple values can be set

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

Custom attribute key. This will be the value use to search on this custom attribute

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Custom attribute configs identifier

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute

default: custom_attribute

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -128,7 +128,7 @@ "type": "custom_attribute" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of CustomAttributeConfig object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Custom attribute resource attributes

\n
\n
\n
\n
\n
\n

case_type_id [required]

\n
\n

string

\n

Custom attribute config identifier.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Custom attribute description.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

Custom attribute name.

\n
\n \n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

Whether multiple values can be set

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

Custom attribute key. This will be the value use to search on this custom attribute

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Custom attribute configs identifier

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute

default: custom_attribute

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of CustomAttributeConfig object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Custom attribute resource attributes

\n
\n
\n
\n
\n
\n

case_type_id [required]

\n
\n

string

\n

Custom attribute config identifier.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Custom attribute description.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

Custom attribute name.

\n
\n \n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

Whether multiple values can be set

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

Custom attribute key. This will be the value use to search on this custom attribute

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Custom attribute configs identifier

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute

default: custom_attribute

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -195,7 +195,7 @@ "type": "custom_attribute" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Custom attribute config

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Custom attribute config resource attributes

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Custom attribute description.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

Custom attribute name.

\n
\n \n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

Whether multiple values can be set

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

Custom attribute key. This will be the value use to search on this custom attribute

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute

default: custom_attribute

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Custom attribute config

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Custom attribute config resource attributes

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Custom attribute description.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

Custom attribute name.

\n
\n \n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

Whether multiple values can be set

\n
\n \n
\n
\n
\n
\n
\n

key [required]

\n
\n

string

\n

Custom attribute key. This will be the value use to search on this custom attribute

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes config JSON:API resource type \nAllowed enum values: custom_attribute

default: custom_attribute

\n
\n \n
\n
\n
\n
" } }, "DeleteCustomAttributeConfig": { diff --git a/content/en/api/v2/case-management/examples.json b/content/en/api/v2/case-management/examples.json index ee5a60b15f7..419f386b760 100644 --- a/content/en/api/v2/case-management/examples.json +++ b/content/en/api/v2/case-management/examples.json @@ -84,7 +84,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Cases response data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Cases response metadata

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination metadata

\n
\n
\n
\n
\n
\n

current

\n
\n

int64

\n

Current page number

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Number of cases in current page

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total number of pages

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Cases response data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Cases response metadata

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination metadata

\n
\n
\n
\n
\n
\n

current

\n
\n

int64

\n

Current page number

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Number of cases in current page

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total number of pages

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -209,7 +209,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -256,6 +256,13 @@ "json_curl": { "data": { "attributes": { + "custom_attributes": { + "": { + "is_multi": false, + "type": "NUMBER", + "value": {} + } + }, "title": "Security breach investigation", "type_id": "3b010bde-09ce-4449-b745-71dd5f861963" }, @@ -279,6 +286,16 @@ "json": { "data": { "attributes": { + "custom_attributes": { + "": { + "is_multi": false, + "type": "NUMBER", + "value": { + "description": "", + "type": "" + } + } + }, "description": "string", "priority": "NOT_DEFINED", "title": "Security breach investigation", @@ -301,7 +318,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Case creation data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case creation attributes

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type_id [required]

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships formed with the case on creation

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project [required]

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Case creation data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case creation attributes

\n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type_id [required]

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships formed with the case on creation

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project [required]

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" } }, "GetProjects": { @@ -680,7 +697,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -805,7 +822,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -938,7 +955,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1077,7 +1094,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1359,7 +1376,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "401": { "json": { @@ -1476,7 +1493,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1543,7 +1560,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Case update custom attribute

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Case update custom attribute

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" } }, "UpdateCaseDescription": { @@ -1622,7 +1639,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1761,7 +1778,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1900,7 +1917,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -2039,7 +2056,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -2178,7 +2195,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -2311,7 +2328,7 @@ "type": "case" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/error-tracking/examples.json b/content/en/api/v2/error-tracking/examples.json index 73bf9169c02..59b45465276 100644 --- a/content/en/api/v2/error-tracking/examples.json +++ b/content/en/api/v2/error-tracking/examples.json @@ -69,7 +69,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of results matching the search query.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a search result.

\n
\n
\n
\n
\n
\n

impacted_sessions

\n
\n

int64

\n

Count of sessions impacted by the issue over the queried time window.

\n
\n \n
\n
\n
\n
\n
\n

impacted_users

\n
\n

int64

\n

Count of users impacted by the issue over the queried time window.

\n
\n \n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count of errors that match the issue over the queried time window.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Search result identifier (matches the nested issue's identifier).

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships between the search result and other resources.

\n
\n
\n
\n
\n
\n

issue

\n
\n

object

\n

Relationship between the search result and the corresponding issue.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The issue the search result corresponds to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: issue

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: error_tracking_search_result

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of resources related to the search results.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The issue matching the request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of an issue.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

Error message associated with the issue.

\n
\n \n
\n
\n
\n
\n
\n

error_type

\n
\n

string

\n

Type of the error that matches the issue.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

Path of the file where the issue occurred.

\n
\n \n
\n
\n
\n
\n
\n

first_seen

\n
\n

int64

\n

Timestamp of the first seen error in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

first_seen_version

\n
\n

string

\n

The application version (for example, git commit hash) where the issue was first observed.

\n
\n \n
\n
\n
\n
\n
\n

function_name

\n
\n

string

\n

Name of the function where the issue occurred.

\n
\n \n
\n
\n
\n
\n
\n

is_crash

\n
\n

boolean

\n

Error is a crash.

\n
\n \n
\n
\n
\n
\n
\n

languages

\n
\n

[string]

\n

Array of programming languages associated with the issue.

\n
\n \n
\n
\n
\n
\n
\n

last_seen

\n
\n

int64

\n

Timestamp of the last seen error in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

last_seen_version

\n
\n

string

\n

The application version (for example, git commit hash) where the issue was last observed.

\n
\n \n
\n
\n
\n
\n
\n

platform

\n
\n

enum

\n

Platform associated with the issue. \nAllowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

Service name.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

State of the issue \nAllowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between the issue and an assignee, case and/or teams.

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship between the issue and assignee.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The user the issue is assigned to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object \nAllowed enum values: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

case

\n
\n

object

\n

Relationship between the issue and case.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The case the issue is attached to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

team_owners

\n
\n

object

\n

Relationship between the issue and teams.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Array of teams that are owners of the issue.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Team identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: issue

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The user to whom the issue is assigned.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object \nAllowed enum values: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

A team that owns an issue.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a team.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The team's identifier.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the team.

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from its description.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Team identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: team

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of results matching the search query.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a search result.

\n
\n
\n
\n
\n
\n

impacted_sessions

\n
\n

int64

\n

Count of sessions impacted by the issue over the queried time window.

\n
\n \n
\n
\n
\n
\n
\n

impacted_users

\n
\n

int64

\n

Count of users impacted by the issue over the queried time window.

\n
\n \n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count of errors that match the issue over the queried time window.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Search result identifier (matches the nested issue's identifier).

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships between the search result and other resources.

\n
\n
\n
\n
\n
\n

issue

\n
\n

object

\n

Relationship between the search result and the corresponding issue.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The issue the search result corresponds to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: issue

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: error_tracking_search_result

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of resources related to the search results.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The issue matching the request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of an issue.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

Error message associated with the issue.

\n
\n \n
\n
\n
\n
\n
\n

error_type

\n
\n

string

\n

Type of the error that matches the issue.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

Path of the file where the issue occurred.

\n
\n \n
\n
\n
\n
\n
\n

first_seen

\n
\n

int64

\n

Timestamp of the first seen error in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

first_seen_version

\n
\n

string

\n

The application version (for example, git commit hash) where the issue was first observed.

\n
\n \n
\n
\n
\n
\n
\n

function_name

\n
\n

string

\n

Name of the function where the issue occurred.

\n
\n \n
\n
\n
\n
\n
\n

is_crash

\n
\n

boolean

\n

Error is a crash.

\n
\n \n
\n
\n
\n
\n
\n

languages

\n
\n

[string]

\n

Array of programming languages associated with the issue.

\n
\n \n
\n
\n
\n
\n
\n

last_seen

\n
\n

int64

\n

Timestamp of the last seen error in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

last_seen_version

\n
\n

string

\n

The application version (for example, git commit hash) where the issue was last observed.

\n
\n \n
\n
\n
\n
\n
\n

platform

\n
\n

enum

\n

Platform associated with the issue. \nAllowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

Service name.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

State of the issue \nAllowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between the issue and an assignee, case and/or teams.

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship between the issue and assignee.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The user the issue is assigned to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object \nAllowed enum values: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

case

\n
\n

object

\n

Relationship between the issue and case.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The case the issue is attached to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

team_owners

\n
\n

object

\n

Relationship between the issue and teams.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Array of teams that are owners of the issue.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Team identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: issue

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

custom_attributes

\n
\n

object

\n

Case custom attributes

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

object

\n

Custom attribute values

\n
\n
\n
\n
\n
\n

is_multi [required]

\n
\n

boolean

\n

If true, value must be an array

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Custom attributes type \nAllowed enum values: URL,TEXT,NUMBER,SELECT

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

 <oneOf>

\n

Union of supported value for a custom attribute

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

string

\n

Value of TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

[string]

\n

Value of multi TEXT/URL/SELECT custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 3

\n
\n

double

\n

Value of NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n

Option 4

\n
\n

[number]

\n

Values of multi NUMBER custom attribute

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

DEPRECATED: Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n

type_id

\n
\n

string

\n

Case type UUID

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The user to whom the issue is assigned.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object \nAllowed enum values: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

A team that owns an issue.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a team.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The team's identifier.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the team.

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from its description.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Team identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: team

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 464fe2ee66a..2661a983aff 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -9146,6 +9146,11 @@ components: CaseCreateAttributes: description: Case creation attributes properties: + custom_attributes: + additionalProperties: + $ref: '#/components/schemas/CustomAttributeValue' + description: Case custom attributes + type: object description: description: Description type: string @@ -14619,9 +14624,9 @@ components: type: number type: array CustomAttributeMultiStringValue: - description: Value of multi TEXT/URL custom attribute + description: Value of multi TEXT/URL/SELECT custom attribute items: - description: TEXT/URL Value + description: TEXT/URL/SELECT Value type: string type: array CustomAttributeNumberValue: @@ -14629,7 +14634,7 @@ components: format: double type: number CustomAttributeStringValue: - description: Value of TEXT/URL custom attribute + description: Value of TEXT/URL/SELECT custom attribute type: string CustomAttributeType: description: Custom attributes type @@ -14637,12 +14642,14 @@ components: - URL - TEXT - NUMBER + - SELECT example: NUMBER type: string x-enum-varnames: - URL - TEXT - NUMBER + - SELECT CustomAttributeValue: description: Custom attribute values properties: