add_actor_users
Adds actors to a project role for the project.
To replace all actors for the project, use Set actors for project role.
This operation can be accessed anonymously.
Permissions required: Administer Projects project permission for the project or Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the project role. Use Get all project roles to get a list of project role IDs.
Type: integer
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
$body
The groups or users to associate with the project role for this project. Provide the user account ID or group name.
Type: object
{
"user" : [ "string" ],
"group" : [ "string" ]
}
add_comment
Adds a comment to an issue.
This operation can be accessed anonymously.
Permissions required:
- Browse projects and Add comments project permission for the project that the issue containing the comment is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
$body
A comment.
Type: object
{
"renderedBody" : "The rendered version of the comment.",
"visibility" : {
"type" : "Indicates whether visibility of this item is restricted to a group or role.",
"value" : "The name of the group or role to which visibility of this item is restricted."
},
"author" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"created" : "The date and time at which the comment was created.",
"updateAuthor" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"self" : "The URL of the comment.",
"jsdPublic" : "Indicates whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation.",
"id" : "The ID of the comment.",
"body" : "The comment text.",
"updated" : "The date and time at which the comment was updated last.",
"properties" : [ {
"value" : { },
"key" : "The key of the property. Required on create and update."
} ]
}
expand
Use expand to include additional information about comments in the response. This parameter accepts renderedBody
, which returns the comment body rendered in HTML.
Type: string
add_field_to_default_screen
Adds a field to the default tab of the default screen.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
fieldId (required)
The ID of the field.
Type: string
add_project_role_actors_to_role
Adds default actors to a role. You may add groups or users, but you cannot add groups and users in the same request.
Changing a project role's default actors does not affect project role members for projects already created.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the project role. Use Get all project roles to get a list of project role IDs.
Type: integer
$body
Type: object
{
"user" : [ "string" ],
"group" : [ "string" ]
}
add_screen_tab
Creates a tab for a screen.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
screenId (required)
The ID of the screen.
Type: integer
$body
A screen tab.
Type: object
{
"name" : "The name of the screen tab. Required on create and update. The maximum length is 255 characters.",
"id" : "The ID of the screen tab."
}
add_screen_tab_field
Adds a field to a screen tab.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
screenId (required)
The ID of the screen.
Type: integer
tabId (required)
The ID of the screen tab.
Type: integer
$body
Type: object
{
"fieldId" : "The ID of the field to add."
}
add_share_permission
Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.
Be aware that this operation uses different objects for updating share permissions compared to Update filter.
Permissions required: Share dashboards and filters global permission and the user must own the filter.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the filter.
Type: integer
$body
Type: object
{
"type" : "The type of the share permission.Specify the type as follows:\n\n * `group` Share with a group. Specify `groupname` as well.\n * `project` Share with a project. Specify `projectId` as well.\n * `projectRole` Share with a project role in a project. Specify `projectId` and `projectRoleId` as well.\n * `global` Share globally, including anonymous users. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.\n * `authenticated` Share with all logged-in users. This shows as `loggedin` in the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.",
"projectId" : "The ID of the project to share the filter with. Set `type` to `project`.",
"groupname" : "The name of the group to share the filter with. Set `type` to `group`.",
"projectRoleId" : "The ID of the project role to share the filter with. Set `type` to `projectRole` and the `projectId` for the project that the role is in."
}
add_user_to_group
Adds a user to a group.
Permissions required: Site administration (that is, member of the site-admin group).
Parameters
cloudid (required)
Type: string
$body
The user to add to the group.
Type: object
{
"accountId" : "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. \nCannot be provided if `name` is provided.",
"name" : "The username of the user. \nThis property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Cannot be provided if `accountId` is provided."
}
groupname
The name of the group (case sensitive).
Type: string
add_vote
Adds the user's vote to an issue. This is the equivalent of the user clicking Vote on an issue in Jira.
This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
add_watcher
Adds a user as a watcher of an issue by passing the account ID or name of the user as a JSON string. For example, "384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192"
. The use of name is deprecated because of privacy changes. Use account ID instead. See the migration guide for details. If no user is specified the calling user is added.
This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- To add users other than themselves to the watchlist, Manage watcher list project permission for the project that the issue is in.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
$body
The account ID or name of the user. The use of name is deprecated because of privacy changes. Use account ID instead. See the migration guide for details.
Type: string
add_worklog
Adds a worklog to an issue.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
This operation can be accessed anonymously.
Permissions required:
- Browse projects and Work on issues project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key the issue.
Type: string
$body
Details of a worklog.
Type: object
{
"issueId" : "The ID of the issue this worklog is for.",
"visibility" : {
"type" : "Indicates whether visibility of this item is restricted to a group or role.",
"value" : "The name of the group or role to which visibility of this item is restricted."
},
"timeSpent" : "The time spent working on the issue as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided.",
"author" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"created" : "The datetime on which the worklog was created.",
"started" : "The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.",
"timeSpentSeconds" : "The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided.",
"updateAuthor" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"self" : "The URL of the worklog item.",
"comment" : "A comment about the worklog. Optional when creating or updating a worklog.",
"id" : "The ID of the worklog record.",
"updated" : "The datetime on which the worklog was last updated.",
"properties" : [ {
"value" : { },
"key" : "The key of the property. Required on create and update."
} ]
}
adjustEstimate
Defines how to update the issue's time estimate, the options are:
new
Sets the estimate to a specific value, defined innewEstimate
.leave
Leaves the estimate unchanged.manual
Reduces the estimate by amount specified inreduceBy
.auto
Reduces the estimate by the value oftimeSpent
in the worklog.
Type: string
Potential values: new, leave, manual, auto
expand
Use expand to include additional information about work logs in the response. This parameter accepts multiple values separated by a comma:
properties
Returns worklog properties.
Type: string
newEstimate
The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate
is new
.
Type: string
notifyUsers
Indicates whether users watching the issue are notified by email.
Type: boolean
overrideEditableFlag
Indicates whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Only connect app users with admin scope permission can use this flag.
Type: boolean
reduceBy
The amount to reduce the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m). For example, 2d. Required when adjustEstimate
is manual
.
Type: string
assign_issue
Assigns an issue to a user. Use this operation when the calling user does not have the Edit Issues permission but has the Assign issue permission for the project that the issue is in.
If name
or accountId
is set to:
"-1"
, the issue is assigned to the default assignee for the project.null
, the issue is set to unassigned.
This operation can be accessed anonymously.
Permissions required:
- Browse Projects and Assign Issues project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue to be assigned.
Type: string
$body
The request object with the user that the issue is assigned to.
Type: object
{
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
}
assign_permission_scheme
Assigns a permission scheme with a project. See Managing project permissions for more information about permission schemes.
Permissions required: Administer Jira global permission
Parameters
cloudid (required)
Type: string
projectKeyOrId (required)
The project ID or project key (case sensitive).
Type: string
$body
Type: object
{
"id" : "The ID of the permission scheme to associate with the project. Use the [Get all permission schemes](#api-rest-api-2-permissionscheme-get) resource to get a list of permission scheme IDs."
}
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:
all
Returns all expandable information.field
Returns information about the custom field granted the permission.group
Returns information about the group that is granted the permission.permissions
Returns all permission grants for each permission scheme.projectRole
Returns information about the project role granted the permission.user
Returns information about the user who is granted the permission.
Type: string
bulk_delete_issue_property
Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.
The criteria the filter used to identify eligible issues are:
entityIds
Only issues from this list are eligible.currentValue
Only issues with the property set to this value are eligible.
If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.
If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.
This operation is:
- transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
- asynchronous. Follow the
location
link in the response to determine the status of the task and use Get task to obtain subsequent updates.
Permissions required:
- Browse projects project permission for each project containing issues.
- If issue-level security is configured, issue-level security permission to view the issue.
- Edit issues project permission for each issue.
Parameters
cloudid (required)
Type: string
propertyKey (required)
The key of the property.
Type: string
$body
Bulk operation filter details.
Type: object
{
"entityIds" : [ "integer" ],
"currentValue" : { }
}
bulk_get_users_migration
Returns account IDs for the users specified in one or more user key or username parameters.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
key
Key of a user. To specify multiple users, pass multiple key
parameters. For example, key=fred&key=barney
. Required if username
isn't provided. Cannot be provided if username
is present.
Type: array
[ "string" ]
username
Username of a user. To specify multiple users, pass multiple username
parameters. For example, username=fred&username=barney
. Required if key
isn't provided. Cannot be provided if key
is present.
Type: array
[ "string" ]
bulk_set_issue_property
Sets a property value on multiple issues. The issues to be updated can be specified by a filter.
The filter identifies issues eligible for update using these criteria:
entityIds
Only issues from this list are eligible.currentValue
Only issues with the property set to this value are eligible.hasProperty
:- If true, only issues with the property are eligible.
- If false, only issues without the property are eligible.
If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.
If an invalid combination of criteria is provided, an error is returned. For example, specifying a currentValue
and hasProperty
as false would not match any issues (because without the property the property cannot have a value).
The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.
This operation is:
- transactional, either all eligible issues are updated or, when errors occur, none are updated.
- asynchronous. Follow the
location
link in the response to determine the status of the task and use Get task to obtain subsequent updates.
Permissions required:
- Browse projects project permission for each project containing issues.
- If issue-level security is configured, issue-level security permission to view the issue.
- Edit issues project permission for each issue.
Parameters
cloudid (required)
Type: string
propertyKey (required)
The key of the property. The maximum length is 255 characters.
Type: string
$body
Bulk issue property update request details.
Type: object
{
"filter" : {
"hasProperty" : "Indicates whether the bulk operation occurs only when the property is present on or absent from an issue.",
"entityIds" : [ "integer" ],
"currentValue" : { }
},
"value" : { }
}
cancel_task
Cancels a task.
Permissions required: either of:
- Administer Jira global permission.
- Creator of the task.
Parameters
cloudid (required)
Type: string
taskId (required)
The ID of the task.
Type: string
create_component
Creates a component. Use components to provide containers for issues within a project.
This operation can be accessed anonymously.
Permissions required: Administer projects project permission for the project in which the component is created or Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
Details about a project component.
Type: object
{
"leadUserName" : "This property is deprecated in favor of `leadAccountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the component's lead user. Optional when creating or updating a component. Cannot be provided with `leadAccountId`.",
"description" : "The description for the component. Optional when creating or updating a component.",
"project" : "The key of the project the component is assigned to. Required when creating a component. Can't be updated.",
"leadAccountId" : "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.Optional when creating or updating a component. Cannot be provided with `leadUserName`.",
"lead" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"isAssigneeTypeValid" : "Indicates whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.",
"realAssigneeType" : "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.",
"name" : "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.",
"self" : "The URL of the component.",
"realAssignee" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"id" : "The unique identifier for the component.",
"assigneeType" : "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component.",
"assignee" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"projectId" : "The ID of the project the component is assigned to."
}
create_custom_field
Creates a custom field.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
Definition of the custom field to be created
Type: object
{
"searcherKey" : "The searcher defines the way the field is searched in Jira. For example, *com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher*. \nThe search UI (basic search and JQL search) will display different operations and values for the field, based on the field searcher. You must specify a searcher that is valid for the field type, as listed below (abbreviated values shown):\n\n * `cascadingselect`: `cascadingselectsearcher`\n * `datepicker`: `daterange`\n * `datetime`: `datetimerange`\n * `float`: `exactnumber` or `numberrange`\n * `grouppicker`: `grouppickersearcher`\n * `importid`: `exactnumber` or `numberrange`\n * `labels`: `labelsearcher`\n * `multicheckboxes`: `multiselectsearcher`\n * `multigrouppicker`: `multiselectsearcher`\n * `multiselect`: `multiselectsearcher`\n * `multiuserpicker`: `userpickergroupsearcher`\n * `multiversion`: `versionsearcher`\n * `project`: `projectsearcher`\n * `radiobuttons`: `multiselectsearcher`\n * `readonlyfield`: `textsearcher`\n * `select`: `multiselectsearcher`\n * `textarea`: `textsearcher`\n * `textfield`: `textsearcher`\n * `url`: `exacttextsearcher`\n * `userpicker`: `userpickergroupsearcher`\n * `version`: `versionsearcher`",
"name" : "The name of the custom field, which is displayed in Jira. This is not the unique identifier.",
"description" : "The description of the custom field, which is displayed in Jira.",
"type" : "The type of the custom field. For example, *com.atlassian.jira.plugin.system.customfieldtypes:grouppicker*.\n\n * `cascadingselect`: Allows multiple values to be selected using two select lists\n * `datepicker`: Stores a date using a picker control\n * `datetime`: Stores a date with a time component\n * `float`: Stores and validates a numeric (floating point) input\n * `grouppicker`: Stores a user group using a picker control\n * `importid`: A read-only field that stores the previous ID of the issue from the system that it was imported from\n * `labels`: Stores labels\n * `multicheckboxes`: Stores multiple values using checkboxes\n * `multigrouppicker`: Stores multiple user groups using a picker control\n * `multiselect`: Stores multiple values using a select list\n * `multiuserpicker`: Stores multiple users using a picker control\n * `multiversion`: Stores multiple versions from the versions available in a project using a picker control\n * `project`: Stores a project from a list of projects that the user is permitted to view\n * `radiobuttons`: Stores a value using radio buttons\n * `readonlyfield`: Stores a read-only text value, which can only be populated via the API\n * `select`: Stores a value from a configurable list of options\n * `textarea`: Stores a long text string using a multiline text area\n * `textfield`: Stores a text string using a single-line text box\n * `url`: Stores a URL\n * `userpicker`: Stores a user using a picker control\n * `version`: Stores a version using a picker control"
}
create_filter
Creates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
$body
The filter to create.
Type: object
{
"owner" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"sharedUsers" : {
"size" : "The number of items on the page.",
"max-results" : "The maximum number of results that could be on the page.",
"end-index" : "The index of the last item returned on the page.",
"start-index" : "The index of the first item returned on the page.",
"items" : [ {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
} ]
},
"subscriptions" : {
"size" : "The number of items on the page.",
"max-results" : "The maximum number of results that could be on the page.",
"end-index" : "The index of the last item returned on the page.",
"start-index" : "The index of the first item returned on the page.",
"items" : [ {
"id" : "The ID of the filter subscription.",
"user" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"group" : {
"name" : "The name of group.",
"self" : "The URL for these group details."
}
} ]
},
"jql" : "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*.",
"favouritedCount" : "The count of how many users have selected this filter as a favorite, including the filter owner.",
"description" : "A description of the filter.",
"favourite" : "Indicates whether the filter is selected as a favorite.",
"name" : "The name of the filter. Must be unique.",
"viewUrl" : "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*.",
"self" : "The URL of the filter.",
"searchUrl" : "A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-2-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/2/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.",
"id" : "The unique identifier for the filter.",
"sharePermissions" : [ {
"role" : {
"actors" : [ {
"avatarUrl" : "uri",
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"actorGroup" : {
"displayName" : "string",
"name" : "string"
},
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"id" : "integer",
"type" : "string",
"user" : "string",
"actorUser" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*."
}
} ],
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the project role.",
"self" : "The URL the project role details.",
"description" : "The description of the project role.",
"id" : "The ID of the project role."
},
"project" : {
"components" : [ {
"leadUserName" : "This property is deprecated in favor of `leadAccountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the component's lead user. Optional when creating or updating a component. Cannot be provided with `leadAccountId`.",
"description" : "The description for the component. Optional when creating or updating a component.",
"project" : "The key of the project the component is assigned to. Required when creating a component. Can't be updated.",
"leadAccountId" : "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.Optional when creating or updating a component. Cannot be provided with `leadUserName`.",
"lead" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"isAssigneeTypeValid" : "Indicates whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.",
"realAssigneeType" : "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.",
"name" : "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.",
"self" : "The URL of the component.",
"realAssignee" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"id" : "The unique identifier for the component.",
"assigneeType" : "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component.",
"assignee" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"projectId" : "The ID of the project the component is assigned to."
} ],
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"roles" : "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-2-role-post).",
"description" : "A brief description of the project.",
"isPrivate" : "Indicates whether the project is private.",
"uuid" : "unique ID for next-gen projects",
"lead" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"url" : "A link to information about this project, such as project documentation.",
"issueTypes" : [ {
"avatarId" : "The ID of the issue type's avatar.",
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the issue type.",
"self" : "The URL of these issue type details.",
"description" : "The description of the issue type.",
"entityId" : "project unique ID for next-gen entities",
"id" : "The ID of the issue type.",
"iconUrl" : "The URL of the issue type's avatar.",
"subtask" : "Indicates whether this issue type is used to create subtasks."
} ],
"expand" : "Expand options that include additional project details in the response.",
"simplified" : "Indicates whether the project is simplified.",
"versions" : [ {
"releaseDate" : "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.",
"description" : "The description of the version. Optional when creating or updating a version.",
"project" : "Deprecated. Use `projectId`.",
"archived" : "Indicates that the version is archived. Optional when creating or updating a version.",
"expand" : "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts multiple values separated by a comma:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.",
"operations" : [ {
"weight" : "integer",
"id" : "string",
"label" : "string",
"href" : "string",
"styleClass" : "string",
"title" : "string",
"iconClass" : "string"
} ],
"overdue" : "Indicates that the version is overdue.",
"name" : "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.",
"self" : "The URL of the version.",
"moveUnfixedIssuesTo" : "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.",
"userReleaseDate" : "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.",
"id" : "The ID of the version.",
"userStartDate" : "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.",
"projectId" : "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.",
"released" : "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.",
"startDate" : "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.",
"issuesStatusForFixVersion" : {
"toDo" : "Count of issues with status *to do*.",
"inProgress" : "Count of issues with status *in progress*.",
"done" : "Count of issues with status *done*.",
"unmapped" : "Count of issues with a status other than *to do*, *in progress*, and *done*."
}
} ],
"projectCategory" : {
"name" : "The name of the project category. Required on create, optional on update.",
"self" : "The URL of the project category.",
"description" : "The description of the project category. Required on create, optional on update.",
"id" : "The ID of the project category."
},
"permissions" : {
"canEdit" : "Indicates whether the logged user can edit the project."
},
"issueTypeHierarchy" : {
"level" : [ {
"externalUuid" : "uuid",
"projectConfigurationId" : "integer",
"aboveLevelId" : "integer",
"issueTypeIds" : [ "integer" ],
"name" : "string",
"id" : "integer",
"belowLevelId" : "integer"
} ]
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"style" : "The type of the project.",
"id" : "The ID of the project.",
"assigneeType" : "The default assignee when creating issues for this project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project.",
"email" : "An email address associated with the project.",
"properties" : { }
},
"id" : "The unique identifier of the share permission.",
"type" : "The type of share permission:\n\n * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n * `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`.\n * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.",
"group" : {
"name" : "The name of group.",
"self" : "The URL for these group details."
}
} ]
}
expand
Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
sharedUsers
Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers
, then thesharedUsers
object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]
to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000]
.subscriptions
Returns the users that are subscribed to the filter. If you don't specifysubscriptions
, thesubscriptions
object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]
to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
.
Type: string
create_group
Creates a group.
Permissions required: Site administration (that is, member of the site-admin group).
Parameters
cloudid (required)
Type: string
$body
The name of the group.
Type: object
{
"name" : "The name of the group."
}
create_issue
Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set.
The content of the issue or subtask is defined using update
and fields
. The fields that can be set in the issue or subtask are determined using the Get create issue metadata. These are the same fields that appear on the issue's create screen.
Creating a subtask differs from creating an issue as follows:
issueType
must be set to a subtask issue type (use Get create issue metadata to find subtask issue types).parent
the must contain the ID or key of the parent issue.
Permissions required: Browse projects and Create issues project permissions for the project in which the issue or subtask is created.
Parameters
cloudid (required)
Type: string
$body
Details of an issue update request.
Type: object
{
"historyMetadata" : {
"emailDescription" : "The description of the email address associated the history record.",
"actor" : {
"avatarUrl" : "The URL to an avatar for the user or system associated with a history record.",
"displayName" : "The display name of the user or system associated with a history record.",
"id" : "The ID of the user or system associated with a history record.",
"type" : "The type of the user or system associated with a history record.",
"displayNameKey" : "The key of the display name of the user or system associated with a history record.",
"url" : "The URL of the user or system associated with a history record."
},
"extraData" : "Additional arbitrary information about the history record.",
"activityDescriptionKey" : "The key of the activity described in the history record.",
"emailDescriptionKey" : "The description key of the email address associated the history record.",
"descriptionKey" : "The description key of the history record.",
"description" : "The description of the history record.",
"generator" : {
"avatarUrl" : "The URL to an avatar for the user or system associated with a history record.",
"displayName" : "The display name of the user or system associated with a history record.",
"id" : "The ID of the user or system associated with a history record.",
"type" : "The type of the user or system associated with a history record.",
"displayNameKey" : "The key of the display name of the user or system associated with a history record.",
"url" : "The URL of the user or system associated with a history record."
},
"cause" : {
"avatarUrl" : "The URL to an avatar for the user or system associated with a history record.",
"displayName" : "The display name of the user or system associated with a history record.",
"id" : "The ID of the user or system associated with a history record.",
"type" : "The type of the user or system associated with a history record.",
"displayNameKey" : "The key of the display name of the user or system associated with a history record.",
"url" : "The URL of the user or system associated with a history record."
},
"activityDescription" : "The activity described in the history record.",
"type" : "The type of the history record."
},
"update" : "List of operations to perform on issue screen fields. Note that fields included in here cannot be included in `fields`.",
"fields" : { },
"transition" : {
"hasScreen" : "Indicates whether there is a screen associated with the issue transition.",
"expand" : "Expand options that include additional transition details in the response.",
"name" : "The name of the issue transition.",
"isGlobal" : "Indicates whether the issue transition is global, that is, the transition is applied to issues regardless of their status.",
"isInitial" : "Indicates whether this is the initial issue transition for the workflow.",
"id" : "The ID of the issue transition. Required when specifying a transition to undertake.",
"to" : {
"name" : "The name of the status.",
"self" : "The URL of the status.",
"description" : "The description of the status.",
"iconUrl" : "The URL of the icon used to represent the status.",
"id" : "The ID of the status.",
"statusCategory" : {
"colorName" : "The name of the color used to represent the status category.",
"name" : "The name of the status category.",
"self" : "The URL of the status category.",
"id" : "The ID of the status category.",
"key" : "The key of the status category."
}
},
"isConditional" : "Indicates whether the issue has to meet certain criteria before the issue transition is applied.",
"fields" : "Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request."
},
"properties" : [ {
"value" : { },
"key" : "The key of the property. Required on create and update."
} ]
}
updateHistory
Indicates whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira.
Type: boolean
create_issue_field_option
Creates an option for a select list issue field.
Note that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.
Parameters
cloudid (required)
Type: string
fieldKey (required)
The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field.
Type: string
$body
Type: object
{
"value" : "The option's name, which is displayed in Jira.",
"config" : {
"scope" : {
"projects2" : [ {
"attributes" : [ "string. Possible values: notSelectable | defaultValue" ],
"id" : "The ID of the project that the option's behavior applies to."
} ],
"projects" : [ "integer" ],
"global" : {
"attributes" : [ "string. Possible values: notSelectable | defaultValue" ]
}
},
"attributes" : [ "string. Possible values: notSelectable | defaultValue" ]
},
"properties" : { }
}
create_issue_link_type
Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link's inward and outward relationships.
To use this operation, the site must have issue linking enabled.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
This object is used as follows:
In the issueLink resource it defines and reports on the type of link between the issues. Find a list of issue link types with Get issue link types. In the issueLinkType resource it defines and reports on issue link types.
Type: object
{
"inward" : "The description of the issue link type inward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-2-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-2-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.",
"name" : "The name of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-2-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-2-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.",
"self" : "The URL of the issue link type. Read only.",
"id" : "The ID of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-2-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-2-issueLinkType-post) resource it is read only.",
"outward" : "The description of the issue link type outward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-2-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-2-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only."
}
create_issue_type
Creates an issue type and adds it to the default issue type scheme.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
Type: object
{
"name" : "The unique name for the issue type. The maximum length is 60 characters. Required.",
"description" : "The description of the issue type.",
"type" : "Whether the issue type is `subtype` or `standard`. Defaults to `standard`."
}
create_issue_type_avatar
Loads an avatar for the issue type.
Specify the avatar's local file location in the body of the request. Also, include the following headers:
X-Atlassian-Token: no-check
To prevent XSRF protection blocking the request, for more information see Special Headers.Content-Type: image/image type
Valid image types are JPEG, GIF, or PNG.
For example:curl --request POST \ --user email@example.com: \ --header 'X-Atlassian-Token: no-check' \ --header 'Content-Type: image/< image_type>' \ --data-binary "<@/path/to/file/with/your/avatar>" \ --url 'https://your-domain.atlassian.net/rest/api/2/issuetype/{issueTypeId}'This
The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.
The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.
After creating the avatar, use Update issue type to set it as the issue type's displayed avatar.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the issue type.
Type: string
$body
Type: object
{ }
size
The length of each side of the crop region.
Type: integer
x
The X coordinate of the top-left corner of the crop region.
Type: integer
y
The Y coordinate of the top-left corner of the crop region.
Type: integer
create_issues
Creates issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set.
The content of each issue or subtask is defined using update
and fields
. The fields that can be set in the issue or subtask are determined using the Get create issue metadata. These are the same fields that appear on the issues' create screens.
Creating a subtask differs from creating an issue as follows:
issueType
must be set to a subtask issue type (use Get create issue metadata to find subtask issue types).parent
the must contain the ID or key of the parent issue.
Permissions required: Browse projects and Create issues project permissions for the project in which each issue or subtask is created.
Parameters
cloudid (required)
Type: string
$body
Type: object
{
"issueUpdates" : [ {
"historyMetadata" : {
"emailDescription" : "The description of the email address associated the history record.",
"actor" : {
"avatarUrl" : "The URL to an avatar for the user or system associated with a history record.",
"displayName" : "The display name of the user or system associated with a history record.",
"id" : "The ID of the user or system associated with a history record.",
"type" : "The type of the user or system associated with a history record.",
"displayNameKey" : "The key of the display name of the user or system associated with a history record.",
"url" : "The URL of the user or system associated with a history record."
},
"extraData" : "Additional arbitrary information about the history record.",
"activityDescriptionKey" : "The key of the activity described in the history record.",
"emailDescriptionKey" : "The description key of the email address associated the history record.",
"descriptionKey" : "The description key of the history record.",
"description" : "The description of the history record.",
"generator" : {
"avatarUrl" : "The URL to an avatar for the user or system associated with a history record.",
"displayName" : "The display name of the user or system associated with a history record.",
"id" : "The ID of the user or system associated with a history record.",
"type" : "The type of the user or system associated with a history record.",
"displayNameKey" : "The key of the display name of the user or system associated with a history record.",
"url" : "The URL of the user or system associated with a history record."
},
"cause" : {
"avatarUrl" : "The URL to an avatar for the user or system associated with a history record.",
"displayName" : "The display name of the user or system associated with a history record.",
"id" : "The ID of the user or system associated with a history record.",
"type" : "The type of the user or system associated with a history record.",
"displayNameKey" : "The key of the display name of the user or system associated with a history record.",
"url" : "The URL of the user or system associated with a history record."
},
"activityDescription" : "The activity described in the history record.",
"type" : "The type of the history record."
},
"update" : "List of operations to perform on issue screen fields. Note that fields included in here cannot be included in `fields`.",
"fields" : { },
"transition" : {
"hasScreen" : "Indicates whether there is a screen associated with the issue transition.",
"expand" : "Expand options that include additional transition details in the response.",
"name" : "The name of the issue transition.",
"isGlobal" : "Indicates whether the issue transition is global, that is, the transition is applied to issues regardless of their status.",
"isInitial" : "Indicates whether this is the initial issue transition for the workflow.",
"id" : "The ID of the issue transition. Required when specifying a transition to undertake.",
"to" : {
"name" : "The name of the status.",
"self" : "The URL of the status.",
"description" : "The description of the status.",
"iconUrl" : "The URL of the icon used to represent the status.",
"id" : "The ID of the status.",
"statusCategory" : {
"colorName" : "The name of the color used to represent the status category.",
"name" : "The name of the status category.",
"self" : "The URL of the status category.",
"id" : "The ID of the status category.",
"key" : "The key of the status category."
}
},
"isConditional" : "Indicates whether the issue has to meet certain criteria before the issue transition is applied.",
"fields" : "Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request."
},
"properties" : [ {
"value" : { },
"key" : "The key of the property. Required on create and update."
} ]
} ]
}
create_or_update_remote_issue_link
Creates or updates a remote issue link for an issue.
If a globalId
is provided and a remote issue link with that global ID is found it is updated. Any fields without values in the request are set to null. Otherwise, the remote issue link is created.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
- Browse projects and Link issues project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
$body
Details of a remote issue link.
Type: object
{
"application" : {
"name" : "The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\". Grouping and sorting of links may place links without an application name last.",
"type" : "The name-spaced type of the application, used by registered rendering apps."
},
"globalId" : "An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: `appId=456&pageId=123`.\n\nSetting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.\n\nThe maximum length is 255 characters.",
"relationship" : "Description of the relationship between the issue and the linked item. If not set, the relationship description \"links to\" is used in Jira.",
"object" : {
"summary" : "The summary details of the item.",
"icon" : {
"url16x16" : "The URL of an icon that displays at 16x16 pixel in Jira.",
"link" : "The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.",
"title" : "The title of the icon. This is used as follows:\n\n * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\"."
},
"title" : "The title of the item.",
"url" : "The URL of the item.",
"status" : {
"icon" : {
"url16x16" : "The URL of an icon that displays at 16x16 pixel in Jira.",
"link" : "The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.",
"title" : "The title of the icon. This is used as follows:\n\n * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\"."
},
"resolved" : "Indicates whether the item is resolved. If set to \"true\", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font."
}
}
}
create_permission_grant
Creates a permission grant in a permission scheme.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
schemeId (required)
The ID of the permission scheme in which to create a new permission grant.
Type: integer
$body
The permission grant to create.
Type: object
{
"self" : "The URL of the permission granted details.",
"holder" : {
"expand" : "Expand options that include additional permission holder details in the response.",
"field" : {
"schema" : {
"system" : "If the field is a system field, the name of the field.",
"configuration" : { },
"custom" : "If the field is a custom field, the URI of the field.",
"type" : "The data type of the field.",
"items" : "When the data type is an array, the name of the field items within the array.",
"customId" : "If the field is a custom field, the custom ID of the field."
},
"navigable" : "Indicates whether the field can be used as a column on the issue navigator.",
"orderable" : "Indicates whether the content of the field can be used to order lists.",
"custom" : "Indicates whether the field is a custom field.",
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the field.",
"clauseNames" : [ "string" ],
"id" : "The ID of the field.",
"key" : "The key of the field.",
"searchable" : "Indicates whether the content of the field can be searched."
},
"projectRole" : {
"actors" : [ {
"avatarUrl" : "uri",
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"actorGroup" : {
"displayName" : "string",
"name" : "string"
},
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"id" : "integer",
"type" : "string",
"user" : "string",
"actorUser" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*."
}
} ],
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the project role.",
"self" : "The URL the project role details.",
"description" : "The description of the project role.",
"id" : "The ID of the project role."
},
"parameter" : "The identifier of permission holder.",
"type" : "The type of permission holder.",
"user" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"group" : {
"name" : "The name of group.",
"self" : "The URL for these group details."
}
},
"permission" : "The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. For more information about the built-in permissions, see *Permissions* in [Get all permission schemes](#api-rest-api-2-permissionscheme-get). For more information about custom permissions, see the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation.",
"id" : "The ID of the permission granted details."
}
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:
permissions
Returns all permission grants for each permission scheme.user
Returns information about the user who is granted the permission.group
Returns information about the group that is granted the permission.projectRole
Returns information about the project role granted the permission.field
Returns information about the custom field granted the permission.all
Returns all expandable information.
Type: string
create_permission_scheme
Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
The permission scheme to create.
Type: object
{
"expand" : "The expand options available for the permission scheme.",
"permissions" : [ {
"self" : "The URL of the permission granted details.",
"holder" : {
"expand" : "Expand options that include additional permission holder details in the response.",
"field" : {
"schema" : {
"system" : "If the field is a system field, the name of the field.",
"configuration" : { },
"custom" : "If the field is a custom field, the URI of the field.",
"type" : "The data type of the field.",
"items" : "When the data type is an array, the name of the field items within the array.",
"customId" : "If the field is a custom field, the custom ID of the field."
},
"navigable" : "Indicates whether the field can be used as a column on the issue navigator.",
"orderable" : "Indicates whether the content of the field can be used to order lists.",
"custom" : "Indicates whether the field is a custom field.",
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the field.",
"clauseNames" : [ "string" ],
"id" : "The ID of the field.",
"key" : "The key of the field.",
"searchable" : "Indicates whether the content of the field can be searched."
},
"projectRole" : {
"actors" : [ {
"avatarUrl" : "uri",
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"actorGroup" : {
"displayName" : "string",
"name" : "string"
},
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"id" : "integer",
"type" : "string",
"user" : "string",
"actorUser" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*."
}
} ],
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the project role.",
"self" : "The URL the project role details.",
"description" : "The description of the project role.",
"id" : "The ID of the project role."
},
"parameter" : "The identifier of permission holder.",
"type" : "The type of permission holder.",
"user" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"group" : {
"name" : "The name of group.",
"self" : "The URL for these group details."
}
},
"permission" : "The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. For more information about the built-in permissions, see *Permissions* in [Get all permission schemes](#api-rest-api-2-permissionscheme-get). For more information about custom permissions, see the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation.",
"id" : "The ID of the permission granted details."
} ],
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the permission scheme. Must be unique. Required when creating or updating a permission scheme.",
"self" : "The URL of the permission scheme.",
"description" : "A description for the permission scheme.",
"id" : "The ID of the permission scheme."
}
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:
all
Returns all expandable information.field
Returns information about the custom field granted the permission.group
Returns information about the group that is granted the permission.permissions
Returns all permission grants for each permission scheme.projectRole
Returns information about the project role granted the permission.user
Returns information about the user who is granted the permission.
Type: string
create_project
Creates a project based on a project type template, as shown in the following table:
Project Type Key Project Template Key
business com.atlassian.jira-core-project-templates:jira-core-simplified-content-management, com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval, com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking, com.atlassian.jira-core-project-templates:jira-core-simplified-process-control, com.atlassian.jira-core-project-templates:jira-core-simplified-procurement, com.atlassian.jira-core-project-templates:jira-core-simplified-project-management, com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment, com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking
service_desk com.atlassian.servicedesk:simplified-it-service-desk, com.atlassian.servicedesk:simplified-internal-service-desk, com.atlassian.servicedesk:simplified-external-service-desk
software com.pyxis.greenhopper.jira:gh-simplified-agility-kanban, com.pyxis.greenhopper.jira:gh-simplified-agility-scrum, com.pyxis.greenhopper.jira:gh-simplified-basic, com.pyxis.greenhopper.jira:gh-simplified-kanban-classic, com.pyxis.greenhopper.jira:gh-simplified-scrum-classic
ops com.atlassian.jira.jira-incident-management-plugin:im-incident-management
The project types are available according to the installed Jira features as follows:
- Jira Core, the default, enables
business
projects. - Jira Service Desk enables
service_desk
projects. - Jira Software enables
software
projects. - Jira Ops enables
ops
projects.Jira
To determine which features are installed, go to Jira settings > Apps > Manage apps and review the System Apps list. To add JIRA Software or JIRA Service Desk into a JIRA instance, use Jira settings > Apps > Finding new apps. For more information, see Managing add-ons. To enable Jira Ops, see Jira Ops.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
The JSON representation of the project being created.
Type: object
{
"notificationScheme" : "The ID of the notification scheme for the project. Use the [Get notification schemes](#api-rest-api-2-notificationscheme-get) resource to get a list of notification scheme IDs.",
"description" : "A brief description of the project.",
"leadAccountId" : "The account id of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Optional when updating a project. Cannot be provided with `lead`.",
"lead" : "This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Optional when updating a project. Cannot be provided with `leadAccountId`.",
"url" : "A link to information about this project, such as project documentation",
"projectTemplateKey" : "A prebuilt configuration for a project. The type of the `projectTemplateKey` must match with the type of the `projectTypeKey`. Required when creating a project. Not applicable for the Update project resource.",
"avatarId" : "An integer value for the project's avatar.",
"issueSecurityScheme" : "The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the [Get issue security schemes](#api-rest-api-2-issuesecurityschemes-get) resource to get all issue security scheme IDs.",
"name" : "The name of the project. Required when creating a project. Optional when updating a project.",
"permissionScheme" : "The ID of the permission scheme for the project. Use the [Get all permission schemes](#api-rest-api-2-permissionscheme-get) resource to see a list of all permission scheme IDs.",
"assigneeType" : "The default assignee when creating issues for this project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which dictates the application-specific feature set. Required when creating a project. Not applicable for the Update project resource.",
"key" : "Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters. Required when creating a project. Optional when updating a project.",
"categoryId" : "The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-2-projectCategory-get) operation."
}
create_project_avatar
Loads an avatar for a project.
Specify the avatar's local file location in the body of the request. Also, include the following headers:
X-Atlassian-Token: no-check
To prevent XSRF protection blocking the request, for more information see Special Headers.Content-Type: image/image type
Valid image types are JPEG, GIF, or PNG.
For example:curl --request POST
--user email@example.com:
--header 'X-Atlassian-Token: no-check'
--header 'Content-Type: image/< image_type>'
--data-binary "<@/path/to/file/with/your/avatar>"
--url 'https://your-domain.atlassian.net/rest/api/2/project/{projectIdOrKey}/avatar2'
The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.
The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.
After creating the avatar use Set project avatar to set it as the project's displayed avatar.
Permissions required: Administer projects project permission.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The ID or (case-sensitive) key of the project.
Type: string
$body
Type: object
{ }
size
The length of each side of the crop region.
Type: integer
x
The X coordinate of the top-left corner of the crop region.
Type: integer
y
The Y coordinate of the top-left corner of the crop region.
Type: integer
create_project_category
Creates a project category.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
A project category.
Type: object
{
"name" : "The name of the project category. Required on create, optional on update.",
"self" : "The URL of the project category.",
"description" : "The description of the project category. Required on create, optional on update.",
"id" : "The ID of the project category."
}
create_project_role
Creates a new project role with no default actors. You can use the Add default actors to project role operation to add default actors to the project role after creating it.
Note that although a new project role is available to all projects upon creation, any default actors that are associated with the project role are not added to projects that existed prior to the role being created.<
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
Type: object
{
"name" : "The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.",
"description" : "A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role."
}
create_user
Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated.
The option is provided to set or generate a password for the user. When using the option to generate a password, by omitting password
from the request, include "notification": "true"
to ensure the user is sent an email advising them that their account is created. This email includes a link for the user to set their password. If the notification isn't sent for a generated password, the user will need to be sent a reset password request from Jira.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
Type: object
{
"applicationKeys" : [ "string" ],
"notification" : "Sends the user an email confirmation that they have been added to Jira. Default is `false`.",
"password" : "A password for the user. If a password is not set, a random password is generated.",
"emailAddress" : "The email address for the user. Required.",
"displayName" : "The display name for the user. Required.",
"name" : "The username for the user. This property is deprecated because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"self" : "The URL of the user.",
"key" : "The key for the user. When provided with `name`, overrides the value in `name` to set both `name` and `key`. This property is deprecated because of privacy changes.See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
}
create_version
Creates a project version.
This operation can be accessed anonymously.
Permissions required: Administer Jira global permission or Administer Projects project permission for the project the version is added to.
Parameters
cloudid (required)
Type: string
$body
Details about a project version.
Type: object
{
"releaseDate" : "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.",
"description" : "The description of the version. Optional when creating or updating a version.",
"project" : "Deprecated. Use `projectId`.",
"archived" : "Indicates that the version is archived. Optional when creating or updating a version.",
"expand" : "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts multiple values separated by a comma:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.",
"operations" : [ {
"weight" : "integer",
"id" : "string",
"label" : "string",
"href" : "string",
"styleClass" : "string",
"title" : "string",
"iconClass" : "string"
} ],
"overdue" : "Indicates that the version is overdue.",
"name" : "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.",
"self" : "The URL of the version.",
"moveUnfixedIssuesTo" : "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.",
"userReleaseDate" : "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.",
"id" : "The ID of the version.",
"userStartDate" : "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.",
"projectId" : "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.",
"released" : "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.",
"startDate" : "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.",
"issuesStatusForFixVersion" : {
"toDo" : "Count of issues with status *to do*.",
"inProgress" : "Count of issues with status *in progress*.",
"done" : "Count of issues with status *done*.",
"unmapped" : "Count of issues with a status other than *to do*, *in progress*, and *done*."
}
}
create_workflow_scheme
Creates a workflow scheme.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
Details about a workflow scheme.
Type: object
{
"originalDefaultWorkflow" : "For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira.",
"description" : "The description of the workflow scheme.",
"issueTypes" : "The issue types available in Jira.",
"originalIssueTypeMappings" : "For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.",
"defaultWorkflow" : "The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*.",
"updateDraftIfNeeded" : "Indicates whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:\n\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated.\n * Update an inactive workflow scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.\n\nDefaults to `false`.",
"draft" : "Indicates whether the workflow scheme is a draft or not.",
"name" : "The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.",
"self" : "uri",
"lastModifiedUser" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"id" : "The ID of the workflow scheme.",
"lastModified" : "The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.",
"issueTypeMappings" : "The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme."
}
create_workflow_scheme_draft_from_parent
Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the active workflow scheme that the draft is created from.
Type: integer
create_workflow_transition_property
Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
transitionId (required)
The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
Type: integer
$body
Details about the server Jira is running on.
Type: object
{
"id" : "The ID of the transition property.",
"value" : "The value of the transition property.",
"key" : "The key of the transition property. Also known as the name of the transition property."
}
key
The key of the property being added, also known as the name of the property. Set this to the same value as the key
defined in the request body.
Type: string
workflowMode
The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.
Type: string
Potential values: live, draft
workflowName
The name of the workflow that the transition belongs to.
Type: string
delete_actor
Deletes actors from a project role for the project.
To remove default actors from the project role, use Delete default actors from project role This operation can be accessed anonymously.
Permissions required: Administer Projects project permission for the project or Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the project role. Use Get all project roles to get a list of project role IDs.
Type: integer
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
group
The name of the group to remove from the project role.
Type: string
user
The user account ID of the user to remove from the project role.
Type: string
delete_and_replace_version
Deletes a project version.
Alternative versions can be provided to update issues that use the deleted version in fixVersion
, affectedVersion
, or any version picker custom fields. If alternatives are not provided, occurrences of fixVersion
, affectedVersion
, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted.
This operation can be accessed anonymously.
Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the version.
Type: string
$body
Type: object
{
"moveAffectedIssuesTo" : "The ID of the version to update `affectedVersion` to when the field contains the deleted version.",
"moveFixIssuesTo" : "The ID of the version to update `fixVersion` to when the field contains the deleted version.",
"customFieldReplacementList" : [ {
"customFieldId" : "The ID of the custom field in which to replace the version number.",
"moveTo" : "The version number to use as a replacement for the deleted version."
} ]
}
delete_avatar
Deletes an avatar from a project or issue type.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the avatar.
Type: integer
owningObjectId (required)
The ID of the entity item.
Type: string
type (required)
The type of the entity. Valid values are project
and issuetype
.
Type: string
delete_comment
Deletes a comment.
Permissions required:
- Browse projects project permission for the project that the issue containing the comment is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- Delete all comments project permission to delete any comment or Delete own comments to delete comment created by the user,
- If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the comment.
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
delete_comment_property
Deletes a comment property.
Permissions required: either of:
- Edit All Comments project permission to delete a property from any comment.
- Edit Own Comments project permission to delete a property from a comment created by the user.
Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.
Parameters
cloudid (required)
Type: string
commentId (required)
The ID of the comment.
Type: string
propertyKey (required)
The key of the property.
Type: string
delete_component
Deletes a component.
This operation can be accessed anonymously.
Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the component.
Type: string
moveIssuesTo
The ID of the component to replace the deleted component. If this value is null no replacement is made.
Type: string
delete_dashboard_item_property
Deletes a dashboard item property.
This operation can be accessed anonymously.
Permissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.
Parameters
cloudid (required)
Type: string
dashboardId (required)
The ID of the dashboard.
Type: string
itemId (required)
The ID of the dashboard item.
Type: string
propertyKey (required)
The key of the dashboard item property.
Type: string
delete_default_workflow
Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the jira workflow).
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded
to true
and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme.
Type: integer
updateDraftIfNeeded
Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false
.
Type: boolean
delete_draft_default_workflow
Resets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow (the jira workflow).
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme that the draft belongs to.
Type: integer
delete_draft_workflow_mapping
Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme that the draft belongs to.
Type: integer
workflowName
The name of the workflow.
Type: string
delete_favourite_for_filter
Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the filter.
Type: integer
expand
Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
sharedUsers
Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers
, then thesharedUsers
object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]
to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000]
.subscriptions
Returns the users that are subscribed to the filter. If you don't specifysubscriptions
, thesubscriptions
object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]
to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
.
Type: string
delete_filter
Delete a filter.
Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the filter to delete.
Type: integer
delete_issue
Deletes an issue.
An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set deleteSubtasks
. This causes the issue's subtasks to be deleted with the issue.
This operation can be accessed anonymously.
Permissions required:
- Browse projects and Delete issues project permission for the project containing the issue.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
deleteSubtasks
Indicates whether the issue's subtasks are deleted when the issue is deleted.
Type: string
Potential values: true, false
delete_issue_field_option
Deletes an option from a select list issue field.
Note that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.
Parameters
cloudid (required)
Type: string
fieldKey (required)
The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field.
Type: string
optionId (required)
The ID of the option to be deleted.
Type: integer
delete_issue_link
Deletes an issue link.
This operation can be accessed anonymously.
Permissions required:
- Browse project project permission for all the projects containing the issues in the link.
- Link issues project permission for at least one of the projects containing issues in the link.
- If issue-level security is configured, permission to view both of the issues.
Parameters
cloudid (required)
Type: string
linkId (required)
The ID of the issue link.
Type: string
delete_issue_link_type
Deletes an issue link type.
To use this operation, the site must have issue linking enabled.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
issueLinkTypeId (required)
The ID of the issue link type.
Type: string
delete_issue_property
Deletes an issue's property.
This operation can be accessed anonymously.
Permissions required:
- Browse projects and Edit issues project permissions for the project containing the issue.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The key or ID of the issue.
Type: string
propertyKey (required)
The key of the property.
Type: string
delete_issue_type
Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeId
). A list of alternative issue types are obtained from the Get alternative issue types resource.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the issue type.
Type: string
alternativeIssueTypeId
The ID of the replacement issue type.
Type: string
delete_issue_type_property
Deletes the issue type property.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
issueTypeId (required)
The ID of the issue type.
Type: string
propertyKey (required)
The key of the property. Use Get issue type property keys to get a list of all issue type property keys.
Type: string
delete_locale
Deletes the locale of the user, which restores the default setting.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
delete_permission_scheme
Deletes a permission scheme.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
schemeId (required)
The ID of the permission scheme being deleted.
Type: integer
delete_permission_scheme_entity
Deletes a permission grant from a permission scheme. See About permission schemes and grants for more details.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
permissionId (required)
The ID of the permission grant to delete.
Type: integer
schemeId (required)
The ID of the permission scheme to delete the permission grant from.
Type: integer
delete_project
Deletes a project.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
delete_project_avatar
Deletes a custom avatar from a project. Note that system avatars cannot be deleted.
Permissions required: Administer projects project permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the avatar.
Type: integer
projectIdOrKey (required)
The project ID or (case-sensitive) key.
Type: string
delete_project_property
Deletes the property from a project.
This operation can be accessed anonymously.
Permissions required: Administer Jira global permission or Administer Projects project permission for the project containing the property.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
propertyKey (required)
The project property key. Use Get project property keys to get a list of all project property keys.
Type: string
delete_project_role
Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the project role to delete. Use Get all project roles to get a list of project role IDs.
Type: integer
swap
The ID of the project role that will replace the one being deleted.
Type: integer
delete_project_role_actors_from_role
Deletes the default actors from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request.
Changing a project role's default actors does not affect project role members for projects already created.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the project role. Use Get all project roles to get a list of project role IDs.
Type: integer
group
The group name of the group to be removed as a default actor.
Type: string
user
The user account ID of the user to remove as a default actor.
Type: string
delete_remote_issue_link_by_global_id
Deletes the remote issue link from the issue using the link's global ID.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
- Browse projects and Link issues project permission for the project that the issue is in.
- If issue-level security is implemented, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
globalId
The global ID of a remote issue link.
Type: string
delete_remote_issue_link_by_id
Deletes a remote issue link from an issue.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
- Browse projects, Edit issues, and Link issues project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
linkId (required)
The ID of a remote issue link.
Type: string
delete_screen_tab
Deletes a screen tab.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
screenId (required)
The ID of the screen.
Type: integer
tabId (required)
The ID of the screen tab.
Type: integer
delete_share_permission
Deletes a share permission from a filter.
Permissions required: Permission to access Jira and the user must own the filter.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the filter.
Type: integer
permissionId (required)
The ID of the share permission.
Type: integer
delete_user_property
Deletes a property from a user.
Permissions required:
- Administer Jira global permission, to delete a property from any user.
- Access to Jira, to delete a property from the calling user's record.
Note: These user properties are unrelated to the Jira properties that are set in Jira.
Parameters
cloudid (required)
Type: string
propertyKey (required)
The key of the user's property.
Type: string
accountId
The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username
or userKey
is specified.
Type: string
userKey
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The key of the user. Required, unless accountId
or username
is specified.
Type: string
username
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The username of the user. Required, unless accountId
or userkey
is specified.
Type: string
delete_webhook_by_id
Removes webhooks by ID. Only webhooks registered by the calling Connect app are removed. If webhooks created by other apps are specified, they are ignored.
Permissions required: Only Connect apps can use this operation.
Parameters
cloudid (required)
Type: string
$body
Container for a list of webhook IDs.
Type: object
{
"webhookIds" : [ "A list of webhook IDs." ]
}
delete_workflow_mapping
Deletes the workflow-issue type mapping for a workflow in a workflow scheme.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded
to true
and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme.
Type: integer
updateDraftIfNeeded
Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false
.
Type: boolean
workflowName
The name of the workflow.
Type: string
delete_workflow_scheme
Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId
. For example, schemeId=10301.
Type: integer
delete_workflow_scheme_draft
Deletes a draft workflow scheme.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the active workflow scheme that the draft was created from.
Type: integer
delete_workflow_scheme_draft_issue_type
Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme that the draft belongs to.
Type: integer
issueType (required)
The ID of the issue type.
Type: string
delete_workflow_scheme_issue_type
Deletes the issue type-workflow mapping for an issue type in a workflow scheme.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded
to true
and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme.
Type: integer
issueType (required)
The ID of the issue type.
Type: string
updateDraftIfNeeded
Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false
.
Type: boolean
delete_workflow_transition_property
Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
transitionId (required)
The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
Type: integer
key
The name of the transition property to delete, also known as the name of the property.
Type: string
workflowMode
The workflow status. Set to live
for inactive workflows or draft
for draft workflows. Active workflows cannot be edited.
Type: string
Potential values: live, draft
workflowName
The name of the workflow that the transition belongs to.
Type: string
delete_worklog
Deletes a worklog from an issue.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- Delete all worklogs project permission to delete any worklog or Delete own worklogs to delete worklogs created by the user,
- If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the worklog.
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
adjustEstimate
Defines how to update the issue's time estimate, the options are:
new
Sets the estimate to a specific value, defined innewEstimate
.leave
Leaves the estimate unchanged.manual
Increases the estimate by amount specified inincreaseBy
.auto
Reduces the estimate by the value oftimeSpent
in the worklog.
Type: string
Potential values: new, leave, manual, auto
increaseBy
The amount to increase the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate
is manual
.
Type: string
newEstimate
The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate
is new
.
Type: string
notifyUsers
Indicates whether users watching the issue are notified by email.
Type: boolean
overrideEditableFlag
Indicates whether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Only connect app users with admin permissions can use this flag.
Type: boolean
delete_worklog_property
Deletes a worklog property.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
propertyKey (required)
The key of the property.
Type: string
worklogId (required)
The ID of the worklog.
Type: string
disable_time_tracking
Disables time tracking.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
do_transition
Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.
To update the fields on the transition screen, specify the fields in the fields
or update
parameters in the request body. Get details about the fields using Get transitions with the transitions.fields
expand.
This operation can be accessed anonymously.
Permissions required:
- Browse projects and Transition issues project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
$body
Details of an issue update request.
Type: object
{
"historyMetadata" : {
"emailDescription" : "The description of the email address associated the history record.",
"actor" : {
"avatarUrl" : "The URL to an avatar for the user or system associated with a history record.",
"displayName" : "The display name of the user or system associated with a history record.",
"id" : "The ID of the user or system associated with a history record.",
"type" : "The type of the user or system associated with a history record.",
"displayNameKey" : "The key of the display name of the user or system associated with a history record.",
"url" : "The URL of the user or system associated with a history record."
},
"extraData" : "Additional arbitrary information about the history record.",
"activityDescriptionKey" : "The key of the activity described in the history record.",
"emailDescriptionKey" : "The description key of the email address associated the history record.",
"descriptionKey" : "The description key of the history record.",
"description" : "The description of the history record.",
"generator" : {
"avatarUrl" : "The URL to an avatar for the user or system associated with a history record.",
"displayName" : "The display name of the user or system associated with a history record.",
"id" : "The ID of the user or system associated with a history record.",
"type" : "The type of the user or system associated with a history record.",
"displayNameKey" : "The key of the display name of the user or system associated with a history record.",
"url" : "The URL of the user or system associated with a history record."
},
"cause" : {
"avatarUrl" : "The URL to an avatar for the user or system associated with a history record.",
"displayName" : "The display name of the user or system associated with a history record.",
"id" : "The ID of the user or system associated with a history record.",
"type" : "The type of the user or system associated with a history record.",
"displayNameKey" : "The key of the display name of the user or system associated with a history record.",
"url" : "The URL of the user or system associated with a history record."
},
"activityDescription" : "The activity described in the history record.",
"type" : "The type of the history record."
},
"update" : "List of operations to perform on issue screen fields. Note that fields included in here cannot be included in `fields`.",
"fields" : { },
"transition" : {
"hasScreen" : "Indicates whether there is a screen associated with the issue transition.",
"expand" : "Expand options that include additional transition details in the response.",
"name" : "The name of the issue transition.",
"isGlobal" : "Indicates whether the issue transition is global, that is, the transition is applied to issues regardless of their status.",
"isInitial" : "Indicates whether this is the initial issue transition for the workflow.",
"id" : "The ID of the issue transition. Required when specifying a transition to undertake.",
"to" : {
"name" : "The name of the status.",
"self" : "The URL of the status.",
"description" : "The description of the status.",
"iconUrl" : "The URL of the icon used to represent the status.",
"id" : "The ID of the status.",
"statusCategory" : {
"colorName" : "The name of the color used to represent the status category.",
"name" : "The name of the status category.",
"self" : "The URL of the status category.",
"id" : "The ID of the status category.",
"key" : "The key of the status category."
}
},
"isConditional" : "Indicates whether the issue has to meet certain criteria before the issue transition is applied.",
"fields" : "Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request."
},
"properties" : [ {
"value" : { },
"key" : "The key of the property. Required on create and update."
} ]
}
edit_issue
Edits an issue. A transition may be applied and issue properties updated as part of the edit.
The edits to the issue's fields are defined using update
and fields
. The fields that can be edited are determined using Get edit issue metadata.
Connect app users with admin permissions (from user permissions and app scopes) can override the screen security configuration using overrideScreenSecurity
and overrideEditableFlag
.
This operation can be accessed anonymously.
Permissions required:
- Browse projects and Edit issues project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
$body
Details of an issue update request.
Type: object
{
"historyMetadata" : {
"emailDescription" : "The description of the email address associated the history record.",
"actor" : {
"avatarUrl" : "The URL to an avatar for the user or system associated with a history record.",
"displayName" : "The display name of the user or system associated with a history record.",
"id" : "The ID of the user or system associated with a history record.",
"type" : "The type of the user or system associated with a history record.",
"displayNameKey" : "The key of the display name of the user or system associated with a history record.",
"url" : "The URL of the user or system associated with a history record."
},
"extraData" : "Additional arbitrary information about the history record.",
"activityDescriptionKey" : "The key of the activity described in the history record.",
"emailDescriptionKey" : "The description key of the email address associated the history record.",
"descriptionKey" : "The description key of the history record.",
"description" : "The description of the history record.",
"generator" : {
"avatarUrl" : "The URL to an avatar for the user or system associated with a history record.",
"displayName" : "The display name of the user or system associated with a history record.",
"id" : "The ID of the user or system associated with a history record.",
"type" : "The type of the user or system associated with a history record.",
"displayNameKey" : "The key of the display name of the user or system associated with a history record.",
"url" : "The URL of the user or system associated with a history record."
},
"cause" : {
"avatarUrl" : "The URL to an avatar for the user or system associated with a history record.",
"displayName" : "The display name of the user or system associated with a history record.",
"id" : "The ID of the user or system associated with a history record.",
"type" : "The type of the user or system associated with a history record.",
"displayNameKey" : "The key of the display name of the user or system associated with a history record.",
"url" : "The URL of the user or system associated with a history record."
},
"activityDescription" : "The activity described in the history record.",
"type" : "The type of the history record."
},
"update" : "List of operations to perform on issue screen fields. Note that fields included in here cannot be included in `fields`.",
"fields" : { },
"transition" : {
"hasScreen" : "Indicates whether there is a screen associated with the issue transition.",
"expand" : "Expand options that include additional transition details in the response.",
"name" : "The name of the issue transition.",
"isGlobal" : "Indicates whether the issue transition is global, that is, the transition is applied to issues regardless of their status.",
"isInitial" : "Indicates whether this is the initial issue transition for the workflow.",
"id" : "The ID of the issue transition. Required when specifying a transition to undertake.",
"to" : {
"name" : "The name of the status.",
"self" : "The URL of the status.",
"description" : "The description of the status.",
"iconUrl" : "The URL of the icon used to represent the status.",
"id" : "The ID of the status.",
"statusCategory" : {
"colorName" : "The name of the color used to represent the status category.",
"name" : "The name of the status category.",
"self" : "The URL of the status category.",
"id" : "The ID of the status category.",
"key" : "The key of the status category."
}
},
"isConditional" : "Indicates whether the issue has to meet certain criteria before the issue transition is applied.",
"fields" : "Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request."
},
"properties" : [ {
"value" : { },
"key" : "The key of the property. Required on create and update."
} ]
}
notifyUsers
Indicates whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored.
Type: boolean
overrideEditableFlag
Indicates whether screen security should be overridden to enable uneditable fields to be edited. Available to Connect app users with admin permissions.
Type: boolean
overrideScreenSecurity
Indicates whether screen security should be overridden to enable hidden fields to be edited. Available to Connect app users with admin permissions.
Type: boolean
evaluate_jira_expression
Evaluates a Jira expression and returns its value.
This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.
Context variables
The following context variables are available to Jira expressions evaluated by this resource. Their presence depends on various factors; usually you need to manually request them in the context object sent in the payload, but some of them are added automatically under certain conditions.
user
(User): The current user. Always available and equal tonull
if the request is anonymous.app
(App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).issue
(Issue): The current issue. Available only when the issue is provided in the request context object.issues
(List of Issues): A collection of issues matching a given JQL. Available only when the JQL is provided in the request context object (experimental).project
(Project): The current project. Available only when the project is provided in the request context object.sprint
(Sprint): The current sprint. Available only when the sprint is provided in the request context object.board
(Board): The current board. Available only when the board is provided in the request context object.serviceDesk
(ServiceDesk): The current service desk. Available only when the service desk is provided in the request context object.customerRequest
(CustomerRequest): The current customer request. Available only when the customer request is provided in the request context object.
This operation can be accessed anonymously.
Permissions required: None. However, an expression may return different results for different users depending on their permissions. For example, different users may see different comments on the same issue.
Permission to access Jira Software is required to access Jira Software context variables (board
and sprint
) or fields (for example, issue.sprint
).
Parameters
cloudid (required)
Type: string
$body
The Jira expression and the evaluation context.
Type: object
{
"expression" : "The Jira expression to evaluate.",
"context" : {
"issue" : {
"id" : "The ID of the referenced item.",
"key" : "The key of the referenced item."
},
"sprint" : "The ID of the sprint that is available under the `sprint` variable when evaluating the expression.",
"project" : {
"id" : "The ID of the referenced item.",
"key" : "The key of the referenced item."
},
"serviceDesk" : "The ID of the service desk that is available under the `serviceDesk` variable when evaluating the expression.",
"issues" : {
"jql" : {
"maxResults" : "The maximum number of issues that will be included on the list. This value is currently capped at 1000 but the cap may change without notice.",
"query" : "The JQL query.",
"startAt" : "The index of the first issue returned from the JQL query."
}
},
"board" : "The ID of the board that is available under the `board` variable when evaluating the expression.",
"customerRequest" : "The ID of the customer request that is available under the `customerRequest` variable when evaluating the expression. This is the same as the ID of the underlying Jira issue, but the customer request context variable will have a different type."
}
}
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
meta.complexity
Returns information about the expression complexity (for example, the number of expensive operations used by the expression) and how close the expression is to reaching the complexity limit. Useful when designing and debugging your expressions.
Type: string
expand_attachment_for_humans
Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive. Currently, only the ZIP archive format is supported.
Use this operation to retrieve data that is presented to the user, as this operation returns the metadata for the attachment itself, such as the attachment's ID and name. Otherwise, use Get contents metadata for an expanded attachment, which only returns the metadata for the attachment's contents.
This operation can be accessed anonymously.
Permissions required: For the issue containing the attachment:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the attachment.
Type: string
expand_attachment_for_machines
Returns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported.
Use this operation if you are processing the data without presenting it to the user, as this operation only returns the metadata for the contents of the attachment. Otherwise, to retrieve data to present to the user, use Get all metadata for an expanded attachment which also returns the metadata for the attachment itself, such as the attachment's ID and name.
This operation can be accessed anonymously.
Permissions required: For the issue containing the attachment:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the attachment.
Type: string
find_assignable_users
Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:
- a new issue, by providing the
projectKeyOrId
. - an updated issue, by providing the
issueKey
. - to an issue during a transition (workflow action), by providing the
issueKey
and the transition id inactionDescriptorId
. You can obtain the IDs of an issue's valid transitions using thetransitions
option in theexpand
parameter of Get issue.
In all these cases, you can pass a username to determine if a user can be assigned to an issue. The user is returned in the response if they can be assigned to the issue or issue transition.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
accountId
A query string that is matched against user accountId. The string must match the accountId exactly. Required, unless query
or username
is specified.
Type: string
actionDescriptorId
The ID of the transition.
Type: integer
issueKey
The key of the issue. Required, unless project
is specified.
Type: string
project
The project ID or project key (case sensitive). Required, unless issueKey
is specified.
Type: string
query
A query string that is matched against user attributes, such as key
, name
, displayName
, and emailAddress
, to find relevant users. The string can match any part of the attribute's value. For example, query=john matches a user with a displayName
of John Smith and a user with an emailAddress
of jane.johnson@example.com. Required, unless username
or accountId
is specified.
Type: string
username
This parameter is deprecated because of privacy changes. Use query
instead. See the migration guide for details. A query string used to search username, display name, and email address. The string is matched to the starting letters of any word in the searched fields. For example, ar matches to the username archie but not mark. Required, unless query
or accountId
is specified.
Type: string
find_bulk_assignable_users
Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
accountId
A query string that is matched against user accountId. The string must match the accountId exactly.
Type: string
projectKeys
A comma-separated list of project keys (case sensitive).
Type: string
query
A query string that is matched against user attributes, such as key
, name
, displayName
, and emailAddress
, to find relevant users. The string can match any part of the attribute's value. For example, query=john matches a user with a displayName
of John Smith and a user with an emailAddress
of jane.johnson@example.com.
Type: string
username
This parameter is deprecated because of privacy changes. Use query
instead. See the migration guide for details. A query string used to search username, display name, and email address. The string is matched to the starting letters of any word in the searched fields. For example, ar matches to the username archie but not mark.
Type: string
find_dashboards
Searches for dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.
This operation can be accessed anonymously.
Permissions required: The following dashboards that match the query parameters are returned:
- Dashboards owned by the user. Not returned for anonymous users.
- Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
- Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
- Dashboards shared with a public project.
- Dashboards shared with the public.
Parameters
cloudid (required)
Type: string
accountId
User account ID used to return dashboards with the matching owner.accountId
. This parameter cannot be used with the owner
parameter.
Type: string
dashboardName
String used to perform a case-insensitive partial match with name
.
Type: string
expand
Use expand to include additional information about dashboard in the response. This parameter accepts multiple values separated by a comma:
description
Returns the description of the dashboard.owner
Returns the owner of the dashboard.viewUrl
Returns the URL that is used to view the dashboard.favourite
ReturnsisFavourite
, an indicator of whether the user has set the dashboard as a favorite.favouritedCount
Returnspopularity
, a count of how many users have set this dashboard as a favorite.sharePermissions
Returns details of the share permissions defined for the dashboard.
Type: string
groupname
Group name used to returns dashboards that are shared with a group that matches sharePermissions.group.name
.
Type: string
orderBy
Orders the results using one of these dashboard properties:
id
Orders by dashboardid
.name
Orders by dashboardname
.description
Orders by dashboarddescription
. Note that this sort works independently of whether the expand to display the description field is in use.owner
Orders by ownername
.favourite_count
Orders bypopularity
.is_favourite
Orders byisFavourite
.
Type: string
Potential values: id, name, description, owner, favorite_count, is_favorite, -id, -name, -description, -owner, -favorite_count, -is_favorite
owner
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details. User name used to return dashboards with the matching owner.name
. This parameter cannot be used with the accountId
parameter.
Type: string
projectId
Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id
.
Type: integer
find_filters
Searches for filters. This operation is similar to Get filters except that the results can be refined to include filters that have specific attributes. For example, filters with a particular name. When multiple attributes are specified only filters matching all attributes are returned.
This operation can be accessed anonymously.
Permissions required: None, however, only the following filters that match the query parameters are returned:
- filters owned by the user.
- filters shared with a group that the user is a member of.
- filters shared with a private project that the user has Browse projects project permission for.
- filters shared with a public project.
- filters shared with the public.
Parameters
cloudid (required)
Type: string
accountId
User account ID used to return filters with the matching owner.accountId
. This parameter cannot be used with owner
.
Type: string
expand
Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
description
Returns the description of the filter.favourite
Returns an indicator of whether the user has set the filter as a favorite.favouritedCount
Returns a count of how many users have set this filter as a favorite.jql
Returns the JQL query that the filter uses.owner
Returns the owner of the filter.searchUrl
Returns a URL to perform the filter's JQL query.sharePermissions
Returns the share permissions defined for the filter.subscriptions
Returns the users that are subscribed to the filter.viewUrl
Returns a URL to view the filter.
Type: string
filterName
String used to perform a case-insensitive partial match with name
.
Type: string
groupname
Group name used to returns filters that are shared with a group that matches sharePermissions.group.groupname
.
Type: string
orderBy
Orders the results using one of these filter properties:
description
Orders by filterdescription
. Note that this ordering works independently of whether the expand to display the description field is in use.favourite_count
Orders byfavouritedCount
.is_favourite
Orders byfavourite
.id
Orders by filterid
.name
Orders by filtername
.owner
Orders byowner.accountId
.
Type: string
Potential values: id, name, description, owner, favorite_count, is_favorite, -id, -name, -description, -owner, -favorite_count, -is_favorite
owner
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details. User name used to return filters with the matching owner.name
. This parameter cannot be used with accountId
.
Type: string
projectId
Project ID used to returns filters that are shared with a project that matches sharePermissions.project.id
.
Type: integer
find_groups
Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results.
The primary use case for this resource is to populate a group picker suggestions list. To this end, the returned object includes the html
field where the matched query term is highlighted in the group name with the HTML strong tag. Also, the groups list is wrapped in a response object that contains a header for use in the picker, specifically Showing X of Y matching groups.
The list returns with the groups sorted. If no groups match the list criteria, an empty list is returned.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission. Anonymous calls and calls by users without the required permission return an empty list.
Parameters
cloudid (required)
Type: string
accountId
This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use Get user groups.
Type: string
exclude
A group to exclude from the result. To exclude multiple groups, provide multiple copies of this parameter. For example, exclude=group1&exclude=group2
.
Type: array
[ "string" ]
maxResults
The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property jira.ajax.autocomplete.limit
.
Type: integer
query
The string to find in group names.
Type: string
userName
This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use Get user groups.
Type: string
find_user_keys_by_query
Finds users with a structured query and returns a list of user keys.
Permissions required: Browse users and groups global permission.
The query statements are:
is assignee of PROJ
Returns the users that are assignees of at least one issue in project PROJ.is assignee of (PROJ-1, PROJ-2)
Returns users that are assignees on the issues PROJ-1 or PROJ-2.is reporter of (PROJ-1, PROJ-2)
Returns users that are reporters on the issues PROJ-1 or PROJ-2.is watcher of (PROJ-1, PROJ-2)
Returns users that are watchers on the issues PROJ-1 or PROJ-2.is voter of (PROJ-1, PROJ-2)
Returns users that are voters on the issues PROJ-1 or PROJ-2.is commenter of (PROJ-1, PROJ-2)
Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.is transitioner of (PROJ-1, PROJ-2)
Returns users that have performed a transition on issues PROJ-1 or PROJ-2.[propertyKey].entity.property.path is "property value"
Returns users with the entity property value.
The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND
and OR
operators to form more complex queries. For example:
is assignee of PROJ AND [propertyKey].entity.property.path is "property value"
Parameters
cloudid (required)
Type: string
query
The search query.
Type: string
find_users
Returns a list of users that match the provided search string and property.
This operation can be accessed anonymously.
Permissions required: Browse users and groups global permission. Anonymous calls or calls by users without the required permission return empty search results.
Note: This API is designed to return a small number of users with a flexible search query. As such, the sum of startAt
and maxResults
must be less than 1000. If the sum is greater, only results up to the 1000th result will be returned. If you wish to get a larger number of users, please use the get-all-users API (/rest/api/3/users/search
) instead.
Parameters
cloudid (required)
Type: string
accountId
A query string that is matched against a user accountId. The string must match the accountId exactly. Required, unless query
or property
is specified.
Type: string
includeActive
Type: boolean
includeInactive
Type: boolean
property
A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of nested
from {"something":{"nested":1,"other":2}}
use thepropertykey.something.nested=1
.
Type: string
query
A query string that is matched against user attributes (key
, name
, displayName
, and emailAddress
) to find relevant users. The string can match any part of the attribute's value. For example, query=john matches a user with a displayName
of John Smith and a user with an emailAddress
of jane.johnson@example.com. Required, unless accountId
or property
is specified.
Type: string
username
Type: string
find_users_and_groups
Returns a list of users and groups matching a string. The string is used:
- for users, to find a case insensitive match with username, name, and e-mail address.
- for groups, to find a case-sensitive match with group name.
For example, if the string tin is used, records with the username ptindall, name Tina, email address sarah@tinplatetraining.com, and the group accounting would be returned.
Optionally, the search can be refined to:
the projects and issue types associated with a custom field, such as a user picker. The search can then be further refined to return only users and groups that have permission to view specific:
- projects.
- issue types.
If multiple projects or issue types are specified, they must be a subset of those enabled for the custom field or no results are returned. For example, if a field is enabled for projects A, B, and C then the search could be limited to projects B and C. However, if the search is limited to projects B and D, nothing is returned.
not return Connect app users and groups.
return groups that have a case insensitive match with the query.
The primary use case for this resource is to populate a picker field suggestion list with users or groups. To this end, the returned object includes an html
field for each list. This field highlights the matched query term in the item name with the HTML strong tag. Also, each list is wrapped in a response object that contains a header for use in a picker, specifically Showing X of Y matching groups.
This operation can be accessed anonymously.
Permissions required: Browse users and groups global permission. Anonymous calls or calls by users without the required permission return an empty list.
Parameters
cloudid (required)
Type: string
avatarSize
The size of the avatar to return. If an invalid value is provided, the default value is used.
Type: string
Potential values: xsmall, xsmall@2x, xsmall@3x, small, small@2x, small@3x, medium, medium@2x, medium@3x, large, large@2x, large@3x, xlarge, xlarge@2x, xlarge@3x, xxlarge, xxlarge@2x, xxlarge@3x, xxxlarge, xxxlarge@2x, xxxlarge@3x
caseInsensitive
Indicates whether the search for groups should be case insensitive.
Type: boolean
excludeConnectAddons
Indicates whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used.
Type: boolean
fieldId
The custom field ID of the field this request is for.
Type: string
issueTypeId
The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide multiple copies of this parameter. For example, issueTypeId=10000&issueTypeId=10001
. Special values, such as -1
(all standard issue types) and -2
(all subtask issue types), are supported. This parameter is only used when fieldId
is present.
Type: array
[ "string" ]
maxResults
The maximum number of items to return in each list. The maximum is 1000
.
Type: integer
projectId
The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide multiple copies of this parameter. For example, projectId=10000&projectId=10001
. This parameter is only used when fieldId
is present.
Type: array
[ "string" ]
query
The search string.
Type: string
showAvatar
Indicates whether the user avatar should be returned. If an invalid value is provided, the default value is used.
Type: boolean
find_users_by_query
Finds users with a structured query and returns user details.
Permissions required: Browse users and groups global permission.
The query statements are:
is assignee of PROJ
Returns the users that are assignees of at least one issue in project PROJ.is assignee of (PROJ-1, PROJ-2)
Returns users that are assignees on the issues PROJ-1 or PROJ-2.is reporter of (PROJ-1, PROJ-2)
Returns users that are reporters on the issues PROJ-1 or PROJ-2.is watcher of (PROJ-1, PROJ-2)
Returns users that are watchers on the issues PROJ-1 or PROJ-2.is voter of (PROJ-1, PROJ-2)
Returns users that are voters on the issues PROJ-1 or PROJ-2.is commenter of (PROJ-1, PROJ-2)
Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.is transitioner of (PROJ-1, PROJ-2)
Returns users that have performed a transition on issues PROJ-1 or PROJ-2.[propertyKey].entity.property.path is "property value"
Returns users with the entity property value.
The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND
and OR
operators to form more complex queries. For example:
is assignee of PROJ AND [propertyKey].entity.property.path is "property value"
Parameters
cloudid (required)
Type: string
query
The search query.
Type: string
find_users_for_picker
Returns a list of users whose attributes match the query term. The returned object includes the html
field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.
This operation can be accessed anonymously.
Permissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return search results for an exact name match only.
Parameters
cloudid (required)
Type: string
avatarSize
Type: string
exclude
This parameter is deprecated because of privacy changes. Use excludeAccountIds
instead. See the migration guide for details. The username of a user to exclude from the search results. To exclude multiple users, specify this parameter multiple times. For example, exclude=mia&exclude=alana
. Cannot be provided with excludeAccountIds
.
Type: array
[ "string" ]
excludeAccountIds
A comma-separated list of account IDs to exclude from the search results. This parameter may be specified multiple times. For example, excludeAccountIds=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e,bd429c95-e27b-4423-a0bd-421cf3d69129&excludeAccountIds=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
. Cannot be provided with exclude
.
Type: array
[ "string" ]
excludeConnectUsers
Type: boolean
maxResults
The maximum number of items to return. The maximum is 1000
. The total number of matched users is returned in total
.
Type: integer
query
A query string that is matched against user attributes, such as key
, name
, displayName
, and emailAddress
, to find relevant users. The string can match any part of the attribute's value. For example, query=john matches a user with a displayName
of John Smith and a user with an emailAddress
of jane.johnson@example.com.
Type: string
showAvatar
Include the URI to the user's avatar.
Type: boolean
find_users_with_all_permissions
Returns a list of users who fulfill these criteria:
- their user attributes match a search string.
- they have a set of permissions for a project or issue.
If no search string is provided, a list of all users with the permissions is returned.
This operation can be accessed anonymously.
Permissions required:
- Administer Jira global permission, to get users for any project.
- Administer Projects project permission for a project, to get users for that project.
Parameters
cloudid (required)
Type: string
accountId
A query string that is matched against user accountId. The string must match the accountId exactly.
Type: string
issueKey
The issue key for the issue.
Type: string
permissions
A comma-separated list of permissions. The valid permissions are:
- ASSIGNABLE_USER
- ASSIGN_ISSUE
- ATTACHMENT_DELETE_ALL
- ATTACHMENT_DELETE_OWN
- BROWSE
- CLOSE_ISSUE
- COMMENT_DELETE_ALL
- COMMENT_DELETE_OWN
- COMMENT_EDIT_ALL
- COMMENT_EDIT_OWN
- COMMENT_ISSUE
- CREATE_ATTACHMENT
- CREATE_ISSUE
- DELETE_ISSUE
- EDIT_ISSUE
- LINK_ISSUE
- MANAGE_WATCHER_LIST
- MODIFY_REPORTER
- MOVE_ISSUE
- PROJECT_ADMIN
- RESOLVE_ISSUE
- SCHEDULE_ISSUE
- SET_ISSUE_SECURITY
- TRANSITION_ISSUE
- VIEW_VERSION_CONTROL
- VIEW_VOTERS_AND_WATCHERS
- VIEW_WORKFLOW_READONLY
- WORKLOG_DELETE_ALL
- WORKLOG_DELETE_OWN
- WORKLOG_EDIT_ALL
- WORKLOG_EDIT_OWN
- WORK_ISSUE
Type: string
projectKey
The project key for the project (case sensitive).
Type: string
query
A query string that is matched against user attributes, such as key
, name
, displayName
, and emailAddress
, to find relevant users. The string can match any part of the attribute's value. For example, query=john matches a user with a displayName
of John Smith and a user with an emailAddress
of jane.johnson@example.com.
Type: string
username
This parameter is deprecated because of privacy changes. Use query
instead. See the migration guide for details. A query string used to search username, display name, and email address. The string is matched to the starting letters of any word in the searched fields. For example, ar matches to the username archie but not mark.
Type: string
find_users_with_browse_permission
Returns a list of users who fulfill these criteria:
- their user attributes match a search string.
- they have permission to browse issues.
Use this resource to find users who can browse:
- an issue, by providing the
issueKey
. - any issue in a project, by providing the
projectKey
.
This operation can be accessed anonymously.
Permissions required: Browse users and groups global permission. Anonymous calls and calls by users without the required permission return empty search results.
Parameters
cloudid (required)
Type: string
accountId
A query string that is matched against user accountId. The string must match the accountId exactly. Required, unless query
, username
or property
is specified.
Type: string
issueKey
The issue key for the issue. Required, unless projectKey
is specified.
Type: string
projectKey
The project key for the project (case sensitive). Required, unless issueKey
is specified.
Type: string
query
A query string that is matched against user attributes, such as key
, name
, displayName
, and emailAddress
, to find relevant users. The string can match any part of the attribute's value. For example, query=john matches a user with a displayName
of John Smith and a user with an emailAddress
of jane.johnson@example.com. Required, unless username
or accountId
is specified.
Type: string
username
This parameter is deprecated because of privacy changes. Use query
instead. See the migration guide for details. A query string used to search username, display name, and email address. The string is matched to the starting letters of any word in the searched fields. For example, ar matches to the username archie but not mark. Required, unless query
or accountId
is specified.
Type: string
fully_update_project_role
Updates the project role's name and description. You must include both a name and a description in the request.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the project role. Use Get all project roles to get a list of project role IDs.
Type: integer
$body
Type: object
{
"name" : "The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.",
"description" : "A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role."
}
get_accessible_project_type_by_key
Returns a project type if it is accessible to the user.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
projectTypeKey (required)
The key of the project type.
Type: string
Potential values: ops, software, service_desk, business
get_application_property
Returns all application properties or an application property.
If you specify a value for the key
parameter, then an application property is returned as an object (not in an array). Otherwise, an array of all editable application properties is returned. See Set application property for descriptions of editable properties.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
key
The key of the application property.
Type: string
keyFilter
When a key
isn't provided, this filters the list of results by the application property key
using a regular expression. For example, using jira.lf.*
will return all application properties with keys that start with jira.lf..
Type: string
permissionLevel
The permission level of all items being returned in the list.
Type: string
get_application_role
Returns an application role.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
key (required)
The key of the application role. Use the Get all application roles operation to get the key for each application role.
Type: string
get_assigned_permission_scheme
Gets the permission scheme associated with the project.
Permissions required: Administer Jira global permission or Administer projects project permission.
Parameters
cloudid (required)
Type: string
projectKeyOrId (required)
The project ID or project key (case sensitive).
Type: string
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:
all
Returns all expandable information.field
Returns information about the custom field granted the permission.group
Returns information about the group that is granted the permission.permissions
Returns all permission grants for each permission scheme.projectRole
Returns information about the project role granted the permission.user
Returns information about the user who is granted the permission.
Type: string
get_attachment_metadata
Returns the metadata for an attachment. Note that the attachment itself is not returned.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the attachment.
Type: string
get_auto_complete
Returns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced searching - functions reference, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
get_cloudid
This operation has no parameters
get_comment
Returns a comment.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project containing the comment.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the comment.
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
expand
Use expand to include additional information about comments in the response. This parameter accepts renderedBody
, which returns the comment body rendered in HTML.
Type: string
get_comment_property
Returns the value of a comment property.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
commentId (required)
The ID of the comment.
Type: string
propertyKey (required)
The key of the property.
Type: string
get_component
Returns a component.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission for project containing the component.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the component.
Type: string
get_configuration
Returns the global settings in Jira. These settings determine whether optional features (for example, subtasks, time tracking, and others) are enabled. If time tracking is enabled, this operation also returns the time tracking configuration.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
get_counts_for_component_issues
Returns the counts of issues assigned to the component.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the component.
Type: string
get_counts_for_related_issues_for_version
Returns the following counts for a version:
- Number of issues where the
fixVersion
is set to the version. - Number of issues where the
affectedVersion
is set to the version. - Number of issues where a version custom field is set to the version.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission for the project that contains the version.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the version.
Type: string
get_create_issue_metadata
Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in Create issue and Create issues.
The request can be restricted to specific projects or issue types using the query parameters. The response will contain information for the valid projects, issue types, or project and issue type combinations requested. Note that invalid project, issue type, or project and issue type combinations do not generate errors.
This operation can be accessed anonymously.
Permissions required: Create issues project permission in the requested projects.
Parameters
cloudid (required)
Type: string
expand
Use expand to include additional information about issue metadata in the response. This parameter accepts projects.issuetypes.fields
which returns information about the fields in the issue creation screen for each issue type. Fields hidden from the screen are not returned. Use the information to populate the fields
and update
fields in Create issue and Create issues.
Type: string
issuetypeIds
Comma-separated list of issue type IDs. This parameter may be specified multiple times. For example, issuetypeIds=10000,10001&issuetypeIds=10020,10021
. This parameter may be provided with issuetypeNames
.
Type: array
[ "string" ]
issuetypeNames
Comma-separated list of issue type names. This parameter may be specified multiple times. For example, issuetypeNames=name1,name2&issuetypeNames=name3
. This parameter may be provided with issuetypeIds
.
Type: array
[ "string" ]
projectIds
Comma-separated list of project IDs. This parameter may be specified multiple times. For example, projectIds=10000,10001&projectIds=10020,10021
. This parameter may be provided with projectKeys
.
Type: array
[ "string" ]
projectKeys
Comma-separated list of project keys. This parameter may be specified multiple times. For example, projectKeys=proj1,proj2&projectKeys=proj3
. This parameter may be provided with projectIds
.
Type: array
[ "string" ]
get_current_user
Returns details for the current user.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
expand
Use expand to include additional information about user in the response. This parameter accepts multiple values separated by a comma:
groups
Returns all groups, including nested groups, the user belongs to.applicationRoles
Returns the application roles the user is assigned to.
Type: string
get_custom_field_option
Returns a custom field option. For example, an option in a cascading select list.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the custom field option. To find this ID, configure the custom field and edit its options in Jira. Click the option and its ID will show in the URL as the selectedParentOptionId
parameter.
Type: string
get_dashboard
Returns a dashboard.
This operation can be accessed anonymously.
Permissions required: None.
However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the dashboard.
Type: string
get_dashboard_item_property
Returns the key and value of a dashboard item property.
A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets.
When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation.
There is no resource to set or get dashboard items.
This operation can be accessed anonymously.
Permissions required: The user must be the owner of the dashboard or be shared the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.
Parameters
cloudid (required)
Type: string
dashboardId (required)
The ID of the dashboard.
Type: string
itemId (required)
The ID of the dashboard item.
Type: string
propertyKey (required)
The key of the dashboard item property.
Type: string
get_default_share_scope
Returns the default sharing settings for new filters and dashboards for a user.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
get_default_workflow
Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme.
Type: integer
returnDraftIfExists
Set to true
to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned.
Type: boolean
get_draft_default_workflow
Returns the default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme that the draft belongs to.
Type: integer
get_draft_workflow
Returns the workflow-issue type mappings for a workflow scheme's draft.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme that the draft belongs to.
Type: integer
workflowName
The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
Type: string
get_edit_issue_metadata
Returns the edit screen fields for an issue that are visible to and editable by the user. Use the information to populate the requests in Edit issue.
Connect app users with admin permissions (from user permissions and app scopes) can return additional details using:
overrideScreenSecurity
Returns hidden fields.overrideEditableFlag
Returns uneditable fields. For example, where an issue has a workflow status of closed none of its fields are editable.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Note: For any fields to be editable the user must have the Edit issues project permission for the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
overrideEditableFlag
Indicates whether non-editable fields should be returned. Available to connect app users with admin permissions.
Type: boolean
overrideScreenSecurity
Indicates whether hidden fields should be returned. Available to connect app users with admin permissions.
Type: boolean
get_field_auto_complete_for_query_string
Returns the JQL search auto complete suggestions for a field.
Suggestions can be obtained by providing:
fieldName
to get a list of all values for the field.fieldName
andfieldValue
to get a list of values containing the text infieldValue
.fieldName
andpredicateName
to get a list of all predicate values for the field.fieldName
,predicateName
, andpredicateValue
to get a list of predicate values containing the text inpredicateValue
.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
fieldName
The name of the field.
Type: string
fieldValue
The partial field item name entered by the user.
Type: string
predicateName
The name of the CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to.
Type: string
predicateValue
The partial predicate item name entered by the user.
Type: string
get_filter
Returns a filter.
This operation can be accessed anonymously.
Permissions required: None, however, the filter is only returned where it is:
- owned by the user.
- shared with a group that the user is a member of.
- shared with a private project that the user has Browse projects project permission for.
- shared with a public project.
- shared with the public.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the filter to return.
Type: integer
expand
Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
sharedUsers
Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers
, then thesharedUsers
object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]
to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000]
.subscriptions
Returns the users that are subscribed to the filter. If you don't specifysubscriptions
, thesubscriptions
object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]
to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
.
Type: string
get_hierarchy
Get the project hierarchy. A hierarchy dictates allowable parent child relations between issues. An Issuetype at height i may only have children of a type at height i-1. Epic types are found at height one and subtasks are found at height negative one. Issues of a type at a negative height MUST have a parent.
Parameters
cloudid (required)
Type: string
projectId (required)
The ID of the project.
Type: integer
get_ids_of_worklogs_deleted_since
Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.
This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until
indicates the timestamp of the youngest item on the page. Also, nextPage
provides the URL for the next page of worklogs. The lastPage
parameter is set to true on the last page of worklogs.
This resource does not return worklogs deleted during the minute preceding the request.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
since
The date and time, in UNIX timestamp format, after which deleted worklogs are returned.
Type: integer
get_issue
Returns the details for an issue.
The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is not returned. The issue key returned in the response is the key of the issue found.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
expand
Use expand to include additional information about the issues in the response. This parameter accepts multiple values separated by a comma:
renderedFields
Returns field values rendered in HTML format.names
Returns the display name of each field.schema
Returns the schema describing a field type.transitions
Returns all possible transitions for the issue.editmeta
Returns information about how each field can be edited.changelog
Returns a list of recent updates to an issue, sorted by date, starting from the most recent.versionedRepresentations
Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, thefields
parameter is ignored.
Type: string
fields
A comma-separated list of fields to return for the issue. Use it to retrieve a subset of fields. Allowed values:
*all
Returns all fields.*navigable
Returns navigable fields.- Any issue field, prefixed with a minus to exclude.
Examples:
summary,comment
Returns only the summary and comments fields.-description
Returns all (default) fields except description.*navigable,-comment
Returns all navigable fields except comment.
This parameter may be specified multiple times. For example, fields=field1,field2& fields=field3
.
Note: All fields are returned by default. This differs from Search for issues using JQL (GET) and Search for issues using JQL (POST) where the default is all navigable fields.
Type: array
[ "string" ]
fieldsByKeys
Indicates whether fields in fields
are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID.
Type: boolean
properties
A comma-separated list of issue properties to return for the issue. Allowed values:
*all
Returns all issue properties.- Any issue property key, prefixed with a minus to exclude.
Examples:
*all
Returns all properties.*all,-prop1
Returns all properties exceptprop1
.prop1,prop2
Returnsprop1
andprop2
properties.
This parameter may be specified multiple times. For example, properties=prop1,prop2& properties=prop3
.
Type: array
[ "string" ]
updateHistory
Indicates whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. This also populates the JQL issues search lastViewed
field.
Type: boolean
get_issue_field_option
Returns an option from a select list issue field.
Note that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.
Parameters
cloudid (required)
Type: string
fieldKey (required)
The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field.
Type: string
optionId (required)
The ID of the option to be returned.
Type: integer
get_issue_link
Returns an issue link.
This operation can be accessed anonymously.
Permissions required:
- Browse project project permission for all the projects containing the linked issues.
- If issue-level security is configured, permission to view both of the issues.
Parameters
cloudid (required)
Type: string
linkId (required)
The ID of the issue link.
Type: string
get_issue_link_type
Returns an issue link type.
To use this operation, the site must have issue linking enabled.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission for a project in the site.
Parameters
cloudid (required)
Type: string
issueLinkTypeId (required)
The ID of the issue link type.
Type: string
get_issue_link_types
Returns a list of all issue link types.
To use this operation, the site must have issue linking enabled.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission for a project in the site.
Parameters
cloudid (required)
Type: string
get_issue_picker_resource
Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.
This operation returns two lists:
History Search
which includes issues from the user's history of created, edited, or viewed issues that contain the string in thequery
parameter.Current Search
which includes issues that match the JQL expression incurrentJQL
and contain the string in thequery
parameter.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
currentIssueKey
The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.
Type: string
currentJQL
A JQL query defining a list of issues to search for the query term. Note that username
and userkey
have been deprecated as search terms for this parameter. See the migration guide for details. Use accountId
instead.
Type: string
currentProjectId
The ID of a project that suggested issues must belong to.
Type: string
query
A string to match against text fields in the issue such as title, description, or comments.
Type: string
showSubTaskParent
When currentIssueKey
is a subtask, indicates whether to include the parent issue in the suggestions if it matches the query.
Type: boolean
showSubTasks
Indicate whether to include subtasks in the suggestions list.
Type: boolean
get_issue_property
Returns the key and value of an issue's property.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project containing the issue.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The key or ID of the issue.
Type: string
propertyKey (required)
The key of the property.
Type: string
get_issue_security_level
Returns details of an issue security level.
Use Get issue security scheme to obtain the IDs of issue security levels associated with the issue security scheme.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the issue security level.
Type: string
get_issue_security_scheme
Returns an issue security scheme along with its security levels.
This operation can be accessed anonymously.
Permissions required:
- Administer Jira global permission.
- Administer Projects project permission for a project that uses the requested issue security scheme.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs.
Type: integer
get_issue_type
Returns an issue type.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission in a project the issue type is associated with or Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the issue type.
Type: string
get_issue_type_property
Returns the key and value of the issue type property.
This operation can be accessed anonymously.
Permissions required:
- Administer Jira global permission to get the details of any issue type.
- Browse projects project permission to get the details of any issue types associated with the projects the user has permission to browse.
Parameters
cloudid (required)
Type: string
issueTypeId (required)
The ID of the issue type.
Type: string
propertyKey (required)
The key of the property. Use Get issue type property keys to get a list of all issue type property keys.
Type: string
get_issue_worklog
Returns all worklogs for an issue.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
This operation can be accessed anonymously.
Permissions required: Workloads are only returned where the user has:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
expand
Use expand to include additional information about worklogs in the response. This parameter accepts multiple values separated by a comma:
properties
Returns worklog properties.
Type: string
get_locale
Returns the locale for the user.
If the user has no language preference set (which is the default setting) or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the Accept-Language header in the request. However, if this doesn't match a locale available Jira, the site default locale is returned.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
get_notification_scheme
Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events.
Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the notification scheme. Use Get notification schemes paginated to get a list of notification scheme IDs.
Type: integer
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
all
Returns all expandable information.field
Returns information about any custom fields assigned to receive an event.group
Returns information about any groups assigned to receive an event.notificationSchemeEvents
Returns a list of event associations. This list is returned for all expandable information.projectRole
Returns information about any project roles assigned to receive an event.user
Returns information about any users assigned to receive an event.
Type: string
get_permission_scheme
Returns a permission scheme.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
schemeId (required)
The ID of the permission scheme to return.
Type: integer
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:
all
Returns all expandable information.field
Returns information about the custom field granted the permission.group
Returns information about the group that is granted the permission.permissions
Returns all permission grants for each permission scheme.projectRole
Returns information about the project role granted the permission.user
Returns information about the user who is granted the permission.
Type: string
get_permission_scheme_grant
Returns a permission grant.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
permissionId (required)
The ID of the permission grant.
Type: integer
schemeId (required)
The ID of the permission scheme.
Type: integer
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:
all
Returns all expandable information.field
Returns information about the custom field granted the permission.group
Returns information about the group that is granted the permission.permissions
Returns all permission grants for each permission scheme.projectRole
Returns information about the project role granted the permission.user
Returns information about the user who is granted the permission.
Type: string
get_preference
Returns the value of a preference of the current user.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
key
The key of the preference.
Type: string
get_priority
Returns an issue priority.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the issue priority.
Type: string
get_project
Returns the project details for a project.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission for the project.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that the project description, issue types, and project lead are included in all responses by default:
description
The project description.issueTypes
The issue types associated with the project.lead
The project lead.projectKeys
All project keys associated with the project.issueTypeHierarchy
The project issue type hierarchy.
Type: string
properties
A comma-separated list of project properties to return for the project.
Type: array
[ "string" ]
get_project_category_by_id
Returns a project category.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the project category.
Type: integer
get_project_property
Returns the value of a project property.
This operation can be accessed anonymously.
Permissions required: Browse Projects project permission for the project containing the property.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
propertyKey (required)
The project property key. Use Get project property keys to get a list of all project property keys.
Type: string
get_project_role
Returns a project role's details and actors associated with the project. The list of actors is sorted by display name.
To check whether a user belongs to a role based on their group memberships, use Get user with the groups
expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project.
This operation can be accessed anonymously.
Permissions required: Administer Projects project permission for the project or Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the project role. Use Get all project roles to get a list of project role IDs.
Type: integer
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
get_project_role_by_id
Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the project role. Use Get all project roles to get a list of project role IDs.
Type: integer
get_project_type_by_key
Returns a project type.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
projectTypeKey (required)
The key of the project type.
Type: string
Potential values: ops, software, service_desk, business
get_remote_issue_link_by_id
Returns a remote issue link for an issue.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
linkId (required)
The ID of the remote issue link.
Type: string
get_resolution
Returns an issue resolution value.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the issue resolution value.
Type: string
get_selected_time_tracking_implementation
Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
get_server_info
Returns information about the Jira instance.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
get_share_permission
Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.
This operation can be accessed anonymously.
Permissions required: None, however, a share permission is only returned for:
- filters owned by the user.
- filters shared with a group that the user is a member of.
- filters shared with a private project that the user has Browse projects project permission for.
- filters shared with a public project.
- filters shared with the public.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the filter.
Type: integer
permissionId (required)
The ID of the share permission.
Type: integer
get_shared_time_tracking_configuration
Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see Configuring time tracking.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
get_status
Returns a status. The status must be associated with a workflow to be returned.
If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
idOrName (required)
The ID or name of the status.
Type: string
get_status_category
Returns a status category. Status categories provided a mechanism for categorizing statuses.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
idOrKey (required)
The ID or key of the status category.
Type: string
get_task
Returns the status of a long-running asynchronous task.
When a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the operation that created the task for details. Task details are not permanently retained. As of September 2019, details are retained for 14 days although this period may change without notice.
Permissions required: either of:
- Administer Jira global permission.
- Creator of the task.
Parameters
cloudid (required)
Type: string
taskId (required)
The ID of the task.
Type: string
get_user
Returns a user.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
accountId
The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username
or key
is specified.
Type: string
expand
Use expand to include additional information about users in the response. This parameter accepts multiple values separated by a comma:
groups
includes all groups and nested groups to which the user belongs.applicationRoles
includes details of all the applications to which the user has access.
Type: string
key
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The key of the user. Required, unless accountId
or username
is specified.
Type: string
username
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The username of the user. Required, unless accountId
or key
is specified.
Type: string
get_user_email
Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.
Parameters
cloudid (required)
Type: string
accountId
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
. Note, this should be treated as an opaque identifier (i.e. do not assume any structure in the value). Required.
Type: string
get_user_email_bulk
Returns a user's email address. This API is only available to apps approved by Atlassian, according to these guidelines.
Parameters
cloudid (required)
Type: string
accountId
the account IDs of the users for which emails are required. An accountId
is an identifier that uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
. Note, this should be treated as an opaque identifier (i.e. do not assume any structure in the value).
Type: array
[ "string" ]
get_user_property
Returns the value of a user's property. If no property key is provided Get user property keys is called.
Permissions required:
- Administer Jira global permission, to get a property from any user.
- Access to Jira, to get a property from the calling user's record.
Note: These user properties are unrelated to the Jira properties that are set in Jira.
Parameters
cloudid (required)
Type: string
propertyKey (required)
The key of the user's property.
Type: string
accountId
The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username
or userKey
is specified.
Type: string
userKey
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The key of the user. Required, unless accountId
or username
is specified.
Type: string
username
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The username of the user. Required, unless accountId
or userKey
is specified.
Type: string
get_valid_project_key
Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
key
The project key.
Type: string
get_valid_project_name
Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in use, this operation attempts to generate a valid project name based on the one supplied, usually by adding a sequence number. If a valid project name cannot be generated, a 404 response is returned.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
name
The project name.
Type: string
get_version
Returns a project version.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission for the project containing the version.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the version.
Type: string
expand
Use expand to include additional information about version in the response. This parameter accepts multiple values separated by a comma:
operations
Returns the list of operations available for this version.issuesstatus
Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property represents the number of issues with a status other than to do, in progress, and done.
Type: string
get_workflow
Returns the workflow-issue type mappings for a workflow scheme.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme.
Type: integer
returnDraftIfExists
Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.
Type: boolean
workflowName
The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
Type: string
get_workflow_scheme
Returns a workflow scheme.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId
. For example, schemeId=10301.
Type: integer
returnDraftIfExists
Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned.
Type: boolean
get_workflow_scheme_draft
Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See Configuring workflow schemes for more information.
Note that:
- Only active workflow schemes can have draft workflow schemes.
- An active workflow scheme can only have one draft workflow scheme.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the active workflow scheme that the draft was created from.
Type: integer
get_workflow_scheme_draft_issue_type
Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme that the draft belongs to.
Type: integer
issueType (required)
The ID of the issue type.
Type: string
get_workflow_scheme_issue_type
Returns the issue type-workflow mapping for an issue type in a workflow scheme.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme.
Type: integer
issueType (required)
The ID of the issue type.
Type: string
returnDraftIfExists
Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.
Type: boolean
get_worklog
Returns a worklog.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the worklog.
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
expand
Use expand to include additional information about work logs in the response. This parameter accepts multiple values separated by a comma:
properties
Returns worklog properties.
Type: string
get_worklog_property
Returns the value of a worklog property.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
propertyKey (required)
The key of the property.
Type: string
worklogId (required)
The ID of the worklog.
Type: string
link_issues
Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally add a comment to the from (outward) issue. To use this resource the site must have Issue Linking enabled.
This resource returns nothing on the creation of an issue link. To obtain the ID of the issue link, use https://your-domain.atlassian.net/rest/api/2/issue/[linked issue key]?fields=issuelinks
.
If the link request duplicates a link, the response indicates that the issue link was created. If the request included a comment, the comment is added.
This operation can be accessed anonymously.
Permissions required:
- Browse project project permission for all the projects containing the issues to be linked,
- Link issues project permission on the project containing the from (outward) issue,
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
$body
The issue link request.
Type: object
{
"outwardIssue" : {
"self" : "The URL of the issue.",
"id" : "The ID of an issue. Required if `key` isn't provided.",
"fields" : {
"summary" : "The summary description of the linked issue.",
"issueType" : {
"avatarId" : "The ID of the issue type's avatar.",
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the issue type.",
"self" : "The URL of these issue type details.",
"description" : "The description of the issue type.",
"entityId" : "project unique ID for next-gen entities",
"id" : "The ID of the issue type.",
"iconUrl" : "The URL of the issue type's avatar.",
"subtask" : "Indicates whether this issue type is used to create subtasks."
},
"issuetype" : {
"avatarId" : "The ID of the issue type's avatar.",
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the issue type.",
"self" : "The URL of these issue type details.",
"description" : "The description of the issue type.",
"entityId" : "project unique ID for next-gen entities",
"id" : "The ID of the issue type.",
"iconUrl" : "The URL of the issue type's avatar.",
"subtask" : "Indicates whether this issue type is used to create subtasks."
},
"assignee" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"priority" : {
"statusColor" : "The color used to indicate the issue priority.",
"name" : "The name of the issue priority.",
"self" : "The URL of the issue priority.",
"description" : "The description of the issue priority.",
"iconUrl" : "The URL of the icon for the issue priority.",
"id" : "The ID of the issue priority."
},
"status" : {
"name" : "The name of the status.",
"self" : "The URL of the status.",
"description" : "The description of the status.",
"iconUrl" : "The URL of the icon used to represent the status.",
"id" : "The ID of the status.",
"statusCategory" : {
"colorName" : "The name of the color used to represent the status category.",
"name" : "The name of the status category.",
"self" : "The URL of the status category.",
"id" : "The ID of the status category.",
"key" : "The key of the status category."
}
}
},
"key" : "The key of an issue. Required if `id` isn't provided."
},
"comment" : {
"renderedBody" : "The rendered version of the comment.",
"visibility" : {
"type" : "Indicates whether visibility of this item is restricted to a group or role.",
"value" : "The name of the group or role to which visibility of this item is restricted."
},
"author" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"created" : "The date and time at which the comment was created.",
"updateAuthor" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"self" : "The URL of the comment.",
"jsdPublic" : "Indicates whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation.",
"id" : "The ID of the comment.",
"body" : "The comment text.",
"updated" : "The date and time at which the comment was updated last.",
"properties" : [ {
"value" : { },
"key" : "The key of the property. Required on create and update."
} ]
},
"inwardIssue" : {
"self" : "The URL of the issue.",
"id" : "The ID of an issue. Required if `key` isn't provided.",
"fields" : {
"summary" : "The summary description of the linked issue.",
"issueType" : {
"avatarId" : "The ID of the issue type's avatar.",
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the issue type.",
"self" : "The URL of these issue type details.",
"description" : "The description of the issue type.",
"entityId" : "project unique ID for next-gen entities",
"id" : "The ID of the issue type.",
"iconUrl" : "The URL of the issue type's avatar.",
"subtask" : "Indicates whether this issue type is used to create subtasks."
},
"issuetype" : {
"avatarId" : "The ID of the issue type's avatar.",
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the issue type.",
"self" : "The URL of these issue type details.",
"description" : "The description of the issue type.",
"entityId" : "project unique ID for next-gen entities",
"id" : "The ID of the issue type.",
"iconUrl" : "The URL of the issue type's avatar.",
"subtask" : "Indicates whether this issue type is used to create subtasks."
},
"assignee" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"priority" : {
"statusColor" : "The color used to indicate the issue priority.",
"name" : "The name of the issue priority.",
"self" : "The URL of the issue priority.",
"description" : "The description of the issue priority.",
"iconUrl" : "The URL of the icon for the issue priority.",
"id" : "The ID of the issue priority."
},
"status" : {
"name" : "The name of the status.",
"self" : "The URL of the status.",
"description" : "The description of the status.",
"iconUrl" : "The URL of the icon used to represent the status.",
"id" : "The ID of the status.",
"statusCategory" : {
"colorName" : "The name of the color used to represent the status category.",
"name" : "The name of the status category.",
"self" : "The URL of the status category.",
"id" : "The ID of the status category.",
"key" : "The key of the status category."
}
}
},
"key" : "The key of an issue. Required if `id` isn't provided."
},
"type" : {
"inward" : "The description of the issue link type inward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-2-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-2-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.",
"name" : "The name of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-2-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-2-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.",
"self" : "The URL of the issue link type. Read only.",
"id" : "The ID of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-2-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-2-issueLinkType-post) resource it is read only.",
"outward" : "The description of the issue link type outward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-2-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-2-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only."
}
}
list_advanced_settings
Returns the application properties that are accessible on the Advanced Settings page. To navigate to the Advanced Settings page in Jira, choose the Jira icon > Jira settings > System, General Configuration and then click Advanced Settings (in the upper right).
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
list_all_users
Returns a list of all (active and inactive) users.
Permissions required: Browse users and groups global permission.
Parameters
cloudid (required)
Type: string
list_alternative_issue_types
Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the issue type.
Type: string
list_application_roles
Returns all application roles. In Jira, application roles are managed using the Application access configuration page.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
list_attachment_settings
Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.
Note that there are also project permissions that restrict whether users can create and delete attachments.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
list_audit_records
Returns a list of audit records. The list can be filtered to include items:
- containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
- created on or after a date and time.
- created or or before a date and time.
- created during a time period.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
filter
The query string.
Type: string
from
The date and time on or after which returned audit records must have been created. If to
is provided from
must be before to
or no audit records are returned.
Type: date-time
limit
The maximum number of results to return. The maximum is 1000
.
Type: integer
offset
The number of records to skip before returning the first result.
Type: integer
to
The date and time on or before which returned audit results must have been created. If from
is provided to
must be after from
or no audit records are returned.
Type: date-time
list_available_screen_fields
Returns the fields that can be added to a tab on a screen.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
screenId (required)
The ID of the screen.
Type: integer
list_available_time_tracking_implementations
Returns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the Time Tracking Provider module.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
list_avatars
Returns the system and custom avatars for a project or issue type.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
entityId (required)
The ID of the entity item.
Type: string
type (required)
The type of the entity. Valid values are project
and issuetype
.
Type: string
list_bulk_permissions
Returns:
- for a list of global permissions, the global permissions granted to the user.
- for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.
Note that:
- Invalid project and issue IDs are ignored.
- A maximum of 1000 projects and 1000 issues can be checked.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
$body
Details of the permissions to check.
Type: object
{
"globalPermissions" : [ "string" ],
"projectPermissions" : [ {
"projects" : [ "integer" ],
"permissions" : [ "string" ],
"issues" : [ "integer" ]
} ]
}
list_change_logs
Returns all changelogs for an issue sorted by date, starting from the oldest.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
list_columns_for_filter
Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in List View with the Columns set to Filter.
This operation can be accessed anonymously.
Permissions required: None, however, column details are only returned for:
- filters owned by the user.
- filters shared with a group that the user is a member of.
- filters shared with a private project that the user has Browse projects project permission for.
- filters shared with a public project.
- filters shared with the public.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the filter.
Type: integer
list_comments
Returns all comments for an issue.
This operation can be accessed anonymously.
Permissions required: Comments are included in the response where the user has:
- Browse projects project permission for the project containing the comment.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
expand
Use expand to include additional information about comments in the response. This parameter accepts renderedBody
, which returns the comment body rendered in HTML.
Type: string
orderBy
The field to order returned comments by. Only accepts the value created, which orders comments by their created date.
Type: string
Potential values: created, -created
list_comments_by_ids
Returns the comments for a list of comment IDs.
This operation can be accessed anonymously.
Permissions required: Comments are returned where the user:
- has Browse projects project permission for the project containing the comment.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
$body
The list of comment IDs.
Type: object
{
"ids" : [ "integer" ]
}
expand
Use expand to include additional information about comments in the response. This parameter accepts multiple values separated by a comma:
renderedBody
Returns the comment body rendered in HTML.properties
Returns the comment's properties.
Type: string
list_dashboards
Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
filter
The filter applied to the list of dashboards. Valid values are:
favourite
Returns dashboards the user has marked as favorite.my
Returns dashboards owned by the user.
Type: string
Potential values: my, favourite
list_default_actors_for_project_role
Returns the default actors for the project role.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the project role. Use Get all project roles to get a list of project role IDs.
Type: integer
list_default_columns_for_issue_navigator
Returns the default issue navigator columns.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
list_details_for_project_role
Returns all project roles and the details for each role. Note that the list of project roles is common to all projects.
This operation can be accessed anonymously.
Permissions required: Administer Jira global permission or Administer projects project permission for the project.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
currentMember
Whether the roles should be filtered to include only those the user is assigned to.
Type: boolean
list_details_for_worklogs
Returns worklog details for a list of worklog IDs.
The returned list of worklogs is limited to 1000 items.
Permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:
- the worklog is set as Viewable by All Users.
- the user is a member of a project role or group with permission to view the worklog.
Parameters
cloudid (required)
Type: string
$body
A JSON object containing a list of worklog IDs.
Type: object
{
"ids" : [ "integer" ]
}
expand
Use expand to include additional information about worklogs in the response. This parameter accepts properties
that returns the properties of each worklog.
Type: string
list_dynamic_webhooks_for_app
Returns the webhooks registered by the calling app.
Permissions required: Only Connect apps can use this operation.
Parameters
cloudid (required)
Type: string
list_favourite_filters
Returns the visible favorite filters of the user.
This operation can be accessed anonymously.
Permissions required: A favorite filter is only visible to the user where the filter is:
- owned by the user.
- shared with a group that the user is a member of.
- shared with a private project that the user has Browse projects project permission for.
- shared with a public project.
- shared with the public.
For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.
Parameters
cloudid (required)
Type: string
expand
Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
sharedUsers
Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers
, then thesharedUsers
object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]
to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000]
.subscriptions
Returns the users that are subscribed to the filter. If you don't specifysubscriptions
, thesubscriptions
object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]
to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
.
Type: string
list_fields
Returns system and custom issue fields according to the following rules:
- Fields that cannot be added to the issue navigator are always returned.
- Fields that cannot be placed on an issue screen are always returned.
- Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.
- For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has Browse Projects project permission for.)
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
list_groups_for_user
Returns the groups to which a user belongs.
Permissions required: Browse users and groups global permission.
Parameters
cloudid (required)
Type: string
accountId
The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username
or key
is specified.
Type: string
key
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The key of the user. Required, unless accountId
or username
is specified.
Type: string
username
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The username of the user. Required, unless accountId
or key
is specified.
Type: string
list_ids_of_worklogs_modified_since
Returns a list of IDs and update timestamps for worklogs updated after a date and time.
This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until
indicates the timestamp of the youngest item on the page. Also, nextPage
provides the URL for the next page of worklogs. The lastPage
parameter is set to true on the last page of worklogs.
This resource does not return worklogs updated during the minute preceding the request.
Permissions required: Permission to access Jira, however, worklogs are only returned where either of the following is true:
- the worklog is set as Viewable by All Users.
- the user is a member of a project role or group with permission to view the worklog.
Parameters
cloudid (required)
Type: string
expand
Use expand to include additional information about worklogs in the response. This parameter accepts properties
that returns the properties of each worklog.
Type: string
since
The date and time, in UNIX timestamp format, after which updated worklogs are returned.
Type: integer
list_issue_field_options
Returns all options defined for a select list issue field. A select list issue field is a type of issue field that allows a user to select n value from a list of options.
Note that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.
Parameters
cloudid (required)
Type: string
fieldKey (required)
The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field.
Type: string
list_issue_security_schemes
Returns all issue security schemes.
This operation can be accessed anonymously.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
list_issue_types
Returns all issue types.
This operation can be accessed anonymously.
Permissions required: Issue types are only returned as follows:
- if the user has the Administer Jira global permission, all issue types are returned.
- if the user has the Browse projects project permission for one or more projects, the issue types associated with the projects the user has permission to browse are returned.
Parameters
cloudid (required)
Type: string
list_labels
Returns a paginated list of available labels.
Parameters
cloudid (required)
Type: string
list_my_filters
Returns the filters owned by the user. If includeFavourites
is true
, the user's visible favorite filters are also returned.
Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:
- owned by the user.
- shared with a group that the user is a member of.
- shared with a private project that the user has Browse projects project permission for.
- shared with a public project.
- shared with the public.
For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.
Parameters
cloudid (required)
Type: string
expand
Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
sharedUsers
Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers
, then thesharedUsers
object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]
to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000]
.subscriptions
Returns the users that are subscribed to the filter. If you don't specifysubscriptions
, thesubscriptions
object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]
to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
.
Type: string
includeFavourites
Include the user's favorite filters in the response.
Type: boolean
list_my_permissions
Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.
The user is reported as having a project permission:
- in the global context, if the user has the project permission in any project.
- for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
- for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.
This means that users may be shown as having an issue permission (such as EDIT_ISSUE) in the global context or a project context but may not have the permission for any or all issues. For example, if Reporters have the EDIT_ISSUE permission a user would be shown as having this permission in the global context or the context of a project, because any user can be a reporter. However, if they are not the user who reported the issue queried they would not have EDIT_ISSUE permission for that issue.
Global permissions are unaffected by context.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
issueId
The ID of the issue.
Type: string
issueKey
The key of the issue. Ignored if issueId
is provided.
Type: string
permissions
A comma-separated list of permission keys. Omitting this parameter is deprecated. To get the list of available permissions, use Get all permissions. Note that deprecated keys cannot be used. Deprecated keys are not returned by Get all permissions but are returned by this operation if permissions
is omitted.
Type: string
projectConfigurationUuid
Type: string
projectId
The ID of project.
Type: string
projectKey
The key of project. Ignored if projectId
is provided.
Type: string
projectUuid
Type: string
list_notification_schemes_paginated
Returns a paginated list of notification schemes in order by display name.
About notification schemes
A notification scheme is a list of events and recipients who will receive notifications for those events. The list is contained within the notificationSchemeEvents
object and contains pairs of events
and notifications
:
event
Identifies the type of event. The events can be Jira system events or custom events.notifications
Identifies the recipients of notifications for each event. Recipients can be any of the following types:CurrentAssignee
Reporter
CurrentUser
ProjectLead
ComponentLead
User
(theparameter
is the user key)Group
(theparameter
is the group name)ProjectRole
(theparameter
is the project role ID)EmailAddress
AllWatchers
UserCustomField
(theparameter
is the ID of the custom field)GroupCustomField
(theparameter
is the ID of the custom field)
Note that you should allow for events without recipients to appear in responses.
Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.
Parameters
cloudid (required)
Type: string
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
all
Returns all expandable information.field
Returns information about any custom fields assigned to receive an event.group
Returns information about any groups assigned to receive an event.notificationSchemeEvents
Returns a list of event associations. This list is returned for all expandable information.projectRole
Returns information about any project roles assigned to receive an event.user
Returns information about any users assigned to receive an event.
Type: string
list_options_for_visible_issue_field
Returns options defined for a select list issue field that can be viewed by the user.
Note that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
fieldKey (required)
The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field.
Type: string
projectId
Filters the results to options that are only available in the specified project.
Type: integer
list_permission_scheme_grants
Returns all permission grants for a permission scheme.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
schemeId (required)
The ID of the permission scheme.
Type: integer
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:
permissions
Returns all permission grants for each permission scheme.user
Returns information about the user who is granted the permission.group
Returns information about the group that is granted the permission.projectRole
Returns information about the project role granted the permission.field
Returns information about the custom field granted the permission.all
Returns all expandable information.
Type: string
list_permission_schemes
Returns all permission schemes.
About permission schemes and grants
A permission scheme is a collection of permission grants. A permission grant consists of a holder
and a permission
.
Holder
The holder
object contains information about the user or group being granted the permission. For example, the Administer projects permission is granted to a group named Teams in space administrators. In this case, the type is "type": "group"
, and the parameter is the group name, "parameter": "Teams in space administrators"
. The holder
object is defined by the following properties:
type
Identifies the user or group (see the list of types below).parameter
The value of this property depends on thetype
. For example, if thetype
is a group, then you need to specify the group name.
The following types
are available. The expected values for the parameter
are given in parenthesis (some types
may not have a parameter
):
anyone
Grant for anonymous users.applicationRole
Grant for users with access to the specified application (application name). See Manage application access for more information.assignee
Grant for the user currently assigned to an issue.group
Grant for the specified group (group name).groupCustomField
Grant for a user in the group selected in the specified custom field (custom field ID).projectLead
Grant for a project lead.projectRole
Grant for the specified project role (project role ID).reporter
Grant for the user who reported the issue.sd.customer.portal.only
Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.user
Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).userCustomField
Grant for a user selected in the specified custom field (custom field ID).
Permissions
The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.
Project permissions
ADMINISTER_PROJECTS
BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION
(Jira Software only)SERVICEDESK_AGENT
(Jira Service Desk only)VIEW_DEV_TOOLS
(Jira Software only)VIEW_READONLY_WORKFLOW
Issue permissions
ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES
Voters and watchers permissions
MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS
Comments permissions
ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS
Attachments permissions
CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS
Time tracking permissions
DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:
all
Returns all expandable information.field
Returns information about the custom field granted the permission.group
Returns information about the group that is granted the permission.permissions
Returns all permission grants for each permission scheme.projectRole
Returns information about the project role granted the permission.user
Returns information about the user who is granted the permission.
Type: string
list_permissions
Returns all permissions, including:
- global permissions.
- project permissions.
- global permissions added by plugins.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
list_permitted_projects
Returns all the projects where the user is granted a list of project permissions.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
$body
Type: object
{
"permissions" : [ "string" ]
}
list_priorities
Returns the list of all issue priorities.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
list_project_avatars
Returns all project avatars, grouped by system and custom avatars.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission for the project.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The ID or (case-sensitive) key of the project.
Type: string
list_project_categories
Returns all project categories.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
list_project_components_for_project
Returns all components in a project. See the Get project components paginated resource if you want to get a full list of components with pagination.
This operation can be accessed anonymously.
Permissions required: Browse Projects project permission for the project.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
list_project_components_paginated
Returns a paginated representation of all components in a project. See the Get project components resource if you want to get a full list of versions without pagination.
This operation can be accessed anonymously.
Permissions required: Browse Projects project permission for the project.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
orderBy
Order the results by a field:
description
Sorts components in alphabetical order by description.issueCount
Sorts components by the count of issues associated with the component in ascending order.lead
Sorts by the project lead's user key in alphabetical order.name
Sorts components in alphabetical order by component name.
Type: string
Potential values: description, -description, +descriptionissueCount, -issueCount, +issueCountlead, -lead, +lead, name, -name, +name
query
Filter the results using a literal string. Components with a matching name
or description
are returned (case insensitive).
Type: string
list_project_property_keys
Returns all project property keys for the project.
This operation can be accessed anonymously.
Permissions required: Browse Projects project permission for the project.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
list_project_roles
Gets a list of all project roles, complete with project role details and default actors.
About project roles
Project roles are a flexible way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have a different set of actors associated with it (unlike groups, which have the same membership throughout all Jira applications).
Project roles are used in permission schemes, email notification schemes, issue security levels, comment visibility, and workflow conditions.
Members and actors
In the Jira REST API, a member of a project role is called an actor. An actor is a group or user associated with a project role.
Actors may be set as default members of the project role or set at the project level:
- Default actors: Users and groups that are assigned to the project role for all newly created projects. The default actors can be removed at the project level later if desired.
- Actors: Users and groups that are associated with a project role for a project, which may differ from the default actors. This enables you to assign a user to different roles in different projects.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
list_project_roles_for_project
Returns a list of project roles for the project returning the name and self URL for each role.
Note that all project roles are shared with all projects in Jira Cloud. See Get all project roles for more information.
This operation can be accessed anonymously.
Permissions required: Administer Projects project permission for any project on the siteAdminister Jira or global permission.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
list_project_types
Returns all project types, whether or not the instance has a valid license for each type.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
list_project_versions
Returns a paginated representation of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination.
This operation can be accessed anonymously.
Permissions required: Browse Projects project permission for the project.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
issuesstatus
Returns the number of issues in each status category for each version.operations
Returns actions that can be performed on the specified version.
Type: string
orderBy
Order the results by a field:
description
Sorts versions in alphabetical order by description.name
Sorts versions in alphabetical order by version name.releaseDate
Sorts versions in order by release date, starting with the oldest date. Versions with no release date are listed last.sequence
Sorts versions by the order of appearance in the user interface.startDate
Sorts versions in order by start date, starting with the oldest date. Versions with no start date are listed last.
Type: string
Potential values: description, -description, +description, name, -name, +name, releaseDate, -releaseDate, +releaseDate, sequence, -sequence, +sequence, startDate, -startDate, +startDate
query
Filter the results using a literal string. Versions with matching name
or description
are returned (case insensitive).
Type: string
status
A comma-separated list of status values used to filter the results by version status. The status values are released
, unreleased
, and archived
.
Type: string
list_projects
Returns projects visible to the user.
This operation can be accessed anonymously.
Permissions required: Projects are returned only where the user has Browse Projects project permission for the project.
Parameters
cloudid (required)
Type: string
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
description
Returns the project description.projectKeys
Returns all project keys associated with a project.lead
Returns information about the the project lead.issueTypes
Returns all issue types associated with the project.url
Returns the URL associated with the project.
Type: string
orderBy
Order the results by a field. If the orderBy
field is not set, then projects are listed in ascending order by project key:
category
Sorts projects in order by project category. A complete list of category IDs is found using the Get all project categories operation.key
Sorts projects in order by project key.name
Sorts projects in alphabetical order by project name.owner
Sorts projects in order by the project lead.
Type: string
Potential values: category, -category, +category, key, -key, +key, name, -name, +name, owner, -owner, +owner
typeKey
Orders results by the project type. This parameter accepts multiple values separated by a comma. Valid values are business
, ops
, service_desk
, and software
.
Type: string
list_property_keys_for_comment
Returns the keys of all the properties of a comment.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
commentId (required)
The ID of the comment.
Type: string
list_property_keys_for_dashboard_item
Returns the keys of all properties for a dashboard item.
This operation can be accessed anonymously.
Permissions required: The user must be the owner of the dashboard or be shared the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.
Parameters
cloudid (required)
Type: string
dashboardId (required)
The ID of the dashboard.
Type: string
itemId (required)
The ID of the dashboard item.
Type: string
list_property_keys_for_issue
Returns the URLs and keys of an issue's properties.
This operation can be accessed anonymously.
Permissions required: Property details are only returned where the user has:
- Browse projects project permission for the project containing the issue.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The key or ID of the issue.
Type: string
list_property_keys_for_issue_type
Returns all the issue type property keys of the issue type.
This operation can be accessed anonymously.
Permissions required:
- Administer Jira global permission to get the property keys of any issue type.
- Browse projects project permission to get the property keys of any issue types associated with the projects the user has permission to browse.
Parameters
cloudid (required)
Type: string
issueTypeId (required)
The ID of the issue type.
Type: string
list_property_keys_for_user
Returns the keys of all properties for a user.
Permissions required:
- Administer Jira global permission, to access the property keys on any user.
- Access to Jira, to access the calling user's property keys.
Note: These user properties are unrelated to the Jira properties that are set in Jira.
Parameters
cloudid (required)
Type: string
accountId
The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username
or userKey
is specified.
Type: string
userKey
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The key of the user. Required, unless accountId
or username
is specified.
Type: string
username
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The username of the user. Required, unless accountId
or userKey
is specified.
Type: string
list_property_keys_for_worklog
Returns the keys of all properties for a worklog.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
worklogId (required)
The ID of the worklog.
Type: string
list_remote_issue_links
Returns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
globalId
The global ID of the remote issue link.
Type: string
list_resolutions
Returns a list of all issue resolution values.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
list_screen_tab_fields
Returns all fields for a screen tab.
Permissions required:
- Administer Jira global permission.
- Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
Parameters
cloudid (required)
Type: string
screenId (required)
The ID of the screen.
Type: integer
tabId (required)
The ID of the screen tab.
Type: integer
projectKey
The key of the project.
Type: string
list_screen_tabs
Returns the list of tabs for a screen.
Permissions required:
- Administer Jira global permission.
- Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
Parameters
cloudid (required)
Type: string
screenId (required)
The ID of the screen.
Type: integer
projectKey
The key of the project.
Type: string
list_screens
Returns all screens.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
list_security_levels_for_project
Returns all issue security levels for the project that the user has access to.
This operation can be accessed anonymously.
Permissions required: Browse projects global permission for the project, however, issue security levels are only returned for authenticated user with Set Issue Security global permission for the project.
Parameters
cloudid (required)
Type: string
projectKeyOrId (required)
The project ID or project key (case sensitive).
Type: string
list_selectable_issue_field_options
Returns options defined for a select list issue field that can be viewed and selected by the user.
Note that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
fieldKey (required)
The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field.
Type: string
projectId
Filters the results to options that are only available in the specified project.
Type: integer
list_share_permissions_for_filter
Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.
This operation can be accessed anonymously.
Permissions required: None, however, share permissions are only returned for:
- filters owned by the user.
- filters shared with a group that the user is a member of.
- filters shared with a private project that the user has Browse projects project permission for.
- filters shared with a public project.
- filters shared with the public.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the filter.
Type: integer
list_status_categories
Returns a list of all status categories.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
list_statuses
Returns a list of all statuses associated with workflows.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
list_statuses_for_project
Returns the valid statuses for a project. The statuses are grouped by issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.
This operation can be accessed anonymously.
Permissions required: Browse Projects project permission for the project.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
list_system_avatars
Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
type (required)
The avatar type.
Type: string
Potential values: issuetype, project, user
list_transition_rule_configurations_for_workflow
Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:
- of one or more transition rule types, such as workflow post functions.
- matching one or more transition rule keys.
Only workflows containing transition rules created by the calling Connect app are returned. However, if a workflow is returned all transition rules that match the filters are returned for that workflow.
Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.
Permissions required: Only Connect apps can use this operation.
Parameters
cloudid (required)
Type: string
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
transition
For each rule, returns information about the transition the rule is assigned to.
Type: string
keys
The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return.
Type: array
[ "string" ]
types
The types of the transition rules to return.
Type: array
[ "string. Possible values: postfunction | condition | validator" ]
list_transitions_for_issue
Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.
Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list.
This operation can be accessed anonymously.
Permissions required: A list or transition is returned only when the user has:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
However, if the user does not have the Transition issues project permission the response will not list any transitions.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
expand
Use expand to include additional information about transitions in the response. This parameter accepts transitions.fields
which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the fields
and update
fields in Transition issue.
Type: string
skipRemoteOnlyCondition
Indicates whether transitions with the condition Hide From User Condition are included in the response.
Type: boolean
transitionId
The ID of the transition.
Type: string
list_unresolved_issues_for_version
Returns counts of the issues and unresolved issues for the project version.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission for the project that contains the version.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the version.
Type: string
list_user_default_columns
Returns the default issue table columns for the user. If a username is not passed in the request, the calling user's details are returned.
Permissions required:
- Administer Jira global permission, to get the column details for any user.
- Permission to access Jira, to get the calling user's column details.
Parameters
cloudid (required)
Type: string
accountId
The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Cannot be provided with username
.
Type: string
username
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The username of the user. Cannot be provided with accountId
.
Type: string
list_users
Returns details of the users specified in one or more user key, username, or user account ID parameters.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
accountId
Account ID of a user. To specify multiple users, pass multiple accountId
parameters. For example, accountId=99:27935d01-92a7-4687-8272-a9b8d3b2ae2e&accountId=26912:8347-325f-ef346-bd0342234324
Required if key
or username
isn't provided. Cannot be provided if key
or username
is present.
Type: array
[ "string" ]
key
This parameter is deprecated because of privacy changes. Use accountIDs
instead. See the migration guide for details. Key of a user. To specify multiple users, pass multiple key
parameters. For example, key=fred&key=barney
Required if username
or accountID
isn't provided. Cannot be provided if username
or accountID
is present.
Type: array
[ "string" ]
username
This parameter is deprecated because of privacy changes. Use accountIDs
instead. See the migration guide for details. Username of a user. To specify multiple users, pass multiple username
parameters. For example, username=fred&username=barney
. Required if key
or accountID
isn't provided. Cannot be provided if key
or accountID
is present.
Type: array
[ "string" ]
list_users_in_group
Returns all users in a group. Users are ordered by username.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
groupname
The name of the group.
Type: string
includeInactiveUsers
Include inactive users.
Type: boolean
list_versions_for_project
Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to get the versions in a project with pagination.
This operation can be accessed anonymously.
Permissions required: Browse Projects project permission for the project.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
operations
Returns actions that can be performed on the specified version.
Type: string
list_votes_for_issue
Returns details about the votes on an issue.
This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is ini
- If issue-level security is configured, issue-level security permission to view the issue.
Note that users with the necessary permissions for this operation but without the View voters and watchers project permissions are not returned details in the voters
field.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
list_watchers_for_issue
Returns the watchers for an issue.
This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is ini
- If issue-level security is configured, issue-level security permission to view the issue.
- To see details of users on the watchlist other than themselves, View voters and watchers project permission for the project that the issue is in.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
list_workflow_schemes
Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any next-gen or non-existent projects in the request are ignored and no errors are returned.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
projectId
The ID of a project to return the workflow schemes for. To include multiple projects, provide multiple copies of this parameter. For example, projectId=10000&projectId=10001
.
Type: array
[ "integer" ]
list_workflow_transition_properties
Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
transitionId (required)
The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.
Type: integer
includeReservedKeys
Some properties with keys that have the jira. prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to true.
Type: boolean
key
The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.
Type: string
workflowMode
The workflow status. Set to live for active and inactive workflows, or draft for draft workflows.
Type: string
Potential values: live, draft
workflowName
The name of the workflow that the transition belongs to.
Type: string
list_workflows_paginated
Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.
This operation does not return next-gen workflows.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
transition
For each workflow, returns information about the transitions inside the workflow.statuses
For each workflow, returns information about the statuses inside the workflow.statuses.properties
For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested.
Type: string
workflowName
The name of a workflow to return.
Type: array
[ "string" ]
match_issues
Checks whether one or more issues would be returned by one or more JQL queries.
Permissions required: None, however, issues are only matched against JQL queries where the user has:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
$body
List of issues and JQL queries.
Type: object
{
"issueIds" : [ "A list of issue IDs." ],
"jqls" : [ "A list of JQL queries." ]
}
merge_versions
Merges two project versions. The merge is completed by deleting the version specified in id
and replacing any occurrences of its ID in fixVersion
with the version ID specified in moveIssuesTo
.
Consider using Delete and replace version instead. This resource supports swapping version values in fixVersion
, affectedVersion
, and custom fields.
This operation can be accessed anonymously.
Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the version to delete.
Type: string
moveIssuesTo (required)
The ID of the version to merge into.
Type: string
migrate_queries
Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.
You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
$body
The JQL queries to be converted.
Type: object
{
"queryStrings" : [ "string" ]
}
move_screen_tab
Moves a screen tab.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
pos (required)
The position of tab. The base index is 0.
Type: integer
screenId (required)
The ID of the screen.
Type: integer
tabId (required)
The ID of the screen tab.
Type: integer
move_screen_tab_field
Moves a screen tab field.
If after
and position
are provided in the request, position
is ignored.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the field.
Type: string
screenId (required)
The ID of the screen.
Type: integer
tabId (required)
The ID of the screen tab.
Type: integer
$body
Type: object
{
"after" : "The ID of the screen tab field after which to place the moved screen tab field. Required if `position` isn't provided.",
"position" : "The named position to which the screen tab field should be moved. Required if `after` isn't provided."
}
move_version
Modifies the version's sequence within the project, which affects the display order of the versions in Jira.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission for the project that contains the version.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the version to be moved.
Type: string
$body
Type: object
{
"after" : "The URL (self link) of the version after which to place the moved version. Cannot be used with `position`.",
"position" : "An absolute position in which to place the moved version. Cannot be used with `after`."
}
notify_for_issue
Creates an email notification for an issue and adds it to the mail queue.
Permissions required:
- Browse Projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
ID or key of the issue that the notification is sent for.
Type: string
$body
The request object for the notification and recipients.
Type: object
{
"htmlBody" : "The HTML body of the email notification for the issue.",
"subject" : "The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary.",
"textBody" : "The plain text body of the email notification for the issue.",
"to" : {
"voters" : "Indicates whether the notification should be sent to the issue's voters.",
"watchers" : "Indicates whether the notification should be sent to the issue's watchers.",
"groups" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ],
"reporter" : "Indicates whether the notification should be sent to the issue's reporter.",
"assignee" : "Indicates whether the notification should be sent to the issue's assignees.",
"users" : [ {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
} ]
},
"restrict" : {
"permissions" : [ {
"id" : "The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-2-permissions-get) to get the list of permissions.",
"key" : "The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-2-permissions-get) to get the list of permissions."
} ],
"groups" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
}
}
partial_update_project_role
Updates either the project role's name or its description.
You cannot update both the name and description at the same time using this operation. If you send a request with a name and a description only the name is updated.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the project role. Use Get all project roles to get a list of project role IDs.
Type: integer
$body
Type: object
{
"name" : "The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.",
"description" : "A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role."
}
refresh_webhooks
Webhooks registered through the REST API expire after 30 days. Call this resource periodically to keep them alive.
Unrecognized webhook IDs (nonexistent or belonging to other apps) are ignored. Permissions required: Only Connect apps can use this operation.
Parameters
cloudid (required)
Type: string
$body
Container for a list of webhook IDs.
Type: object
{
"webhookIds" : [ "A list of webhook IDs." ]
}
register_dynamic_webhooks
Registers webhooks.
Permissions required: Only Connect apps can use this operation.
Parameters
cloudid (required)
Type: string
$body
Details of webhooks to register.
Type: object
{
"webhooks" : [ {
"jqlFilter" : "The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL can be used. The supported elements are:\n\nFields: issueKey, project, issuetype, status, assignee, reporter, issue.property, and cf[id] (for custom fields—only the epic label custom field is supported).\nOperators: =, !=, IN, and NOT IN.\n",
"events" : [ "string. Possible values: jira:issue_created | jira:issue_updated | jira:issue_deleted | comment_created | comment_updated | comment_deleted" ]
} ],
"url" : "The URL that specifies where to send the webhooks."
}
remove_attachment
Deletes an attachment from an issue.
This operation can be accessed anonymously.
Permissions required: For the project holding the issue containing the attachment:
- Delete own attachments project permission to delete an attachment created by the calling user.
- Delete all attachments project permission to delete an attachment created by any user.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the attachment.
Type: string
remove_group
Deletes a group.
Permissions required: Site administration (that is, member of the site-admin strategic group).
Parameters
cloudid (required)
Type: string
groupname
The name of the group.
Type: string
swapGroup
The group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion.
Type: string
remove_preference
Deletes a preference of the user, which restores the default value of system defined settings.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
key
The key of the preference.
Type: string
remove_project_category
Deletes a project category.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
ID of the project category to delete.
Type: integer
remove_screen_tab_field
Removes a field from a screen tab.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the field.
Type: string
screenId (required)
The ID of the screen.
Type: integer
tabId (required)
The ID of the screen tab.
Type: integer
remove_user
Deletes a user.
Permissions required: Site administration (that is, membership of the site-admin group).
Parameters
cloudid (required)
Type: string
accountId
The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username
or key
is specified.
Type: string
key
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The key of the user. Required, unless accountId
or username
is specified.
Type: string
username
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The username of the user. Required, unless accountId
or key
is specified.
Type: string
remove_user_from_group
Removes a user from a group.
Permissions required: Site administration (that is, member of the site-admin group).
Parameters
cloudid (required)
Type: string
accountId
The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username
is specified.
Type: string
groupname
The name of the group.
Type: string
username
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The username of the user. Required, unless accountId
is specified.
Type: string
remove_vote
Deletes a user's vote from an issue. This is the equivalent of the user clicking Unvote on an issue in Jira.
This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
remove_watcher
Deletes a user as a watcher of an issue.
This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- To remove users other than themselves from the watchlist, Manage watcher list project permission for the project that the issue is in.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
accountId
The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username
is specified.
Type: string
username
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The username of the user. For example, admin. Required, unless accountId
is specified.
Type: string
rename_screen_tab
Updates the name of a screen tab.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
screenId (required)
The ID of the screen.
Type: integer
tabId (required)
The ID of the screen tab.
Type: integer
$body
A screen tab.
Type: object
{
"name" : "The name of the screen tab. Required on create and update. The maximum length is 255 characters.",
"id" : "The ID of the screen tab."
}
replace_issue_field_option
Deselects an issue-field select-list option from all issues where it is selected. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query.
This is an asynchronous operation. The response object contains a link to the long-running task.
Note that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.
Parameters
cloudid (required)
Type: string
fieldKey (required)
The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field.
Type: string
optionId (required)
The ID of the option to be deselected.
Type: integer
jql
A JQL query that specifies the issues to be updated. For example, project=10000.
Type: string
replaceWith
The ID of the option that will replace the currently selected option.
Type: integer
reset_columns
Reset the user's column configuration for the filter to the default.
Permissions required: Permission to access Jira, however, columns are only reset for:
- filters owned by the user.
- filters shared with a group that the user is a member of.
- filters shared with a private project that the user has Browse projects project permission for.
- filters shared with a public project.
- filters shared with the public.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the filter.
Type: integer
reset_user_columns
Resets the default issue table columns for the user to the system default. If a username or account ID is not passed, the calling user's default columns are reset.
Permissions required:
- Administer Jira global permission, to set the columns on any user.
- Permission to access Jira, to set the calling user's columns.
Parameters
cloudid (required)
Type: string
accountId
The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username
is specified.
Type: string
username
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The username of the user. Required, unless accountId
is specified.
Type: string
search_for_issues_using_jql
Searches for issues using JQL.
There is a GET version of this resource that can be used for smaller JQL query expressions.
This operation can be accessed anonymously.
Permissions required: Issues are included in the response where the user has:
- Browse projects project permission for the project containing the issue.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
$body
A JSON object containing the search request.
Type: object
{
"expand" : [ "string" ],
"jql" : "A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.",
"maxResults" : "The maximum number of items to return per page. The default is `50` and the maximum is `100`.",
"validateQuery" : "Determines how to validate the JQL query and treat the validation results. Supported values:\n\n * `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).\n * `warn` Returns all errors as warnings.\n * `none` No validation is performed.\n * `true` *Deprecated* A legacy synonym for `strict`.\n * `false` *Deprecated* A legacy synonym for `warn`.\n\nThe default is `strict`.\n\nNote: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value.",
"fieldsByKeys" : "Reference fields by their key (rather than ID). The default is `false`.",
"fields" : [ "string" ],
"startAt" : "The index of the first item to return in the page of results (page offset). The base index is `0`.",
"properties" : [ "string" ]
}
search_projects
Returns projects visible to the user.
This operation can be accessed anonymously.
Permissions required: Projects are returned only where the user has Browse Projects project permission for the project.
Parameters
cloudid (required)
Type: string
action
Filter results by projects for which the user can:
view
the project, meaning that they have one of the following permissions:- Browse projects project permission for the project.
- Administer projects project permission for the project.
- site administration (that is, member of the site-admin group).
browse
the project, meaning that they have the Browse projects project permission for the project.edit
the project, meaning that they have one of the following permissions:- Administer projects project permission for the project.
- site administration (that is, member of the site-admin group).
Type: string
Potential values: view, browse, edit
categoryId
The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.
Type: integer
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
description
Returns the project description.projectKeys
Returns all project keys associated with a project.lead
Returns information about the the project lead.issueTypes
Returns all issue types associated with the project.url
Returns the URL associated with the project.
Type: string
orderBy
Order the results by a field. If the orderBy
field is not set, then projects are listed in ascending order by project key:
category
Sorts projects in order by project category. A complete list of category IDs is found using the Get all project categories operation.key
Sorts projects in order by project key.name
Sorts projects in alphabetical order by project name.owner
Sorts projects in order by the project lead.
Type: string
Potential values: category, -category, +category, key, -key, +key, name, -name, +name, owner, -owner, +owner
query
Filter the results using a literal string. Projects with a matching key
or name
are returned (case insensitive).
Type: string
typeKey
Orders results by the project type. This parameter accepts multiple values separated by a comma. Valid values are business
, ops
, service_desk
, and software
.
Type: string
select_time_tracking_implementation
Selects a time tracking provider.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
Details about the time tracking provider.
Type: object
{
"name" : "The name of the time tracking provider. For example, *JIRA provided time tracking*.",
"key" : "The key for the time tracking provider. For example, *JIRA*.",
"url" : "The URL of the configuration page for the time tracking provider app. For example, */example/config/url*. This property is only returned if the `adminPageKey` property is set in the module descriptor of the time tracking provider app."
}
set_actors
Sets the actors for a project role for a project, replacing all existing actors.
To add actors to the project without overwriting the existing list, use Add actors to project role.
Permissions required: Administer Projects project permission for the project or Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the project role. Use Get all project roles to get a list of project role IDs.
Type: integer
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
$body
The groups or users to associate with the project role for this project. Provide the user account ID or group name.
Type: object
{
"categorisedActors" : "The actors to add to the project role. Add groups using `atlassian-group-role-actor` and a list of group names. For example, `\"atlassian-group-role-actor\":[\"another\",\"administrators\"]}`. Add users using `atlassian-user-role-actor` and a list of user keys or account ID. For example, `\"atlassian-user-role-actor\":[\"12345678-9abc-def1-2345-6789abcdef12\", \"abcdef12-3456-789a-bcde-f123456789ab\"]`If a mixed list of keys and account IDs is sent, the keys are ignored. Use of the key is deprecated because of privacy changes. Use account ID instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)for details.",
"id" : "The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs."
}
set_application_property
Changes the value of an application property. For example, you can change the value of the jira.clone.prefix
from its default value of CLONE - to Clone - if you prefer sentence case capitalization. Editable properties are described below along with their default values.
Advanced settings
The advanced settings below are also accessible in Jira.
Key Description Default value
jira.clone.prefix A string of text that automatically precedes the title of a cloned issue. CLONE -
jira.date.picker.java.format The date format for the Java (server-side) generated dates. This must be the same as the jira.date.picker.javascript.format format setting. d/MMM/yy
jira.date.picker.javascript.format This date format is for the JavaScript (client-side) generated dates. This must be the same as the jira.date.picker.java.format format setting. %e/%b/%y
jira.date.time.picker.java.format The date format for the Java (server-side) generated date times. This must be the same as the jira.date.time.picker.javascript.format format setting. dd/MMM/yy h:mm a
jira.date.time.picker.javascript.format This date format is for the JavaScript (client-side) generated date times. This must be the same as the jira.date.time.picker.java.format format setting. %e/%b/%y %I:%M %p
jira.issue.actions.order The default order of actions (such as Comments or Change history) displayed on the issue view. asc
jira.table.cols.subtasks The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue. issuetype, status, assignee, progress
jira.view.issue.links.sort.order The sort order of the list of issue links on the issue view. type, status, priority
jira.comment.collapsing.minimum.hidden The minimum number of comments required for comment collapsing to occur. A value of 0 disables comment collapsing. 4
jira.newsletter.tip.delay.days The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of -1 disables this functionality. 7
Look and feel
The settings listed below adjust the look and feel.
Key Description Default value
jira.lf.date.time Look and feel of the time format. h:mm a
jira.lf.date.day Look and feel of the day format. EEEE h:mm a
jira.lf.date.complete Look and feel of the date and time format. dd/MMM/yy h:mm a
jira.lf.date.dmy Look and feel of the date format. dd/MMM/yy
jira.date.time.picker.use.iso8061 When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard. false
jira.lf.logo.url The URL of the logo image file. /images/icon-jira-logo.png
jira.lf.logo.show.application.title Controls the visibility of the application title on the sidebar. false
jira.lf.favicon.url The URL of the favicon. /favicon.ico
jira.lf.favicon.hires.url The URL of the high resolution favicon. /images/64jira.png
jira.lf.top.adg3.bgcolour The background color of the sidebar. #0747A6
jira.lf.top.adg3.textcolour The color of the text and logo of the sidebar. #DEEBFF
jira.lf.hero.button.base.bg.colour
#3b7fc4
jira.title The text for the application title. The application title can also be set in General settings. Jira
jira.option.globalsharing boolean true
xflow.product.suggestions.enabled Indicates whether to expose product suggestions for other Atlassian products within Jira. true
Other settings
Key Description Default value
jira.issuenav.criteria.autoupdate Supports instant updates to search criteria. true
Note: Be careful when changing application properties and advanced settings.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The key of the application property to update.
Type: string
$body
Type: object
{
"id" : "The ID of the application property.",
"value" : "The new value."
}
set_columns
Sets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable
set to true
.
The parameters for this resource are expressed as HTML form data. For example, in curl:
curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns
Permissions required: Permission to access Jira, however, columns are only set for:
- filters owned by the user.
- filters shared with a group that the user is a member of.
- filters shared with a private project that the user has Browse projects project permission for.
- filters shared with a public project.
- filters shared with the public.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the filter.
Type: integer
$body
The IDs of the fields to set as columns. In the form data, specify each field as columns=id
, where id
is the id of a field (as seen in the response for Get fields). For example, columns=summary
.
Type: array
[ "string" ]
set_comment_property
Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
Permissions required: either of:
- Edit All Comments project permission to create or update the value of a property on any comment.
- Edit Own Comments project permission to create or update the value of a property on a comment created by the user.
Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.
Parameters
cloudid (required)
Type: string
commentId (required)
The ID of the comment.
Type: string
propertyKey (required)
The key of the property. The maximum length is 255 characters.
Type: string
$body
Type: object
{ }
set_dashboard_item_property
Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.
A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets.
When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation.
There is no resource to set or get dashboard items.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
This operation can be accessed anonymously.
Permissions required: The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.
Parameters
cloudid (required)
Type: string
dashboardId (required)
The ID of the dashboard.
Type: string
itemId (required)
The ID of the dashboard item.
Type: string
propertyKey (required)
The key of the dashboard item property. The maximum length is 255 characters.
Type: string
$body
Type: object
{ }
set_default_share_scope
Sets the default sharing for new filters and dashboards for a user.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
$body
Details of the scope of the default sharing for new filters and dashboards.
Type: object
{
"scope" : "The scope of the default sharing for new filters and dashboards:\n\n * `AUTHENTICATED` Shared with all logged-in users.\n * `GLOBAL` Shared with all logged-in users. This shows as `AUTHENTICATED` in the response.\n * `PRIVATE` Not shared with any users."
}
set_favourite_for_filter
Add a filter as a favorite for the user.
Permissions required: Permission to access Jira, however, the user can only favorite:
- filters owned by the user.
- filters shared with a group that the user is a member of.
- filters shared with a private project that the user has Browse projects project permission for.
- filters shared with a public project.
- filters shared with the public.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the filter.
Type: integer
expand
Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
sharedUsers
Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers
, then thesharedUsers
object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]
to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000]
.subscriptions
Returns the users that are subscribed to the filter. If you don't specifysubscriptions
, thesubscriptions
object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]
to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
.
Type: string
set_issue_navigator_default_columns
Sets the default issue navigator columns.
The columns
parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns
parameters. For example, in curl:
curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns
If no column details are sent, then all default columns are removed.
A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
A navigable field value.
Type: array
[ "string" ]
set_issue_property
Sets the value of an issue's property. Use this resource to store custom data against an issue.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
This operation can be accessed anonymously.
Permissions required:
- Browse projects and Edit issues project permissions for the project containing the issue.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
propertyKey (required)
The key of the issue property. The maximum length is 255 characters.
Type: string
$body
Type: object
{ }
set_issue_type_property
Creates or updates the value of the issue type property. Use this resource to store and update data against an issue type.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
issueTypeId (required)
The ID of the issue type.
Type: string
propertyKey (required)
The key of the issue type property. The maximum length is 255 characters.
Type: string
$body
Type: object
{ }
set_locale
Sets the locale of the user. The locale must be one supported by the instance of Jira.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
$body
The locale defined in a LocaleBean.
Type: object
{
"locale" : "The locale code. The Java the locale format is used: a two character language code (ISO 639), an underscore, and two letter country code (ISO 3166). For example, en\\_US represents a locale of English (United States). Required on create."
}
set_preference
Creates a preference for the user or updates a preference's value by sending a plain text string. For example, false
. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created:
- user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to
html
. - user.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to
false
. - jira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
- jira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
- user.default.share.private Indicates whether new filters are set to private. Defaults to
true
. - user.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to
false
. - user.autowatch.disabled Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.
Permissions required: Permission to access Jira.
Parameters
cloudid (required)
Type: string
$body
The value of the preference as a plain text string. The maximum length is 255 characters.
Type: string
key
The key of the preference. The maximum length is 255 characters.
Type: string
set_project_property
Sets the value of the project property. You can use project properties to store custom data against the project.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
This operation can be accessed anonymously.
Permissions required: Administer Jira global permission or Administer Projects project permission for the project in which the property is created.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
propertyKey (required)
The key of the project property. The maximum length is 255 characters.
Type: string
$body
Type: object
{ }
set_shared_time_tracking_configuration
Sets the time tracking settings.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
$body
Details of the time tracking configuration.
Type: object
{
"defaultUnit" : "The default unit of time applied to logged time.",
"workingHoursPerDay" : "The number of hours in a working day.",
"workingDaysPerWeek" : "The number of days in a working week.",
"timeFormat" : "The format that will appear on an issue's *Time Spent* field."
}
set_user_columns
Sets the default issue table columns for the user. If a username or account ID is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed.
The parameters for this resource are expressed as HTML form data. For example, in curl:
curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/user/columns?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192'
Permissions required:
- Administer Jira global permission, to set the columns on any user.
- Permission to access Jira, to set the calling user's columns.
Parameters
cloudid (required)
Type: string
$body
The ID of a column to set. To set multiple columns, send multiple columns
parameters.
Type: array
[ "string" ]
accountId
The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Cannot be provided with the form parameter username
.
Type: string
set_user_property
Sets the value of a user's property. Use this resource to store custom data against a user.
Permissions required:
- Administer Jira global permission, to set a property on any user.
- Access to Jira, to set a property on the calling user's record.
Note: These user properties are unrelated to the Jira properties that are set in Jira.
Parameters
cloudid (required)
Type: string
propertyKey (required)
The key of the user's property. The maximum length is 255 characters.
Type: string
$body
Type: object
{ }
accountId
The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username
or userKey
is specified.
Type: string
userKey
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The key of the user. Required, unless accountId
or username
is specified.
Type: string
username
This parameter is deprecated because of privacy changes. Use accountId
instead. See the migration guide for details.
The username of the user. Required, unless accountId
or userKey
is specified.
Type: string
set_workflow_scheme_draft_issue_type
Sets the workflow for an issue type in a workflow scheme's draft.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme that the draft belongs to.
Type: integer
issueType (required)
The ID of the issue type.
Type: string
$body
The issue type-project mapping.
Type: object
{
"issueType" : "The ID of the issue type. Not required if updating the issue type-workflow mapping.",
"workflow" : "The name of the workflow.",
"updateDraftIfNeeded" : "Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to `false`. Only applicable when updating the workflow-issue types mapping."
}
set_workflow_scheme_issue_type
Sets the workflow for an issue type in a workflow scheme.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded
to true
in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme.
Type: integer
issueType (required)
The ID of the issue type.
Type: string
$body
The issue type-project mapping.
Type: object
{
"issueType" : "The ID of the issue type. Not required if updating the issue type-workflow mapping.",
"workflow" : "The name of the workflow.",
"updateDraftIfNeeded" : "Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to `false`. Only applicable when updating the workflow-issue types mapping."
}
set_worklog_property
Sets the value of a worklog property. Use this operation to store custom data against the worklog.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- Edit all worklogs project permission to update any worklog or Edit own worklogs to update worklogs created by the user.
- If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
propertyKey (required)
The key of the issue property. The maximum length is 255 characters.
Type: string
worklogId (required)
The ID of the worklog.
Type: string
$body
Type: object
{ }
store_avatar
Loads a custom avatar for a project or issue type.
Specify the avatar's local file location in the body of the request. Also, include the following headers:
X-Atlassian-Token: no-check
To prevent XSRF protection blocking the request, for more information see Special Headers.Content-Type: image/image type
Valid image types are JPEG, GIF, or PNG.
For example:curl --request POST
--user email@example.com:
--header 'X-Atlassian-Token: no-check'
--header 'Content-Type: image/< image_type>'
--data-binary "<@/path/to/file/with/your/avatar>"
--url 'https://your-domain.atlassian.net/rest/api/2/universal_avatar/type/{type}/owner/{entityId}'
The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.
The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.
After creating the avatar use:
- Update issue type to set it as the issue type's displayed avatar.
- Set project avatar to set it as the project's displayed avatar.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
entityId (required)
The ID of the entity item.
Type: string
type (required)
The type of the entity. Valid values are project
and issuetype
.
Type: string
$body
Type: object
{ }
size
The length of each side of the crop region.
Type: integer
x
The X coordinate of the top-left corner of the crop region.
Type: integer
y
The Y coordinate of the top-left corner of the crop region.
Type: integer
update_comment
Updates a comment.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue containing the comment is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- Edit all comments project permission to update any comment or Edit own comments to update comment created by the user.
- If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the comment.
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
$body
A comment.
Type: object
{
"renderedBody" : "The rendered version of the comment.",
"visibility" : {
"type" : "Indicates whether visibility of this item is restricted to a group or role.",
"value" : "The name of the group or role to which visibility of this item is restricted."
},
"author" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"created" : "The date and time at which the comment was created.",
"updateAuthor" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"self" : "The URL of the comment.",
"jsdPublic" : "Indicates whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation.",
"id" : "The ID of the comment.",
"body" : "The comment text.",
"updated" : "The date and time at which the comment was updated last.",
"properties" : [ {
"value" : { },
"key" : "The key of the property. Required on create and update."
} ]
}
expand
Use expand to include additional information about comments in the response. This parameter accepts renderedBody
, which returns the comment body rendered in HTML.
Type: string
update_component
Updates a component. Any fields included in the request are overwritten. If leadUserName
is an empty string ("") the component lead is removed.
This operation can be accessed anonymously.
Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the component.
Type: string
$body
Details about a project component.
Type: object
{
"leadUserName" : "This property is deprecated in favor of `leadAccountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the component's lead user. Optional when creating or updating a component. Cannot be provided with `leadAccountId`.",
"description" : "The description for the component. Optional when creating or updating a component.",
"project" : "The key of the project the component is assigned to. Required when creating a component. Can't be updated.",
"leadAccountId" : "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.Optional when creating or updating a component. Cannot be provided with `leadUserName`.",
"lead" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"isAssigneeTypeValid" : "Indicates whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.",
"realAssigneeType" : "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.",
"name" : "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.",
"self" : "The URL of the component.",
"realAssignee" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"id" : "The unique identifier for the component.",
"assigneeType" : "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component.",
"assignee" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"projectId" : "The ID of the project the component is assigned to."
}
update_default_workflow
Sets the default workflow for a workflow scheme.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded
to true
in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme.
Type: integer
$body
The new default workflow.
Type: object
{
"workflow" : "The name of the workflow to set as the default workflow.",
"updateDraftIfNeeded" : "Indicates whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to `false`."
}
update_draft_default_workflow
Sets the default workflow for a workflow scheme's draft.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme that the draft belongs to.
Type: integer
$body
The object for the new default workflow.
Type: object
{
"workflow" : "The name of the workflow to set as the default workflow.",
"updateDraftIfNeeded" : "Indicates whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to `false`."
}
update_draft_workflow_mapping
Sets the issue types for a workflow in a workflow scheme's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme that the draft belongs to.
Type: integer
$body
Details about the mapping between issue types and a workflow.
Type: object
{
"workflow" : "The name of the workflow. Optional if updating the workflow-issue types mapping.",
"updateDraftIfNeeded" : "Indicates whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to `false`.",
"defaultMapping" : "Indicates whether the workflow is the default workflow for the workflow scheme.",
"issueTypes" : [ "string" ]
}
workflowName
The name of the workflow.
Type: string
update_filter
Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.
Permissions required: Permission to access Jira, however the user must own the filter.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the filter to update.
Type: integer
$body
The filter to update.
Type: object
{
"owner" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"sharedUsers" : {
"size" : "The number of items on the page.",
"max-results" : "The maximum number of results that could be on the page.",
"end-index" : "The index of the last item returned on the page.",
"start-index" : "The index of the first item returned on the page.",
"items" : [ {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
} ]
},
"subscriptions" : {
"size" : "The number of items on the page.",
"max-results" : "The maximum number of results that could be on the page.",
"end-index" : "The index of the last item returned on the page.",
"start-index" : "The index of the first item returned on the page.",
"items" : [ {
"id" : "The ID of the filter subscription.",
"user" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"group" : {
"name" : "The name of group.",
"self" : "The URL for these group details."
}
} ]
},
"jql" : "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*.",
"favouritedCount" : "The count of how many users have selected this filter as a favorite, including the filter owner.",
"description" : "A description of the filter.",
"favourite" : "Indicates whether the filter is selected as a favorite.",
"name" : "The name of the filter. Must be unique.",
"viewUrl" : "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*.",
"self" : "The URL of the filter.",
"searchUrl" : "A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-2-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/2/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.",
"id" : "The unique identifier for the filter.",
"sharePermissions" : [ {
"role" : {
"actors" : [ {
"avatarUrl" : "uri",
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"actorGroup" : {
"displayName" : "string",
"name" : "string"
},
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"id" : "integer",
"type" : "string",
"user" : "string",
"actorUser" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*."
}
} ],
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the project role.",
"self" : "The URL the project role details.",
"description" : "The description of the project role.",
"id" : "The ID of the project role."
},
"project" : {
"components" : [ {
"leadUserName" : "This property is deprecated in favor of `leadAccountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the component's lead user. Optional when creating or updating a component. Cannot be provided with `leadAccountId`.",
"description" : "The description for the component. Optional when creating or updating a component.",
"project" : "The key of the project the component is assigned to. Required when creating a component. Can't be updated.",
"leadAccountId" : "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.Optional when creating or updating a component. Cannot be provided with `leadUserName`.",
"lead" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"isAssigneeTypeValid" : "Indicates whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.",
"realAssigneeType" : "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.",
"name" : "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.",
"self" : "The URL of the component.",
"realAssignee" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"id" : "The unique identifier for the component.",
"assigneeType" : "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component.",
"assignee" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"projectId" : "The ID of the project the component is assigned to."
} ],
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"roles" : "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-2-role-post).",
"description" : "A brief description of the project.",
"isPrivate" : "Indicates whether the project is private.",
"uuid" : "unique ID for next-gen projects",
"lead" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"url" : "A link to information about this project, such as project documentation.",
"issueTypes" : [ {
"avatarId" : "The ID of the issue type's avatar.",
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the issue type.",
"self" : "The URL of these issue type details.",
"description" : "The description of the issue type.",
"entityId" : "project unique ID for next-gen entities",
"id" : "The ID of the issue type.",
"iconUrl" : "The URL of the issue type's avatar.",
"subtask" : "Indicates whether this issue type is used to create subtasks."
} ],
"expand" : "Expand options that include additional project details in the response.",
"simplified" : "Indicates whether the project is simplified.",
"versions" : [ {
"releaseDate" : "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.",
"description" : "The description of the version. Optional when creating or updating a version.",
"project" : "Deprecated. Use `projectId`.",
"archived" : "Indicates that the version is archived. Optional when creating or updating a version.",
"expand" : "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts multiple values separated by a comma:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.",
"operations" : [ {
"weight" : "integer",
"id" : "string",
"label" : "string",
"href" : "string",
"styleClass" : "string",
"title" : "string",
"iconClass" : "string"
} ],
"overdue" : "Indicates that the version is overdue.",
"name" : "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.",
"self" : "The URL of the version.",
"moveUnfixedIssuesTo" : "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.",
"userReleaseDate" : "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.",
"id" : "The ID of the version.",
"userStartDate" : "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.",
"projectId" : "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.",
"released" : "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.",
"startDate" : "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.",
"issuesStatusForFixVersion" : {
"toDo" : "Count of issues with status *to do*.",
"inProgress" : "Count of issues with status *in progress*.",
"done" : "Count of issues with status *done*.",
"unmapped" : "Count of issues with a status other than *to do*, *in progress*, and *done*."
}
} ],
"projectCategory" : {
"name" : "The name of the project category. Required on create, optional on update.",
"self" : "The URL of the project category.",
"description" : "The description of the project category. Required on create, optional on update.",
"id" : "The ID of the project category."
},
"permissions" : {
"canEdit" : "Indicates whether the logged user can edit the project."
},
"issueTypeHierarchy" : {
"level" : [ {
"externalUuid" : "uuid",
"projectConfigurationId" : "integer",
"aboveLevelId" : "integer",
"issueTypeIds" : [ "integer" ],
"name" : "string",
"id" : "integer",
"belowLevelId" : "integer"
} ]
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"style" : "The type of the project.",
"id" : "The ID of the project.",
"assigneeType" : "The default assignee when creating issues for this project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project.",
"email" : "An email address associated with the project.",
"properties" : { }
},
"id" : "The unique identifier of the share permission.",
"type" : "The type of share permission:\n\n * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n * `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`.\n * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.",
"group" : {
"name" : "The name of group.",
"self" : "The URL for these group details."
}
} ]
}
expand
Use expand to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:
sharedUsers
Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers
, then thesharedUsers
object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]
to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000]
.subscriptions
Returns the users that are subscribed to the filter. If you don't specifysubscriptions
, thesubscriptions
object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]
to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
.
Type: string
update_issue_field_option
Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical.
Note that this operation cannot be used with the built-in custom fields. It only works with issue fields added by Connect apps, as described above.
Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.
Parameters
cloudid (required)
Type: string
fieldKey (required)
The field key is specified in the following format: $(app-key)\_\_$(field-key). For example, example-add-on\_\_example-issue-field.
Type: string
optionId (required)
The ID of the option to be updated.
Type: integer
$body
Details of the options for a select list issue field.
Type: object
{
"id" : "The unique identifier for the option. This is only unique within the select field's set of options.",
"value" : "The option's name, which is displayed in Jira.",
"config" : {
"scope" : {
"projects2" : [ {
"attributes" : [ "string. Possible values: notSelectable | defaultValue" ],
"id" : "The ID of the project that the option's behavior applies to."
} ],
"projects" : [ "integer" ],
"global" : {
"attributes" : [ "string. Possible values: notSelectable | defaultValue" ]
}
},
"attributes" : [ "string. Possible values: notSelectable | defaultValue" ]
},
"properties" : { }
}
update_issue_link_type
Updates an issue link type.
To use this operation, the site must have issue linking enabled.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
issueLinkTypeId (required)
The ID of the issue link type.
Type: string
$body
This object is used as follows:
In the issueLink resource it defines and reports on the type of link between the issues. Find a list of issue link types with Get issue link types. In the issueLinkType resource it defines and reports on issue link types.
Type: object
{
"inward" : "The description of the issue link type inward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-2-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-2-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.",
"name" : "The name of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-2-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-2-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.",
"self" : "The URL of the issue link type. Read only.",
"id" : "The ID of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-2-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-2-issueLinkType-post) resource it is read only.",
"outward" : "The description of the issue link type outward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-2-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-2-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only."
}
update_issue_type
Updates the issue type.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the issue type.
Type: string
$body
Type: object
{
"avatarId" : "The ID of an issue type avatar.",
"name" : "The unique name for the issue type. The maximum length is 60 characters.",
"description" : "The description of the issue type."
}
update_permission_scheme
Updates a permission scheme. Below are some important things to note when using this resource:
- If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
- If you want to update only the name and description, then do not send a permissions list in the request.
- Sending an empty list will remove all permission grants from the permission scheme.
If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.
See About permission schemes and grants for more details.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
schemeId (required)
The ID of the permission scheme to update.
Type: integer
$body
Details of a permission scheme.
Type: object
{
"expand" : "The expand options available for the permission scheme.",
"permissions" : [ {
"self" : "The URL of the permission granted details.",
"holder" : {
"expand" : "Expand options that include additional permission holder details in the response.",
"field" : {
"schema" : {
"system" : "If the field is a system field, the name of the field.",
"configuration" : { },
"custom" : "If the field is a custom field, the URI of the field.",
"type" : "The data type of the field.",
"items" : "When the data type is an array, the name of the field items within the array.",
"customId" : "If the field is a custom field, the custom ID of the field."
},
"navigable" : "Indicates whether the field can be used as a column on the issue navigator.",
"orderable" : "Indicates whether the content of the field can be used to order lists.",
"custom" : "Indicates whether the field is a custom field.",
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the field.",
"clauseNames" : [ "string" ],
"id" : "The ID of the field.",
"key" : "The key of the field.",
"searchable" : "Indicates whether the content of the field can be searched."
},
"projectRole" : {
"actors" : [ {
"avatarUrl" : "uri",
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"actorGroup" : {
"displayName" : "string",
"name" : "string"
},
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"id" : "integer",
"type" : "string",
"user" : "string",
"actorUser" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*."
}
} ],
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the project role.",
"self" : "The URL the project role details.",
"description" : "The description of the project role.",
"id" : "The ID of the project role."
},
"parameter" : "The identifier of permission holder.",
"type" : "The type of permission holder.",
"user" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"group" : {
"name" : "The name of group.",
"self" : "The URL for these group details."
}
},
"permission" : "The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. For more information about the built-in permissions, see *Permissions* in [Get all permission schemes](#api-rest-api-2-permissionscheme-get). For more information about custom permissions, see the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation.",
"id" : "The ID of the permission granted details."
} ],
"scope" : {
"project" : {
"simplified" : "Whether or not the project is simplified.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"projectCategory" : {
"name" : "The description of the project category.",
"self" : "The URL of the project category.",
"description" : "The name of the project category.",
"id" : "The ID of the project category."
},
"name" : "The name of the project.",
"self" : "The URL of the project details.",
"id" : "The ID of the project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"key" : "The key of the project."
},
"type" : "The type of scope."
},
"name" : "The name of the permission scheme. Must be unique. Required when creating or updating a permission scheme.",
"self" : "The URL of the permission scheme.",
"description" : "A description for the permission scheme.",
"id" : "The ID of the permission scheme."
}
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:
all
Returns all expandable information.field
Returns information about the custom field granted the permission.group
Returns information about the group that is granted the permission.permissions
Returns all permission grants for each permission scheme.projectRole
Returns information about the project role granted the permission.user
Returns information about the user who is granted the permission.
Type: string
update_project
Updates the project details of a project.
All parameters are optional in the body of the request.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The project ID or project key (case sensitive).
Type: string
$body
The project details to be updated.
Type: object
{
"notificationScheme" : "The ID of the notification scheme for the project. Use the [Get notification schemes](#api-rest-api-2-notificationscheme-get) resource to get a list of notification scheme IDs.",
"description" : "A brief description of the project.",
"leadAccountId" : "The account id of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Optional when updating a project. Cannot be provided with `lead`.",
"lead" : "This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Optional when updating a project. Cannot be provided with `leadAccountId`.",
"url" : "A link to information about this project, such as project documentation",
"projectTemplateKey" : "A prebuilt configuration for a project. The type of the `projectTemplateKey` must match with the type of the `projectTypeKey`. Required when creating a project. Not applicable for the Update project resource.",
"avatarId" : "An integer value for the project's avatar.",
"issueSecurityScheme" : "The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the [Get issue security schemes](#api-rest-api-2-issuesecurityschemes-get) resource to get all issue security scheme IDs.",
"name" : "The name of the project. Required when creating a project. Optional when updating a project.",
"permissionScheme" : "The ID of the permission scheme for the project. Use the [Get all permission schemes](#api-rest-api-2-permissionscheme-get) resource to see a list of all permission scheme IDs.",
"assigneeType" : "The default assignee when creating issues for this project.",
"projectTypeKey" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which dictates the application-specific feature set. Required when creating a project. Not applicable for the Update project resource.",
"key" : "Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters. Required when creating a project. Optional when updating a project.",
"categoryId" : "The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-2-projectCategory-get) operation."
}
expand
Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that the project description, issue types, and project lead are included in all responses by default:
description
The project description.issueTypes
The issue types associated with the project.lead
The project lead.projectKeys
All project keys associated with the project.
Type: string
update_project_avatar
Sets the avatar displayed for a project.
Use Load project avatar to store avatars against the project, before using this operation to set the displayed avatar.
Permissions required: Administer projects project permission.
Parameters
cloudid (required)
Type: string
projectIdOrKey (required)
The ID or (case-sensitive) key of the project.
Type: string
$body
Details of an avatar.
Type: object
{
"owner" : "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the key for a user.",
"isDeletable" : "Indicates whether the avatar can be deleted.",
"fileName" : "The file name of the avatar icon. Returned for system avatars.",
"urls" : "The list of avatar icon URLs.",
"isSystemAvatar" : "Indicates whether the avatar is a system avatar.",
"isSelected" : "Indicates whether the avatar is used in Jira. For example, shown as a project's avatar.",
"id" : "The ID of the avatar. Required when setting the project avatar."
}
update_project_category
Updates a project category.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
Type: integer
$body
A project category.
Type: object
{
"name" : "The name of the project category. Required on create, optional on update.",
"self" : "The URL of the project category.",
"description" : "The description of the project category. Required on create, optional on update.",
"id" : "The ID of the project category."
}
update_remote_issue_link
Updates a remote issue link for an issue.
Note: Fields without values in the request are set to null.
This operation requires issue linking to be active.
This operation can be accessed anonymously.
Permissions required:
- Browse projects and Link issues project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the issue.
Type: string
linkId (required)
The ID of the remote issue link.
Type: string
$body
Details of a remote issue link.
Type: object
{
"application" : {
"name" : "The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\". Grouping and sorting of links may place links without an application name last.",
"type" : "The name-spaced type of the application, used by registered rendering apps."
},
"globalId" : "An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: `appId=456&pageId=123`.\n\nSetting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.\n\nThe maximum length is 255 characters.",
"relationship" : "Description of the relationship between the issue and the linked item. If not set, the relationship description \"links to\" is used in Jira.",
"object" : {
"summary" : "The summary details of the item.",
"icon" : {
"url16x16" : "The URL of an icon that displays at 16x16 pixel in Jira.",
"link" : "The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.",
"title" : "The title of the icon. This is used as follows:\n\n * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\"."
},
"title" : "The title of the item.",
"url" : "The URL of the item.",
"status" : {
"icon" : {
"url16x16" : "The URL of an icon that displays at 16x16 pixel in Jira.",
"link" : "The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.",
"title" : "The title of the icon. This is used as follows:\n\n * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\"."
},
"resolved" : "Indicates whether the item is resolved. If set to \"true\", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font."
}
}
}
update_version
Updates a project version.
This operation can be accessed anonymously.
Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the version.
Type: string
$body
Details about a project version.
Type: object
{
"releaseDate" : "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.",
"description" : "The description of the version. Optional when creating or updating a version.",
"project" : "Deprecated. Use `projectId`.",
"archived" : "Indicates that the version is archived. Optional when creating or updating a version.",
"expand" : "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts multiple values separated by a comma:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.",
"operations" : [ {
"weight" : "integer",
"id" : "string",
"label" : "string",
"href" : "string",
"styleClass" : "string",
"title" : "string",
"iconClass" : "string"
} ],
"overdue" : "Indicates that the version is overdue.",
"name" : "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.",
"self" : "The URL of the version.",
"moveUnfixedIssuesTo" : "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.",
"userReleaseDate" : "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.",
"id" : "The ID of the version.",
"userStartDate" : "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.",
"projectId" : "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.",
"released" : "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.",
"startDate" : "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.",
"issuesStatusForFixVersion" : {
"toDo" : "Count of issues with status *to do*.",
"inProgress" : "Count of issues with status *in progress*.",
"done" : "Count of issues with status *done*.",
"unmapped" : "Count of issues with a status other than *to do*, *in progress*, and *done*."
}
}
update_workflow_mapping
Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded
to true
in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme.
Type: integer
$body
Details about the mapping between issue types and a workflow.
Type: object
{
"workflow" : "The name of the workflow. Optional if updating the workflow-issue types mapping.",
"updateDraftIfNeeded" : "Indicates whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to `false`.",
"defaultMapping" : "Indicates whether the workflow is the default workflow for the workflow scheme.",
"issueTypes" : [ "string" ]
}
workflowName
The name of the workflow.
Type: string
update_workflow_scheme
Updates a workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that updateDraftIfNeeded
is set to true
.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId
. For example, schemeId=10301.
Type: integer
$body
Details about a workflow scheme.
Type: object
{
"originalDefaultWorkflow" : "For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira.",
"description" : "The description of the workflow scheme.",
"issueTypes" : "The issue types available in Jira.",
"originalIssueTypeMappings" : "For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.",
"defaultWorkflow" : "The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*.",
"updateDraftIfNeeded" : "Indicates whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:\n\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated.\n * Update an inactive workflow scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.\n\nDefaults to `false`.",
"draft" : "Indicates whether the workflow scheme is a draft or not.",
"name" : "The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.",
"self" : "uri",
"lastModifiedUser" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"id" : "The ID of the workflow scheme.",
"lastModified" : "The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.",
"issueTypeMappings" : "The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme."
}
update_workflow_scheme_draft
Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the active workflow scheme that the draft was created from.
Type: integer
$body
Details about a workflow scheme.
Type: object
{
"originalDefaultWorkflow" : "For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira.",
"description" : "The description of the workflow scheme.",
"issueTypes" : "The issue types available in Jira.",
"originalIssueTypeMappings" : "For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.",
"defaultWorkflow" : "The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*.",
"updateDraftIfNeeded" : "Indicates whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:\n\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated.\n * Update an inactive workflow scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.\n\nDefaults to `false`.",
"draft" : "Indicates whether the workflow scheme is a draft or not.",
"name" : "The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.",
"self" : "uri",
"lastModifiedUser" : {
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk",
"active" : "Indicates whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"groups" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"name" : "The name of group.",
"self" : "The URL for these group details."
} ]
},
"locale" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.",
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*. In requests, required unless `name` or `key` is specified.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"expand" : "Expand options that include additional user details in the response.",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user. In requests, required unless `accountId` or `key` is specified.",
"self" : "The URL of the user.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user. In requests, required unless `accountId` or `name` is specified.",
"applicationRoles" : {
"pagingCallback" : { },
"size" : "integer",
"max-results" : "integer",
"callback" : { },
"items" : [ {
"numberOfSeats" : "The maximum count of users on your license.",
"userCount" : "The number of users counting against your license.",
"userCountDescription" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "The display name of the application role.",
"groups" : [ "string" ],
"remainingSeats" : "The count of users remaining on your license.",
"key" : "The key of the application role.",
"selectedByDefault" : "Determines whether this application role should be selected by default on user creation.",
"defined" : "Deprecated.",
"platform" : "Indicates if the application role belongs to Jira platform (`jira-core`)."
} ]
}
},
"id" : "The ID of the workflow scheme.",
"lastModified" : "The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.",
"issueTypeMappings" : "The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme."
}
update_workflow_transition_property
Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
Permissions required: Administer Jira global permission.
Parameters
cloudid (required)
Type: string
transitionId (required)
The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
Type: integer
$body
Details about the server Jira is running on.
Type: object
{
"id" : "The ID of the transition property.",
"value" : "The value of the transition property.",
"key" : "The key of the transition property. Also known as the name of the transition property."
}
key
The key of the property being updated, also known as the name of the property. Set this to the same value as the key
defined in the request body.
Type: string
workflowMode
The workflow status. Set to live
for inactive workflows or draft
for draft workflows. Active workflows cannot be edited.
Type: string
Potential values: live, draft
workflowName
The name of the workflow that the transition belongs to.
Type: string
update_workflow_transition_rule_configurations
Updates configuration of workflow transition rules. The following rule types are supported:
Only rules created by the calling Connect app can be updated.
Permissions required: Only Connect apps can use this operation.
Parameters
cloudid (required)
Type: string
$body
Details about a workflow configuration update request.
Type: object
{
"workflows" : [ {
"postFunctions" : [ {
"configuration" : {
"value" : "Configuration of the rule, as it is stored by the Connect app on the rule configuration page."
},
"id" : "The ID of the transition rule.",
"key" : "The key of the rule, as defined in the Connect app descriptor.",
"transition" : {
"name" : "The transition name.",
"id" : "The transition ID."
}
} ],
"validators" : [ {
"configuration" : {
"value" : "Configuration of the rule, as it is stored by the Connect app on the rule configuration page."
},
"id" : "The ID of the transition rule.",
"key" : "The key of the rule, as defined in the Connect app descriptor.",
"transition" : {
"name" : "The transition name.",
"id" : "The transition ID."
}
} ],
"conditions" : [ {
"configuration" : {
"value" : "Configuration of the rule, as it is stored by the Connect app on the rule configuration page."
},
"id" : "The ID of the transition rule.",
"key" : "The key of the rule, as defined in the Connect app descriptor.",
"transition" : {
"name" : "The transition name.",
"id" : "The transition ID."
}
} ],
"workflowId" : {
"draft" : "Whether the workflow is in the draft state.",
"name" : "The name of the workflow."
}
} ]
}
update_worklog
Updates a worklog.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- Edit all worklogs project permission to update any worklog or Edit own worklogs to update worklogs created by the user.
- If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
cloudid (required)
Type: string
id (required)
The ID of the worklog.
Type: string
issueIdOrKey (required)
The ID or key the issue.
Type: string
$body
Details of a worklog.
Type: object
{
"issueId" : "The ID of the issue this worklog is for.",
"visibility" : {
"type" : "Indicates whether visibility of this item is restricted to a group or role.",
"value" : "The name of the group or role to which visibility of this item is restricted."
},
"timeSpent" : "The time spent working on the issue as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided.",
"author" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"created" : "The datetime on which the worklog was created.",
"started" : "The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.",
"timeSpentSeconds" : "The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided.",
"updateAuthor" : {
"accountId" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192*.",
"emailAddress" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.",
"avatarUrls" : {
"48x48" : "The URL of the item's 48x48 pixel avatar.",
"24x24" : "The URL of the item's 24x24 pixel avatar.",
"16x16" : "The URL of the item's 16x16 pixel avatar.",
"32x32" : "The URL of the item's 32x32 pixel avatar."
},
"displayName" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"accountType" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"name" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"self" : "The URL of the user.",
"active" : "Whether the user is active.",
"timeZone" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
"key" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user."
},
"self" : "The URL of the worklog item.",
"comment" : "A comment about the worklog. Optional when creating or updating a worklog.",
"id" : "The ID of the worklog record.",
"updated" : "The datetime on which the worklog was last updated.",
"properties" : [ {
"value" : { },
"key" : "The key of the property. Required on create and update."
} ]
}
adjustEstimate
Defines how to update the issue's time estimate, the options are:
new
Sets the estimate to a specific value, defined innewEstimate
.leave
Leaves the estimate unchanged.auto
Updates the estimate by the difference between the original and updated value oftimeSpent
ortimeSpentSeconds
.
Type: string
Potential values: new, leave, manual, auto
expand
Use expand to include additional information about worklogs in the response. This parameter accepts multiple values separated by a comma:
properties
Returns worklog properties.
Type: string
newEstimate
The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate
is new
.
Type: string
notifyUsers
Indicates whether users watching the issue are notified by email.
Type: boolean
overrideEditableFlag
Indicates whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Only connect app users with admin permissions can use this flag.
Type: boolean
validate_project_key
Validates a project key by confirming the key is a valid string and not in use.
This operation can be accessed anonymously.
Permissions required: None.
Parameters
cloudid (required)
Type: string
key
The project key.
Type: string