JIRA Cloud API Data Model

filter_description

string

☐

A description of the filter.

filter_favourite

boolean

☐

Indicates whether the filter is selected as a favorite by any users, not including the filter owner.

filter_favouritedCount

int64

☐

The count of how many users have selected this filter as a favorite, including the filter owner.

filter_id

string

☐

The unique identifier for the filter.

filter_jql

string

☐

The JQL query for the filter.

filter_name

string

☐

The name of the filter. Must be unique.

filter_searchUrl

string

☐

A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results

filter_viewUrl

string

☐

A URL to view the filter results in Jira, using the ID of the filter.

group_name

string

☐

The name of group.

id

string

☐

The unique identifier of the share permission.

owner_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.

owner_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

owner_active

boolean

☐

Indicates whether the user is active.

owner_displayName

string

☐

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

owner_emailAddress

string

☐

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

owner_key

string

☐

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

owner_locale

string

☐

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

owner_name

string

☐

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

owner_timeZone

string

☐

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

project_description

string

☐

A brief description of the project.

project_email

string

☐

An email address associated with the project.

project_favourite

boolean

☐

Whether the project is selected as a favorite.

project_id

int64

☐

The ID of the project.

project_isPrivate

boolean

☐

Whether the project is private.

project_key

string

☐

The key of the project.

project_lead_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.

project_lead_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

project_lead_active

boolean

☐

Indicates whether the user is active.

project_lead_displayName

string

☐

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

project_lead_emailAddress

string

☐

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

project_lead_key

string

☐

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

project_lead_locale

string

☐

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

project_lead_name

string

☐

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

project_lead_timeZone

string

☐

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

project_name

string

☐

The name of the project.

project_permissions_canEdit

boolean

☐

Indicates whether the logged user can edit the project.

project_projectTypeKey

string

☐

The project type of the project.

project_self

string

☐

The URL of the project details.

project_simplified

boolean

☐

Whether the project is simplified.

project_style

string

☐

The type of the project.

project_url

string

☐

A link to information about this project, such as project documentation.

project_uuid

string

☐

Unique ID for next-gen projects.

role_admin

boolean

☐

Whether this role is the admin role for the project.

role_default

boolean

☐

Whether this role is the default role for the project.

role_description

string

☐

The description of the project role.

role_id

int64

☐

The ID of the project role.

role_name

string

☐

The name of the project role.

scope_type

string

☐

The type of scope.

type

string

☐

The type of share permission: group: Shared with a group.If set in a request, then specify sharePermission.group as well, project: Shared with a project.If set in a request, then specify sharePermissionproject as well, projectRole: share with a project role in a project.This value is not returned in responses.It is used in requests, where it needs to be specify with projectId and projectRoleId, global: Shared globally.If set in a request, no other sharePermission properties need to be specified, loggedin: Shared with all logged -in users.Note: This value is set in a request by specifying authenticated as the type, project-unknown: Shared with a project that the user does not have access to.Cannot be set in a request.