JIRA Cloud API Data Model

emailAddress

string

☐

The email address.

event_event_description

string

☐

The description of the event.

event_event_id

int64

☐

The ID of the event. The event can be a Jira system event or a custom event.

event_event_name

string

☐

The name of the event.

field_custom

boolean

☐

Indicates whether the field is a custom field.

field_id

string

☐

The ID of the field.

field_key

string

☐

The key of the field.

field_name

string

☐

The name of the field.

field_navigable

boolean

☐

Indicates whether the field can be used as a column on the issue navigator.

field_orderable

boolean

☐

Indicates whether the content of the field can be used to order lists.

field_schema_configuration

string

☐

If the field is a custom field, the configuration of the field.

field_schema_custom

string

☐

If the field is a custom field, the URI of the field.

field_schema_customId

int64

☐

If the field is a custom field, the custom ID of the field.

field_schema_items

string

☐

When the data type is an array, the name of the field items within the array.

field_schema_system

string

☐

If the field is a system field, the name of the field.

field_schema_type

string

☐

The data type of the field.

field_searchable

boolean

☐

Indicates whether the content of the field can be searched.

group_name

string

☐

The name of group.

id

int64

☐

The ID of the notification.

notificationType

string

☐

Identifies the recipients of the notification. Valid values: CurrentAssignee, Reporter, CurrentUser, ProjectLead, ComponentLead, User, Group, ProjectRole, EmailAddress, AllWatchers, UserCustomField, GroupCustomField.

parameter

string

☐

The value of the type: User: the parameter is the user account ID, Group: the parameter is the group name, ProjectRole: the parameter is the project role ID, UserCustomField: the parameter is the ID of the custom field, GroupCustomField: the parameter is the ID of the custom field.

projectRole_admin

boolean

☐

Whether this role is the admin role for the project.

projectRole_default

boolean

☐

Whether this role is the default role for the project.

projectRole_description

string

☐

The description of the project role.

projectRole_id

int64

☐

The ID of the project role.

projectRole_name

string

☐

The name of the project role.

scheme_description

string

☐

The description of the notification scheme.

scheme_id

int64

☐

The ID of the notification scheme.

scheme_name

string

☐

The name of the notification scheme.

scope_type

string

☐

The type of scope.

user_accountId

string

☐

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user.

user_accountType

string

☐

The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk

user_active

boolean

☐

Indicates whether the user is active.

user_displayName

string

☐

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

user_emailAddress

string

☐

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

user_key

string

☐

This property is no longer available and will be removed from the documentation soon

user_locale

string

☐

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

user_name

string

☐

This property is no longer available and will be removed from the documentation soon.

user_timeZone

string

☐

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.