Jira (version v3.*.*)

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" ]
}

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

cloudid (required)#

Type: string

fieldId (required)#

The ID of the field.

Type: string

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" ]
}

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."
}

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."
}

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."
}

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

cloudid (required)#

Type: string

issueIdOrKey (required)#

The ID or key of the issue.

Type: string

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

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 in newEstimate.
• leave Leaves the estimate unchanged.
• manual Reduces the estimate by amount specified in reduceBy.
• auto Reduces the estimate by the value of timeSpent 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

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`)."
    } ]
  }
}

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

cloudid (required)#

Type: string

propertyKey (required)#

The key of the property.

Type: string

$body#

Bulk operation filter details.

Type: object

{
  "entityIds" : [ "integer" ],
  "currentValue" : { }
}

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" ]

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" : { }
}

cloudid (required)#

Type: string

taskId (required)#

The ID of the task.

Type: string

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."
}

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"
}

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 specify sharedUsers, then the sharedUsers 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 specify subscriptions, the subscriptions 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

cloudid (required)#

Type: string

$body#

The name of the group.

Type: object

{
  "name" : "The name of the group."
}

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

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" : { }
}

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."
}

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`."
}

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

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."
    } ]
  } ]
}

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."
    }
  }
}

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

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."
}