openapi: 3.2.0 info: contact: email: ecosystem@atlassian.com description: Jira Cloud platform REST API documentation license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/ title: Jira Cloud platform REST Priority schemes API version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df servers: - url: https://your-domain.atlassian.net tags: - description: This resource represents issue priority schemes. Use it to get priority schemes and related information, and to create, update and delete priority schemes. name: Priority schemes paths: /rest/api/3/priorityscheme: get: deprecated: false description: 'Returns a paginated list of priority schemes. **Permissions required:** *Administer Jira* global permission.' operationId: getPrioritySchemes parameters: - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: '0' type: string - description: The maximum number of items to return per page. in: query name: maxResults schema: default: '50' type: string - description: A set of priority IDs to filter by. To include multiple IDs, provide an ampersand-separated list. For example, `priorityId=10000&priorityId=10001`. in: query name: priorityId schema: items: format: int64 type: integer type: array uniqueItems: true - description: A set of priority scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `schemeId=10000&schemeId=10001`. in: query name: schemeId schema: items: format: int64 type: integer type: array uniqueItems: true - description: The name of scheme to search for. in: query name: schemeName schema: default: '' type: string - description: Whether only the default priority is returned. in: query name: onlyDefault schema: default: false type: boolean - description: The ordering to return the priority schemes by. in: query name: orderBy schema: default: +name enum: - name - +name - -name type: string - description: A comma separated list of additional information to return. "priorities" will return priorities associated with the priority scheme. "projects" will return projects associated with the priority scheme. `expand=priorities,projects`. in: query name: expand schema: type: string responses: '200': content: application/json: example: '{"isLast":true,"maxResults":50,"startAt":0,"total":1,"values":[{"description":"This is the default scheme used by all new and unassigned projects","id":"1","isDefault":true,"name":"Default Priority Scheme","priorities":{"isLast":true,"maxResults":50,"startAt":0,"total":3,"values":[{"description":"Serious problem that could block progress.","iconUrl":"/images/icons/priorities/high.svg","id":"1","isDefault":false,"name":"High","statusColor":"#f15C75"},{"description":"Has the potential to affect progress.","iconUrl":"/images/icons/priorities/medium.svg","id":"2","isDefault":true,"name":"Medium","statusColor":"#f79232"},{"description":"Minor problem or easily worked around.","iconUrl":"/images/icons/priorities/low.svg","id":"3","isDefault":false,"name":"Low","statusColor":"#707070"}]},"projects":{"isLast":true,"maxResults":50,"startAt":0,"total":1,"values":[{"avatarUrls":{"16x16":"secure/projectavatar?size=xsmall&pid=10000","24x24":"secure/projectavatar?size=small&pid=10000","32x32":"secure/projectavatar?size=medium&pid=10000","48x48":"secure/projectavatar?size=large&pid=10000"},"id":"10000","key":"EX","name":"Example","projectCategory":{"description":"Project category description","id":"10000","name":"A project category"},"projectTypeKey":"ProjectTypeKey{key=''software''}","self":"project/EX","simplified":false}]}}]}' schema: $ref: '#/components/schemas/PageBeanPrioritySchemeWithPaginatedPrioritiesAndProjects' description: Returned if the request is successful. '400': description: Returned if the request isn't valid. '401': description: Returned if the authentication credentials are incorrect. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get priority schemes tags: - Priority schemes x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:priority-scheme:jira state: Beta x-experimental: true x-atlassian-connect-scope: INACCESSIBLE post: deprecated: false description: 'Creates a new priority scheme. **Permissions required:** *Administer Jira* global permission.' operationId: createPriorityScheme parameters: [] requestBody: content: application/json: example: defaultPriorityId: 10001 description: My priority scheme description mappings: in: '10002': 10000 '10005': 10001 '10006': 10001 '10008': 10003 out: {} name: My new priority scheme priorityIds: - 10000 - 10001 - 10003 projectIds: - 10005 - 10006 - 10007 schema: $ref: '#/components/schemas/CreatePrioritySchemeDetails' required: true responses: '201': content: application/json: example: '{"id":"10001"}' schema: $ref: '#/components/schemas/PrioritySchemeId' description: Returned if the request is completed. '202': content: application/json: example: '{"id":"10001","task":{"self":"https://your-domain.atlassian.net/rest/api/3/task/1","id":"1","description":"Task description","status":"COMPLETE","result":"the task result, this may be any JSON","submittedBy":10000,"progress":100,"elapsedRuntime":156,"submitted":1501708132800,"started":1501708132900,"finished":1501708133000,"lastUpdate":1501708133000}}' schema: $ref: '#/components/schemas/PrioritySchemeId' description: Returned if the request is accepted. '400': description: "Returned if the request isn't valid.\n\n**Mappings Validation Errors**\n\n * ``The priorities with IDs [ID 1, ID 2, ...] require mapping. Please provide mappings in the 'in' mappings object, where these priorities are the keys with corresponding values.`` The listed priority ID(s) have not been provided as keys for ``in`` mappings but are required, add them to the mappings object." '401': description: Returned if the authentication credentials are incorrect. '403': description: Returned if the user doesn't have the necessary permissions. '409': description: Returned if an action with this priority scheme is still in progress. '422': content: application/json: schema: $ref: '#/components/schemas/LimitExceededResponseBean' description: 422 response security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Create priority scheme tags: - Priority schemes x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:priority-scheme:jira state: Beta x-experimental: true x-atlassian-connect-scope: INACCESSIBLE /rest/api/3/priorityscheme/mappings: post: deprecated: false description: 'Returns a paginated list of priorities that would require mapping, given a change in priorities or projects associated with a priority scheme. **Permissions required:** *Administer Jira* global permission.' operationId: suggestedPrioritiesForMappings parameters: [] requestBody: content: application/json: example: maxResults: 50 priorities: add: - 10001 - 10002 remove: - 10003 projects: add: - 10021 schemeId: 10005 startAt: 0 schema: $ref: '#/components/schemas/SuggestedMappingsRequestBean' required: true responses: '200': content: application/json: example: '{"isLast":true,"maxResults":50,"startAt":0,"total":3,"values":[{"description":"Serious problem that could block progress.","iconUrl":"/images/icons/priorities/high.svg","id":"1","isDefault":false,"name":"High","statusColor":"#f15C75"},{"description":"Has the potential to affect progress.","iconUrl":"/images/icons/priorities/medium.svg","id":"2","isDefault":true,"name":"Medium","statusColor":"#f79232"},{"description":"Minor problem or easily worked around.","iconUrl":"/images/icons/priorities/low.svg","id":"3","isDefault":false,"name":"Low","statusColor":"#707070"}]}' schema: $ref: '#/components/schemas/PageBeanPriorityWithSequence' description: Returned if the request is successful. '400': description: Returned if the request isn't valid. '401': description: Returned if the authentication credentials are incorrect. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Suggested priorities for mappings tags: - Priority schemes x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:priority-scheme:jira state: Beta x-experimental: true x-atlassian-connect-scope: INACCESSIBLE /rest/api/3/priorityscheme/priorities/available: get: deprecated: false description: 'Returns a paginated list of priorities available for adding to a priority scheme. **Permissions required:** *Administer Jira* global permission.' operationId: getAvailablePrioritiesByPriorityScheme parameters: - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: '0' type: string - description: The maximum number of items to return per page. in: query name: maxResults schema: default: '50' type: string - description: The string to query priorities on by name. in: query name: query schema: default: '' type: string - description: The priority scheme ID. in: query name: schemeId required: true schema: type: string - description: A list of priority IDs to exclude from the results. in: query name: exclude schema: items: type: string type: array uniqueItems: true responses: '200': content: application/json: example: '{"isLast":true,"maxResults":50,"startAt":0,"total":3,"values":[{"description":"Serious problem that could block progress.","iconUrl":"/images/icons/priorities/high.svg","id":"1","isDefault":false,"name":"High","statusColor":"#f15C75"},{"description":"Has the potential to affect progress.","iconUrl":"/images/icons/priorities/medium.svg","id":"2","isDefault":true,"name":"Medium","statusColor":"#f79232"},{"description":"Minor problem or easily worked around.","iconUrl":"/images/icons/priorities/low.svg","id":"3","isDefault":false,"name":"Low","statusColor":"#707070"}]}' schema: $ref: '#/components/schemas/PageBeanPriorityWithSequence' description: Returned if the request is successful. '400': description: Returned if the request isn't valid. '401': description: Returned if the authentication credentials are incorrect. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get available priorities by priority scheme tags: - Priority schemes x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:priority-scheme:jira state: Beta x-experimental: true x-atlassian-connect-scope: INACCESSIBLE /rest/api/3/priorityscheme/{schemeId}: delete: deprecated: false description: 'Deletes a priority scheme. This operation is only available for priority schemes without any associated projects. Any associated projects must be removed from the priority scheme before this operation can be performed. **Permissions required:** *Administer Jira* global permission.' operationId: deletePriorityScheme parameters: - description: The priority scheme ID. in: path name: schemeId required: true schema: format: int64 type: integer responses: '204': content: application/json: schema: {} description: Returned if the request is successful. '400': description: Returned if the request isn't valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user doesn't have the necessary permissions. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Delete priority scheme tags: - Priority schemes x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - delete:priority-scheme:jira state: Beta x-experimental: true x-atlassian-connect-scope: INACCESSIBLE put: deprecated: false description: 'Updates a priority scheme. This includes its details, the lists of priorities and projects in it **Permissions required:** *Administer Jira* global permission.' operationId: updatePriorityScheme parameters: - description: The ID of the priority scheme. in: path name: schemeId required: true schema: format: int64 type: integer requestBody: content: application/json: example: defaultPriorityId: 10001 description: My priority scheme description mappings: in: '10003': 10002 '10004': 10001 out: '10001': 10005 '10002': 10006 name: My new priority scheme priorities: add: ids: - 10001 - 10002 remove: ids: - 10003 - 10004 projects: add: ids: - 10101 - 10102 remove: ids: - 10103 - 10104 schema: $ref: '#/components/schemas/UpdatePrioritySchemeRequestBean' required: true responses: '202': content: application/json: example: '{"task":{"self":"https://your-domain.atlassian.net/rest/api/3/task/1","id":"1","description":"Task description","status":"COMPLETE","result":"the task result, this may be any JSON","submittedBy":10000,"progress":100,"elapsedRuntime":156,"submitted":1501708132800,"started":1501708132900,"finished":1501708133000,"lastUpdate":1501708133000},"updated":{"description":"This is the default scheme used by all new and unassigned projects","id":"1","isDefault":true,"name":"Default Priority Scheme","priorities":{"isLast":true,"maxResults":50,"startAt":0,"total":3,"values":[{"description":"Serious problem that could block progress.","iconUrl":"/images/icons/priorities/high.svg","id":"1","isDefault":false,"name":"High","statusColor":"#f15C75"},{"description":"Has the potential to affect progress.","iconUrl":"/images/icons/priorities/medium.svg","id":"2","isDefault":true,"name":"Medium","statusColor":"#f79232"},{"description":"Minor problem or easily worked around.","iconUrl":"/images/icons/priorities/low.svg","id":"3","isDefault":false,"name":"Low","statusColor":"#707070"}]},"projects":{"isLast":true,"maxResults":50,"startAt":0,"total":1,"values":[{"avatarUrls":{"16x16":"secure/projectavatar?size=xsmall&pid=10000","24x24":"secure/projectavatar?size=small&pid=10000","32x32":"secure/projectavatar?size=medium&pid=10000","48x48":"secure/projectavatar?size=large&pid=10000"},"id":"10000","key":"EX","name":"Example","projectCategory":{"description":"Project category description","id":"10000","name":"A project category"},"projectTypeKey":"ProjectTypeKey{key=''software''}","self":"project/EX","simplified":false}]}}}' schema: $ref: '#/components/schemas/UpdatePrioritySchemeResponseBean' description: Returned if the request is accepted. '400': description: "Returned if the request isn't valid.\n\n**Mappings Validation Errors**\n\n * ``The changes to priority schemes require mapping of priorities. Please provide a value for the 'in' mappings object.`` Priorities are being removed and/or projects are being added to the scheme, but ``in`` mappings are not provided.\n * ``The changes to priority schemes require mapping of priorities. Please provide a value for the 'out' mappings object.`` Projects are being removed from the scheme, but ``out`` mappings are not provided.\n * ``The priorities with IDs [ID 1, ID 2, ...] provided as keys for the 'in' mappings object do not exist. Please provide existing priority IDs.`` The listed priority ID(s) have been provided as keys for ``in`` mappings but do not exist. Please confirm the correct priority ID(s) have been provided, they should be priorities that exist on the Jira site which are used by projects being added to the current scheme, but are not in use by the current scheme.\n * ``The priorities with IDs [ID 1, ID 2, ...] provided as values for the 'in' mappings object do not exist. Please provide existing priority IDs used by the current priority scheme.`` The listed priority ID(s) have been provided as values for ``in`` mappings but do not exist. Please confirm the correct priority ID(s) have been provided, they should be priorities that exist on the Jira site and are in use by the current scheme.\n * ``The priorities with IDs [ID 1, ID 2, ...] provided as keys for the 'out' mappings object do not exist. Please provide existing priority IDs used by the current priority scheme.`` The listed priority ID(s) have been provided as keys for ``out`` mappings but are invalid. Please confirm the correct priority ID(s) have been provided, they should be priorities that exist on the Jira site and are in use by the current scheme.\n * ``The priorities with IDs [ID 1, ID 2, ...] provided as values for the 'out' mappings object do not exist. Please provide existing priority IDs used by the default scheme.`` The listed priority ID(s) have been provided as values for ``out`` mappings but are invalid. Please confirm the correct priority ID(s) have been provided, they should be priorities that exist on the Jira site and are in use by the Default Priority Scheme, but are not in use by the current scheme.\n * ``The priorities with IDs [ID 1, ID 2, ...] do not require mapping. Please remove these keys and their corresponding values from the 'in' mappings object.`` The listed priority ID(s) have been provided as keys for ``in`` mappings but are not required, they can be removed from the mappings object.\n * ``The priorities with IDs [ID 1, ID 2, ...] require mapping. Please provide mappings in the 'in' mappings object, where these priorities are the keys with corresponding values.`` The listed priority ID(s) have not been provided as keys for ``in`` mappings but are required, add them to the mappings object.\n * ``The priorities with IDs [ID 1, ID 2, ...] being mapped to are not in the current scheme. Please remove these values and their corresponding keys from the 'in' mappings object.`` The listed priority ID(s) have been provided as keys for ``in`` mappings but are not in use by the current scheme, they can be removed from the mappings object.\n * ``The priorities with IDs [ID 1, ID 2, ...] do not require mapping. Please remove these keys and their corresponding values from the 'out' mappings object.`` The listed priority ID(s) hve been provided as keys for ``out`` mappings but are not required, they can be removed from the mappings object.\n * ``The priorities with IDs [ID 1, ID 2, ...] require mapping. Please provide mappings in the 'out' mappings object, where these priorities are the keys with corresponding values.`` The listed priority ID(s) have not been provided as keys for ``out`` mappings but are required, add them to the mappings object.\n * ``The priorities with IDs [ID 1, ID 2, ...] being mapped to are not in the default scheme. Please remove these values and their corresponding keys from the 'out' mappings object.`` The listed priority ID(s) have been provided as keys for ``out`` mappings but are not in use by the Default Priority Scheme, they can be removed from the mappings object." '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user doesn't have the necessary permissions. '409': description: Returned if an action with this priority scheme is still in progress. '422': content: application/json: schema: $ref: '#/components/schemas/LimitExceededResponseBean' description: 422 response security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Update priority scheme tags: - Priority schemes x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:priority-scheme:jira state: Beta x-experimental: true x-atlassian-connect-scope: INACCESSIBLE /rest/api/3/priorityscheme/{schemeId}/priorities: get: deprecated: false description: 'Returns a paginated list of priorities by scheme. **Permissions required:** *Administer Jira* global permission.' operationId: getPrioritiesByPriorityScheme parameters: - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: '0' type: string - description: The maximum number of items to return per page. in: query name: maxResults schema: default: '50' type: string - description: The priority scheme ID. in: path name: schemeId required: true schema: type: string responses: '200': content: application/json: example: '{"isLast":true,"maxResults":50,"startAt":0,"total":3,"values":[{"description":"Serious problem that could block progress.","iconUrl":"/images/icons/priorities/high.svg","id":"1","isDefault":false,"name":"High","statusColor":"#f15C75"},{"description":"Has the potential to affect progress.","iconUrl":"/images/icons/priorities/medium.svg","id":"2","isDefault":true,"name":"Medium","statusColor":"#f79232"},{"description":"Minor problem or easily worked around.","iconUrl":"/images/icons/priorities/low.svg","id":"3","isDefault":false,"name":"Low","statusColor":"#707070"}]}' schema: $ref: '#/components/schemas/PageBeanPriorityWithSequence' description: Returned if the request is successful. '400': description: Returned if the request isn't valid. '401': description: Returned if the authentication credentials are incorrect. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get priorities by priority scheme tags: - Priority schemes x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:priority-scheme:jira state: Beta x-experimental: true x-atlassian-connect-scope: INACCESSIBLE /rest/api/3/priorityscheme/{schemeId}/projects: get: deprecated: false description: 'Returns a paginated list of projects by scheme. **Permissions required:** *Administer Jira* global permission.' operationId: getProjectsByPriorityScheme parameters: - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: '0' type: string - description: The maximum number of items to return per page. in: query name: maxResults schema: default: '50' type: string - description: The project IDs to filter by. For example, `projectId=10000&projectId=10001`. in: query name: projectId schema: items: format: int64 type: integer type: array uniqueItems: true - description: The priority scheme ID. in: path name: schemeId required: true schema: type: string - description: The string to query projects on by name. in: query name: query schema: default: '' type: string responses: '200': content: application/json: example: '{"isLast":true,"maxResults":50,"startAt":0,"total":1,"values":[{"avatarUrls":{"16x16":"secure/projectavatar?size=xsmall&pid=10000","24x24":"secure/projectavatar?size=small&pid=10000","32x32":"secure/projectavatar?size=medium&pid=10000","48x48":"secure/projectavatar?size=large&pid=10000"},"id":"10000","key":"EX","name":"Example","projectCategory":{"description":"Project category description","id":"10000","name":"A project category"},"projectTypeKey":"ProjectTypeKey{key=''software''}","self":"project/EX","simplified":false}]}' schema: $ref: '#/components/schemas/PageBeanProject' description: Returned if the request is successful. '400': description: Returned if the request isn't valid. '401': description: Returned if the authentication credentials are incorrect. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get projects by priority scheme tags: - Priority schemes x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:priority-scheme:jira state: Beta x-experimental: true x-atlassian-connect-scope: INACCESSIBLE components: schemas: UpdateProjectsInSchemeRequestBean: additionalProperties: true description: Update projects in a scheme properties: add: allOf: - $ref: '#/components/schemas/PrioritySchemeChangesWithoutMappings' description: Projects to add to a scheme remove: allOf: - $ref: '#/components/schemas/PrioritySchemeChangesWithoutMappings' description: Projects to remove from a scheme type: object writeOnly: true ProjectCategory: additionalProperties: false description: A project category. properties: description: description: The description of the project category. type: string id: description: The ID of the project category. readOnly: true type: string name: description: The name of the project category. Required on create, optional on update. type: string self: description: The URL of the project category. format: uri readOnly: true type: string type: object SimpleLink: additionalProperties: false description: Details about the operations available in this version. properties: href: type: string iconClass: type: string id: type: string label: type: string styleClass: type: string title: type: string weight: format: int32 type: integer type: object xml: name: link User: additionalProperties: false description: "A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values." properties: accountId: description: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. maxLength: 128 type: string accountType: description: "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" enum: - atlassian - app - customer - unknown readOnly: true type: string active: description: Whether the user is active. readOnly: true type: boolean appType: description: "The app type of the user account when accountType is 'app'. Can take the following values:\n\n * `service` Service Account\n * `agent` Rovo Agent Account\n * `unknown` Unknown app type" readOnly: true type: string applicationRoles: allOf: - $ref: '#/components/schemas/SimpleListWrapperApplicationRole' description: The application roles the user is assigned to. readOnly: true avatarUrls: allOf: - $ref: '#/components/schemas/AvatarUrlsBean' description: The avatars of the user. readOnly: true displayName: description: The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. readOnly: true type: string emailAddress: description: The email address of the user. Depending on the user’s privacy setting, this may be returned as null. readOnly: true type: string expand: description: Expand options that include additional user details in the response. readOnly: true type: string xml: attribute: true groups: allOf: - $ref: '#/components/schemas/SimpleListWrapperGroupName' description: The groups that the user belongs to. readOnly: true guest: description: Whether the user is a guest. readOnly: true type: boolean key: description: This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. type: string locale: description: The locale of the user. Depending on the user’s privacy setting, this may be returned as null. readOnly: true type: string name: description: This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. type: string self: description: The URL of the user. format: uri readOnly: true type: string timeZone: description: The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. readOnly: true type: string type: object xml: name: user ListWrapperCallbackGroupName: additionalProperties: false type: object PrioritySchemeWithPaginatedPrioritiesAndProjects: additionalProperties: true description: A priority scheme with paginated priorities and projects. properties: default: type: boolean defaultPriorityId: description: The ID of the default issue priority. type: string description: description: The description of the priority scheme type: string id: description: The ID of the priority scheme. type: string isDefault: type: boolean writeOnly: true name: description: The name of the priority scheme type: string priorities: allOf: - $ref: '#/components/schemas/PageBeanPriorityWithSequence' description: The paginated list of priorities. projects: allOf: - $ref: '#/components/schemas/PageBeanProjectDetails' description: The paginated list of projects. self: description: The URL of the priority scheme. type: string required: - id - name type: object Scope: additionalProperties: true description: The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). properties: project: allOf: - $ref: '#/components/schemas/ProjectDetails' description: The project the item has scope in. readOnly: true type: description: The type of scope. enum: - PROJECT - TEMPLATE readOnly: true type: string type: object ListWrapperCallbackApplicationRole: additionalProperties: false type: object AvatarUrlsBean: additionalProperties: false properties: 16x16: description: The URL of the item's 16x16 pixel avatar. format: uri type: string 24x24: description: The URL of the item's 24x24 pixel avatar. format: uri type: string 32x32: description: The URL of the item's 32x32 pixel avatar. format: uri type: string 48x48: description: The URL of the item's 48x48 pixel avatar. format: uri type: string type: object PageBeanProject: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/Project' readOnly: true type: array type: object UpdatePrioritySchemeResponseBean: additionalProperties: true description: Details of the updated priority scheme. properties: priorityScheme: $ref: '#/components/schemas/PrioritySchemeWithPaginatedPrioritiesAndProjects' task: allOf: - $ref: '#/components/schemas/TaskProgressBeanJsonNode' description: The in-progress issue migration task. readOnly: true type: object PriorityMapping: additionalProperties: false description: Mapping of issue priorities for changes in priority schemes. properties: in: additionalProperties: format: int64 type: integer writeOnly: true description: 'The mapping of priorities for issues being migrated **into** this priority scheme. Key is the old priority ID, value is the new priority ID (must exist in this priority scheme). E.g. The current priority scheme has priority ID `10001`. Issues with priority ID `10000` are being migrated into this priority scheme will need mapping to new priorities. The `in` mapping would be `{"10000": 10001}`.' type: object writeOnly: true out: additionalProperties: format: int64 type: integer writeOnly: true description: 'The mapping of priorities for issues being migrated **out of** this priority scheme. Key is the old priority ID (must exist in this priority scheme), value is the new priority ID (must exist in the default priority scheme). Required for updating an existing priority scheme. Not used when creating a new priority scheme. E.g. The current priority scheme has priority ID `10001`. Issues with priority ID `10001` are being migrated out of this priority scheme will need mapping to new priorities. The `out` mapping would be `{"10001": 10000}`.' type: object writeOnly: true type: object writeOnly: true PageBeanPriorityWithSequence: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/PriorityWithSequence' readOnly: true type: array type: object PrioritySchemeId: additionalProperties: false description: The ID of a priority scheme. properties: id: description: The ID of the priority scheme. readOnly: true type: string task: allOf: - $ref: '#/components/schemas/TaskProgressBeanJsonNode' description: The in-progress issue migration task. readOnly: true type: object ProjectPermissions: additionalProperties: false description: Permissions which a user has on a project. properties: canEdit: description: Whether the logged user can edit the project. readOnly: true type: boolean type: object Project: additionalProperties: false description: Details about a project. properties: archived: description: Whether the project is archived. readOnly: true type: boolean archivedBy: allOf: - $ref: '#/components/schemas/User' description: The user who archived the project. readOnly: true archivedDate: description: The date when the project was archived. format: date-time readOnly: true type: string assigneeType: description: The default assignee when creating issues for this project. enum: - PROJECT_LEAD - UNASSIGNED readOnly: true type: string avatarUrls: allOf: - $ref: '#/components/schemas/AvatarUrlsBean' description: The URLs of the project's avatars. readOnly: true components: description: List of the components contained in the project. items: $ref: '#/components/schemas/ProjectComponent' readOnly: true type: array deleted: description: Whether the project is marked as deleted. readOnly: true type: boolean deletedBy: allOf: - $ref: '#/components/schemas/User' description: The user who marked the project as deleted. readOnly: true deletedDate: description: The date when the project was marked as deleted. format: date-time readOnly: true type: string description: description: A brief description of the project. readOnly: true type: string email: description: An email address associated with the project. type: string expand: description: Expand options that include additional project details in the response. readOnly: true type: string xml: attribute: true favourite: description: Whether the project is selected as a favorite. type: boolean id: description: The ID of the project. type: string insight: allOf: - $ref: '#/components/schemas/ProjectInsight' description: Insights about the project. readOnly: true isPrivate: description: Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues. readOnly: true type: boolean issueTypeHierarchy: allOf: - $ref: '#/components/schemas/Hierarchy' description: The issue type hierarchy for the project. readOnly: true issueTypes: description: List of the issue types available in the project. items: $ref: '#/components/schemas/IssueTypeDetails' readOnly: true type: array key: description: The key of the project. readOnly: true type: string landingPageInfo: allOf: - $ref: '#/components/schemas/ProjectLandingPageInfo' description: The project landing page info. readOnly: true lead: allOf: - $ref: '#/components/schemas/User' description: The username of the project lead. readOnly: true name: description: The name of the project. readOnly: true type: string permissions: allOf: - $ref: '#/components/schemas/ProjectPermissions' description: User permissions on the project readOnly: true projectCategory: allOf: - $ref: '#/components/schemas/ProjectCategory' description: The category the project belongs to. readOnly: true projectTypeKey: description: The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. enum: - software - service_desk - business - product_discovery readOnly: true type: string properties: additionalProperties: readOnly: true description: Map of project properties readOnly: true type: object retentionTillDate: description: The date when the project is deleted permanently. format: date-time readOnly: true type: string roles: additionalProperties: format: uri readOnly: true type: string description: The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post). readOnly: true type: object self: description: The URL of the project details. format: uri readOnly: true type: string simplified: description: Whether the project is simplified. readOnly: true type: boolean style: description: The type of the project. enum: - classic - next-gen readOnly: true type: string url: description: A link to information about this project, such as project documentation. readOnly: true type: string uuid: description: Unique ID for next-gen projects. format: uuid readOnly: true type: string versions: description: The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post). items: $ref: '#/components/schemas/Version' readOnly: true type: array type: object xml: name: project IssueTypeDetails: additionalProperties: false description: Details about an issue type. properties: avatarId: description: The ID of the issue type's avatar. format: int64 readOnly: true type: integer description: description: The description of the issue type. readOnly: true type: string entityId: description: Unique ID for next-gen projects. format: uuid readOnly: true type: string hierarchyLevel: description: Hierarchy level of the issue type. format: int32 readOnly: true type: integer iconUrl: description: The URL of the issue type's avatar. readOnly: true type: string id: description: The ID of the issue type. readOnly: true type: string name: description: The name of the issue type. readOnly: true type: string scope: allOf: - $ref: '#/components/schemas/Scope' description: Details of the next-gen projects the issue type is available in. readOnly: true self: description: The URL of these issue type details. readOnly: true type: string subtask: description: Whether this issue type is used to create subtasks. readOnly: true type: boolean type: object ProjectComponent: additionalProperties: false description: Details about a project component. properties: ari: description: Compass component's ID. Can't be updated. Not required for creating a Project Component. readOnly: true type: string assignee: allOf: - $ref: '#/components/schemas/User' description: The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component. readOnly: true assigneeType: description: "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." enum: - PROJECT_DEFAULT - COMPONENT_LEAD - PROJECT_LEAD - UNASSIGNED type: string description: description: The description for the component. Optional when creating or updating a component. type: string id: description: The unique identifier for the component. readOnly: true type: string isAssigneeTypeValid: description: 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. readOnly: true type: boolean lead: allOf: - $ref: '#/components/schemas/User' description: The user details for the component's lead user. readOnly: true leadAccountId: description: The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. maxLength: 128 type: string writeOnly: true leadUserName: description: This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. type: string metadata: additionalProperties: readOnly: true type: string description: Compass component's metadata. Can't be updated. Not required for creating a Project Component. readOnly: true type: object name: description: 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. type: string project: description: The key of the project the component is assigned to. Required when creating a component. Can't be updated. type: string projectId: description: The ID of the project the component is assigned to. format: int64 readOnly: true type: integer realAssignee: allOf: - $ref: '#/components/schemas/User' description: The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee. readOnly: true realAssigneeType: description: "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." enum: - PROJECT_DEFAULT - COMPONENT_LEAD - PROJECT_LEAD - UNASSIGNED readOnly: true type: string self: description: The URL of the component. format: uri readOnly: true type: string type: object xml: name: component ApplicationRole: additionalProperties: false description: Details of an application role. properties: defaultGroups: description: The groups that are granted default access for this application role. As a group's name can change, use of `defaultGroupsDetails` is recommended to identify a groups. items: type: string type: array uniqueItems: true defaultGroupsDetails: description: The groups that are granted default access for this application role. items: $ref: '#/components/schemas/GroupName' type: array defined: description: Deprecated. type: boolean groupDetails: description: The groups associated with the application role. items: $ref: '#/components/schemas/GroupName' type: array groups: description: The groups associated with the application role. As a group's name can change, use of `groupDetails` is recommended to identify a groups. items: type: string type: array uniqueItems: true hasUnlimitedSeats: type: boolean key: description: The key of the application role. type: string name: description: The display name of the application role. type: string numberOfSeats: description: The maximum count of users on your license. format: int32 type: integer platform: description: Indicates if the application role belongs to Jira platform (`jira-core`). type: boolean remainingSeats: description: The count of users remaining on your license. format: int32 type: integer selectedByDefault: description: Determines whether this application role should be selected by default on user creation. type: boolean userCount: description: The number of users counting against your license. format: int32 type: integer userCountDescription: description: The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license. type: string type: object VersionApprover: additionalProperties: true description: Contains details about a version approver. properties: accountId: description: The Atlassian account ID of the approver. readOnly: true type: string declineReason: description: A description of why the user is declining the approval. readOnly: true type: string description: description: A description of what the user is approving within the specified version. readOnly: true type: string status: description: The status of the approval, which can be *PENDING*, *APPROVED*, or *DECLINED* readOnly: true type: string type: object LimitExceededResponseBean: additionalProperties: false properties: current_count: format: int32 type: integer entity_type: type: string error_code: type: string limit_type: type: string max_allowed_limit: format: int32 type: integer message: type: string scope_id: type: string type: object PrioritySchemeChangesWithoutMappings: additionalProperties: false properties: ids: description: Affected entity ids. items: format: int64 type: integer writeOnly: true type: array writeOnly: true required: - ids type: object writeOnly: true Version: additionalProperties: false description: Details about a project version. properties: approvers: description: If the expand option `approvers` is used, returns a list containing the approvers for this version. items: $ref: '#/components/schemas/VersionApprover' readOnly: true type: array archived: description: Indicates that the version is archived. Optional when creating or updating a version. type: boolean description: description: The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes. type: string driver: description: The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option `driver` is used, returns the Atlassian account ID of the driver. type: string expand: description: "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\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 * `driver` Returns the Atlassian account ID of the version driver.\n * `approvers` Returns a list containing approvers for this version.\n\nOptional for create and update." type: string xml: attribute: true id: description: The ID of the version. readOnly: true type: string issuesStatusForFixVersion: allOf: - $ref: '#/components/schemas/VersionIssuesStatus' description: If the expand option `issuesstatus` is used, 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*. readOnly: true moveUnfixedIssuesTo: description: 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. format: uri type: string name: description: The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters. type: string operations: description: If the expand option `operations` is used, returns the list of operations available for this version. items: $ref: '#/components/schemas/SimpleLink' readOnly: true type: array overdue: description: Indicates that the version is overdue. readOnly: true type: boolean project: description: Deprecated. Use `projectId`. type: string projectId: description: The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version. format: int64 type: integer releaseDate: description: The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version. format: date type: string released: description: 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. type: boolean self: description: The URL of the version. format: uri readOnly: true type: string startDate: description: The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version. format: date type: string userReleaseDate: description: The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format. readOnly: true type: string userStartDate: description: The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format. readOnly: true type: string type: object xml: name: version VersionIssuesStatus: additionalProperties: true description: Counts of the number of issues in various statuses. properties: done: description: Count of issues with status *done*. format: int64 readOnly: true type: integer inProgress: description: Count of issues with status *in progress*. format: int64 readOnly: true type: integer toDo: description: Count of issues with status *to do*. format: int64 readOnly: true type: integer unmapped: description: Count of issues with a status other than *to do*, *in progress*, and *done*. format: int64 readOnly: true type: integer type: object UpdatePrioritySchemeRequestBean: additionalProperties: false description: Details of a priority scheme. properties: defaultPriorityId: description: The default priority of the scheme. format: int64 type: integer writeOnly: true description: description: The description of the priority scheme. maxLength: 4000 type: string writeOnly: true mappings: allOf: - $ref: '#/components/schemas/PriorityMapping' description: "Instructions to migrate the priorities of issues.\n\n`in` mappings are used to migrate the priorities of issues to priorities used within the priority scheme.\n\n`out` mappings are used to migrate the priorities of issues to priorities not used within the priority scheme.\n\n * When **priorities** are **added** to the priority scheme, no mapping needs to be provided as the new priorities are not used by any issues.\n * When **priorities** are **removed** from the priority scheme, issues that are using those priorities must be migrated to new priorities used by the priority scheme.\n \n * An `in` mapping must be provided for each of these priorities.\n * When **projects** are **added** to the priority scheme, the priorities of issues in those projects might need to be migrated to new priorities used by the priority scheme. This can occur when the current scheme does not use all the priorities in the project(s)' priority scheme(s).\n \n * An `in` mapping must be provided for each of these priorities.\n * When **projects** are **removed** from the priority scheme, the priorities of issues in those projects might need to be migrated to new priorities within the **Default Priority Scheme** that are not used by the priority scheme. This can occur when the **Default Priority Scheme** does not use all the priorities within the current scheme.\n \n * An `out` mapping must be provided for each of these priorities.\n\nFor more information on `in` and `out` mappings, see the child properties documentation for the `PriorityMapping` object below." name: description: The name of the priority scheme. Must be unique. maxLength: 255 type: string writeOnly: true priorities: allOf: - $ref: '#/components/schemas/UpdatePrioritiesInSchemeRequestBean' description: The priorities in the scheme. projects: allOf: - $ref: '#/components/schemas/UpdateProjectsInSchemeRequestBean' description: The projects in the scheme. type: object ProjectDetails: additionalProperties: false description: Details about a project. properties: avatarUrls: allOf: - $ref: '#/components/schemas/AvatarUrlsBean' description: The URLs of the project's avatars. readOnly: true id: description: The ID of the project. type: string key: description: The key of the project. readOnly: true type: string name: description: The name of the project. readOnly: true type: string projectCategory: allOf: - $ref: '#/components/schemas/UpdatedProjectCategory' description: The category the project belongs to. readOnly: true projectTypeKey: description: The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. enum: - software - service_desk - business - product_discovery readOnly: true type: string self: description: The URL of the project details. readOnly: true type: string simplified: description: Whether or not the project is simplified. readOnly: true type: boolean type: object PageBeanPrioritySchemeWithPaginatedPrioritiesAndProjects: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/PrioritySchemeWithPaginatedPrioritiesAndProjects' readOnly: true type: array type: object SimpleListWrapperApplicationRole: additionalProperties: false properties: callback: $ref: '#/components/schemas/ListWrapperCallbackApplicationRole' items: items: $ref: '#/components/schemas/ApplicationRole' type: array max-results: format: int32 type: integer xml: attribute: true name: max-results pagingCallback: $ref: '#/components/schemas/ListWrapperCallbackApplicationRole' size: format: int32 type: integer xml: attribute: true type: object xml: name: list UpdatePrioritiesInSchemeRequestBean: additionalProperties: true description: Update priorities in a scheme properties: add: allOf: - $ref: '#/components/schemas/PrioritySchemeChangesWithoutMappings' description: Priorities to add to a scheme remove: allOf: - $ref: '#/components/schemas/PrioritySchemeChangesWithoutMappings' description: Priorities to remove from a scheme type: object writeOnly: true ProjectLandingPageInfo: additionalProperties: false properties: attributes: additionalProperties: type: string type: object boardId: format: int64 type: integer boardName: type: string projectKey: type: string projectType: type: string queueCategory: type: string queueId: format: int64 type: integer queueName: type: string simpleBoard: type: boolean simplified: type: boolean url: type: string type: object ProjectInsight: additionalProperties: false description: Additional details about a project. properties: lastIssueUpdateTime: description: The last issue update time. format: date-time readOnly: true type: string totalIssueCount: description: Total issue count. format: int64 readOnly: true type: integer type: object UpdatedProjectCategory: additionalProperties: false description: A project category. properties: description: description: The name of the project category. readOnly: true type: string id: description: The ID of the project category. readOnly: true type: string name: description: The description of the project category. readOnly: true type: string self: description: The URL of the project category. readOnly: true type: string type: object SuggestedMappingsForPrioritiesRequestBean: additionalProperties: false description: Details of changes to a priority scheme's priorities that require suggested priority mappings. properties: add: description: The ids of priorities being removed from the scheme. items: format: int64 type: integer writeOnly: true type: array writeOnly: true remove: description: The ids of priorities being removed from the scheme. items: format: int64 type: integer writeOnly: true type: array writeOnly: true type: object writeOnly: true PageBeanProjectDetails: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/ProjectDetails' readOnly: true type: array type: object SimplifiedHierarchyLevel: additionalProperties: false properties: aboveLevelId: description: 'The ID of the level above this one in the hierarchy. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).' format: int64 type: integer belowLevelId: description: 'The ID of the level below this one in the hierarchy. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).' format: int64 type: integer externalUuid: description: 'The external UUID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).' format: uuid type: string hierarchyLevelNumber: format: int32 type: integer id: description: 'The ID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).' format: int64 type: integer issueTypeIds: description: The issue types available in this hierarchy level. items: format: int64 type: integer type: array level: description: The level of this item in the hierarchy. format: int32 type: integer name: description: The name of this hierarchy level. type: string projectConfigurationId: description: 'The ID of the project configuration. This property is deprecated, see [Change oticen: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).' format: int64 type: integer type: object SuggestedMappingsForProjectsRequestBean: additionalProperties: false description: Details of changes to a priority scheme's projects that require suggested priority mappings. properties: add: description: The ids of projects being added to the scheme. items: format: int64 type: integer writeOnly: true type: array writeOnly: true type: object writeOnly: true SuggestedMappingsRequestBean: additionalProperties: false description: Details of changes to a priority scheme that require suggested priority mappings. properties: maxResults: description: The maximum number of results that could be on the page. format: int32 type: integer writeOnly: true priorities: allOf: - $ref: '#/components/schemas/SuggestedMappingsForPrioritiesRequestBean' description: The priority changes in the scheme. projects: allOf: - $ref: '#/components/schemas/SuggestedMappingsForProjectsRequestBean' description: The project changes in the scheme. schemeId: description: The id of the priority scheme. format: int64 type: integer writeOnly: true startAt: description: The index of the first item returned on the page. format: int64 type: integer writeOnly: true type: object GroupName: additionalProperties: false description: Details about a group. properties: groupId: description: The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. type: - string - 'null' name: description: The name of group. type: string self: description: The URL for these group details. format: uri readOnly: true type: string type: object TaskProgressBeanJsonNode: additionalProperties: false description: Details about a task. properties: description: description: The description of the task. type: string elapsedRuntime: description: The execution time of the task, in milliseconds. format: int64 type: integer finished: description: A timestamp recording when the task was finished. format: int64 type: integer id: description: The ID of the task. type: string lastUpdate: description: A timestamp recording when the task progress was last updated. format: int64 type: integer message: description: Information about the progress of the task. type: string progress: description: The progress of the task, as a percentage complete. format: int64 type: integer result: allOf: - $ref: '#/components/schemas/JsonNode' description: The result of the task execution. self: description: The URL of the task. format: uri type: string started: description: A timestamp recording when the task was started. format: int64 type: integer status: description: The status of the task. enum: - ENQUEUED - RUNNING - COMPLETE - FAILED - CANCEL_REQUESTED - CANCELLED - DEAD type: string submitted: description: A timestamp recording when the task was submitted. format: int64 type: integer submittedBy: description: The ID of the user who submitted the task. format: int64 type: integer required: - elapsedRuntime - id - lastUpdate - progress - self - status - submitted - submittedBy type: object JsonNode: additionalProperties: false maxProperties: 10 minProperties: 1 properties: array: type: boolean bigDecimal: type: boolean bigInteger: type: boolean bigIntegerValue: type: integer binary: type: boolean binaryValue: items: format: byte type: string type: array boolean: type: boolean booleanValue: type: boolean containerNode: type: boolean decimalValue: type: number double: type: boolean doubleValue: format: double type: number elements: type: object fieldNames: type: object fields: type: object floatingPointNumber: type: boolean int: type: boolean intValue: format: int32 type: integer integralNumber: type: boolean long: type: boolean longValue: format: int64 type: integer missingNode: type: boolean 'null': type: boolean number: type: boolean numberType: enum: - INT - LONG - BIG_INTEGER - FLOAT - DOUBLE - BIG_DECIMAL type: string numberValue: type: number object: type: boolean pojo: type: boolean textValue: type: string textual: type: boolean valueAsBoolean: type: boolean valueAsDouble: format: double type: number valueAsInt: format: int32 type: integer valueAsLong: format: int64 type: integer valueAsText: type: string valueNode: type: boolean type: object SimpleListWrapperGroupName: additionalProperties: false properties: callback: $ref: '#/components/schemas/ListWrapperCallbackGroupName' items: items: $ref: '#/components/schemas/GroupName' type: array max-results: format: int32 type: integer xml: attribute: true name: max-results pagingCallback: $ref: '#/components/schemas/ListWrapperCallbackGroupName' size: format: int32 type: integer xml: attribute: true type: object xml: name: list CreatePrioritySchemeDetails: additionalProperties: false description: Details of a new priority scheme properties: defaultPriorityId: description: The ID of the default priority for the priority scheme. format: int64 type: integer writeOnly: true description: description: The description of the priority scheme. maxLength: 4000 type: string writeOnly: true mappings: allOf: - $ref: '#/components/schemas/PriorityMapping' description: "Instructions to migrate the priorities of issues.\n\n`in` mappings are used to migrate the priorities of issues to priorities used within the priority scheme.\n\n`out` mappings are used to migrate the priorities of issues to priorities not used within the priority scheme.\n\n * When **priorities** are **added** to the new priority scheme, no mapping needs to be provided as the new priorities are not used by any issues.\n * When **priorities** are **removed** from the new priority scheme, no mapping needs to be provided as the removed priorities are not used by any issues.\n * When **projects** are **added** to the priority scheme, the priorities of issues in those projects might need to be migrated to new priorities used by the priority scheme. This can occur when the current scheme does not use all the priorities in the project(s)' priority scheme(s).\n \n * An `in` mapping must be provided for each of these priorities.\n * When **projects** are **removed** from the priority scheme, no mapping needs to be provided as the removed projects are not using the priorities of the new priority scheme.\n\nFor more information on `in` and `out` mappings, see the child properties documentation for the `PriorityMapping` object below." name: description: The name of the priority scheme. Must be unique. maxLength: 255 type: string writeOnly: true priorityIds: description: The IDs of priorities in the scheme. items: format: int64 maxLength: 300 minLength: 1 type: integer writeOnly: true maxLength: 300 minLength: 1 type: array writeOnly: true projectIds: description: The IDs of projects that will use the priority scheme. items: format: int64 type: integer writeOnly: true type: array uniqueItems: true writeOnly: true required: - defaultPriorityId - name - priorityIds type: object PriorityWithSequence: additionalProperties: false description: An issue priority with sequence information. properties: description: description: The description of the issue priority. type: string iconUrl: description: The URL of the icon for the issue priority. type: string id: description: The ID of the issue priority. type: string isDefault: description: Whether this priority is the default. type: boolean name: description: The name of the issue priority. type: string self: description: The URL of the issue priority. type: string sequence: description: The sequence of the issue priority. type: string statusColor: description: The color used to indicate the issue priority. type: string type: object Hierarchy: additionalProperties: false description: The project issue type hierarchy. properties: baseLevelId: description: 'The ID of the base level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).' format: int64 type: integer levels: description: Details about the hierarchy level. items: $ref: '#/components/schemas/SimplifiedHierarchyLevel' readOnly: true type: array type: object xml: name: hierarchy securitySchemes: OAuth2: description: OAuth2 scopes for Jira flows: authorizationCode: authorizationUrl: https://auth.atlassian.com/authorize scopes: delete:async-task:jira: Delete asynchronous task. delete:attachment:jira: Delete issue attachments. delete:avatar:jira: Delete system and custom avatars. delete:comment.property:jira: Delete issue comment properties. delete:comment:jira: Delete issue comments. delete:dashboard.property:jira: Delete dashboard properties. delete:dashboard:jira: Delete dashboards. delete:field-configuration-scheme:jira: Delete field configuration schemes. delete:field-configuration:jira: Delete field configurations. delete:field.option:jira: Delete field options. delete:field:jira: Delete fields. delete:filter.column:jira: Delete filter columns. delete:filter:jira: Delete filters. delete:group:jira: Delete user groups. delete:issue-link-type:jira: Delete issue link types. delete:issue-link:jira: Delete issue links. delete:issue-type-scheme:jira: Delete issue type schemes. delete:issue-type-screen-scheme:jira: Delete issue type screen schemes. delete:issue-type.property:jira: Delete issue type properties. delete:issue-type:jira: Delete issue types. delete:issue-worklog.property:jira: Delete issue worklog properties. delete:issue-worklog:jira: Delete issue worklogs. delete:issue.property:jira: Delete issue properties. delete:issue.remote-link:jira: Delete issue remote links. delete:issue:jira: Delete issues. delete:permission-scheme:jira: Delete permission schemes. delete:permission:jira: Delete permissions. delete:project-category:jira: Delete project categories. delete:project-role:jira: Delete project roles. delete:project-version:jira: Delete project versions. delete:project.avatar:jira: Delete project avatars. delete:project.component:jira: Delete project components. delete:project.property:jira: Delete project properties. delete:project:jira: Delete projects and their details, such as issue types, project lead, and avatars. delete:screen-scheme:jira: Delete screen schemes. delete:screen-tab:jira: Delete screen tabs. delete:screen:jira: Delete screens. delete:screenable-field:jira: Delete screenable fields. delete:user-configuration:jira: Delete user configurations. delete:user.property:jira: Delete user properties. delete:webhook:jira: Delete webhooks. delete:workflow-scheme:jira: Delete workflow schemes. delete:workflow.property:jira: Delete workflow properties. delete:workflow:jira: Delete workflows. manage:jira-configuration: Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types. manage:jira-project: Create and edit project settings and create new project-level objects, for example, versions, components. manage:jira-webhook: Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks. read:app-data:jira: Read app data. read:application-role:jira: View application roles. read:attachment:jira: View issue attachments. read:audit-log:jira: View audit logs. read:avatar:jira: View system and custom avatars. read:comment.property:jira: View issue comment properties. read:comment:jira: View issue comments. read:custom-field-contextual-configuration:jira: Read custom field contextual configurations. read:dashboard.property:jira: View dashboard properties. read:dashboard:jira: View dashboards. read:email-address:jira: View email addresses of all users regardless of the user's profile visibility settings. read:field-configuration-scheme:jira: View field configuration schemes. read:field-configuration:jira: Read field configurations. read:field.default-value:jira: View field default values. read:field.option:jira: View field options. read:field.options:jira: Read field options. read:field:jira: View fields. read:filter.column:jira: View filter columns. read:filter.default-share-scope:jira: View filter default share scopes. read:filter:jira: View filters. read:group:jira: View user groups. read:instance-configuration:jira: View instance configurations. read:issue-details:jira: View issue details. read:issue-event:jira: Read issue events. read:issue-field-values:jira: View issue field valueses. read:issue-link-type:jira: View issue link types. read:issue-link:jira: View issue links. read:issue-meta:jira: View issue meta. read:issue-security-level:jira: View issue security levels. read:issue-security-scheme:jira: View issue security schemes. read:issue-status:jira: View issue statuses. read:issue-type-hierarchy:jira: Read issue type hierarchies. read:issue-type-scheme:jira: View issue type schemes. read:issue-type-screen-scheme:jira: View issue type screen schemes. read:issue-type.property:jira: View issue type properties. read:issue-type:jira: View issue types. read:issue-worklog.property:jira: View issue worklog properties. read:issue-worklog:jira: View issue worklogs. read:issue.changelog:jira: View issue changelogs. read:issue.property:jira: View issue properties. read:issue.remote-link:jira: View issue remote links. read:issue.time-tracking:jira: View issue time trackings. read:issue.transition:jira: View issue transitions. read:issue.vote:jira: View issue votes. read:issue.votes:jira: View issue voteses. read:issue.watcher:jira: View issue watchers. read:issue:jira: View issues. read:jira-expressions:jira: View jira expressions. read:jira-user: View user information in Jira that you have access to, including usernames, email addresses, and avatars. read:jira-work: Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs). read:jql:jira: View JQL. read:label:jira: View labels. read:license:jira: View licenses. read:notification-scheme:jira: View notification schemes. read:permission-scheme:jira: View permission schemes. read:permission:jira: View permissions. read:priority:jira: View priorities. read:project-category:jira: View project categories. read:project-role:jira: View project roles. read:project-type:jira: View project types. read:project-version:jira: View project versions. read:project.avatar:jira: Read project avatars. read:project.component:jira: View project components. read:project.email:jira: View project emails. read:project.feature:jira: Read project features. read:project.property:jira: View project properties. read:project:jira: View projects. read:resolution:jira: View resolutions. read:role:jira: View roles. read:screen-field:jira: View screen fields. read:screen-scheme:jira: View screen schemes. read:screen-tab:jira: View screen tabs. read:screen:jira: View screens. read:screenable-field:jira: View screenable fields. read:status:jira: View statuses. read:user-configuration:jira: View user configurations. read:user.columns:jira: View user columnses. read:user.property:jira: View user properties. read:user:jira: View users. read:webhook:jira: View webhooks. read:workflow-scheme:jira: View workflow schemes. read:workflow.property:jira: View workflow properties. read:workflow:jira: View workflows. send:notification:jira: Send notifications. validate:jql:jira: Validate JQL. write:app-data:jira: Write app data. write:attachment:jira: Create and update issue attachments. write:avatar:jira: Create and update system and custom avatars. write:comment.property:jira: Create and update issue comment properties. write:comment:jira: Create and update issue comments. write:custom-field-contextual-configuration:jira: Save custom field contextual configurations. write:dashboard.property:jira: Create and update dashboard properties. write:dashboard:jira: Create and update dashboards. write:field-configuration-scheme:jira: Create and update field configuration schemes. write:field-configuration:jira: Save field configurations. write:field.default-value:jira: Create and update field default values. write:field.option:jira: Create and update field options. write:field:jira: Create and update fields. write:filter.column:jira: Create and update filter columns. write:filter.default-share-scope:jira: Create and update filter default share scopes. write:filter:jira: Create and update filters. write:group:jira: Create and update user groups. write:instance-configuration:jira: Create and update instance configurations. write:issue-link-type:jira: Create and update issue link types. write:issue-link:jira: Create and update issue links. write:issue-type-scheme:jira: Create and update issue type schemes. write:issue-type-screen-scheme:jira: Create and update issue type screen schemes. write:issue-type.property:jira: Create and update issue type properties. write:issue-type:jira: Create and update issue types. write:issue-worklog.property:jira: Create and update issue worklog properties. write:issue-worklog:jira: Create and update issue worklogs. write:issue.property:jira: Create and update issue properties. write:issue.remote-link:jira: Create and update issue remote links. write:issue.time-tracking:jira: Create and update issue time trackings. write:issue.vote:jira: Create and update issue votes. write:issue.watcher:jira: Create and update issue watchers. write:issue:jira: Create and update issues. write:jira-work: Create and edit issues in Jira, post comments, create worklogs, and delete issues. write:permission-scheme:jira: Create and update permission schemes. write:permission:jira: Create and update permissions. write:project-category:jira: Create and update project categories. write:project-role:jira: Create and update project roles. write:project-version:jira: Create and update project versions. write:project.avatar:jira: Create and update project avatars. write:project.component:jira: Create and update project components. write:project.email:jira: Create and update project emails. write:project.feature:jira: Save project features. write:project.property:jira: Create and update project properties. write:project:jira: Create and update projects. write:screen-scheme:jira: Create and update screen schemes. write:screen-tab:jira: Create and update screen tabs. write:screen:jira: Create and update screens. write:screenable-field:jira: Create and update screenable fields. write:user-configuration:jira: Create and update user configurations. write:user.property:jira: Create and update user properties. write:webhook:jira: Create and update webhooks. write:workflow-scheme:jira: Create and update workflow schemes. write:workflow.property:jira: Create and update workflow properties. write:workflow:jira: Create and update workflows. tokenUrl: https://auth.atlassian.com/oauth/token type: oauth2 basicAuth: description: You can access this resource via basic auth. scheme: basic type: http externalDocs: description: Find out more about Atlassian products and services. url: http://www.atlassian.com x-atlassian-narrative: documents: - anchor: about body: "The Jira REST API enables you to interact with Jira programmatically. Use this API to \n[build apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/), script interactions with \nJira, or develop any other type of integration. This page documents the REST resources available in Jira Cloud, including \nthe HTTP response codes and example requests and responses." title: About - anchor: version body: "This documentation is for **version 3** of the Jira Cloud platform REST API, which is the latest\nversion. [Version 2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) and\nversion 3 of the API offer the same collection of operations. However, version 3 provides support for\nthe [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)\n(ADF) in:\n- `body` in comments, including where comments are used in issue, issue link, and transition resources.\n- `comment` in worklogs.\n- `description` and `environment` fields in issues.\n- `textarea` type custom fields (multi-line text fields) in issues. Single line custom fields\n (`textfield`) accept a string and don't handle Atlassian Document Format content.\n" title: Version - anchor: authentication body: "### Forge apps\n\nFor Forge apps, [REST API scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/) \nare used when authenticating with Jira Cloud platform. See [Add scopes to call an Atlassian REST API](https://developer.atlassian.com/platform/forge/add-scopes-to-call-an-atlassian-rest-api/) for more details.\n\nThe URIs for Forge app REST API calls have this structure:\n\n`/rest/api/3/`\n\nFor example, `/rest/api/3/issue/DEMO-1`\n\n### Connect apps\n\nFor Connect apps, authentication (JWT-based) is built into the Connect libraries. Authorization is implemented using either \nscopes (shown as _App scope required_ for operations on this page) or user impersonation. See \n[Security for Connect apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/) \nfor details.\n\nThe URIs for Connect app REST API calls have this structure:\n\n`https:///rest/api/3/`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n\n### Other integrations\n\nFor integrations that are not Forge or Connect apps, use OAuth 2.0 authorization code grants (3LO) for security \n(3LO scopes are shown as for operations _OAuth scopes required_). See \n[OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) \nfor details.\n\nThe URIs for OAuth 2.0 (3LO) app REST API calls have this structure:\n\n`https://api.atlassian.com/ex/jira//rest/api/3/`\n\nFor example, `https://api.atlassian.com/ex/jira/35273b54-3f06-40d2-880f-dd28cf8daafa/rest/api/3/issue/DEMO-1`\n\n### Ad-hoc API calls\n\nFor personal scripts, bots, and ad-hoc execution of the REST APIs use basic authentication. See [Basic auth for REST APIs](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/) for details. \n\nThe URIs for basic authentication REST API calls have this structure:\n\n`https:///rest/api/3/`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n" title: Authentication and authorization - anchor: permissions body: "### Operation permissions\n\nMost operations in this API require permissions. The calling user must have the required permissions for an operation to \nuse it. Note that for Connect apps, the app user must have the required permissions for the operation and the app must \nhave scopes that permit the operation.\n\nA permission can be granted to a group, project role, or issue role that the user is a member of, or granted directly to a user. \nSee [Permissions overview](https://confluence.atlassian.com/x/FQiiLQ) for details. The most common permissions are:\n\n- **Administer the Cloud site**: Users in the _site-admins_ group have this \npermission. See [Manage groups](https://confluence.atlassian.com/x/24xjL) for details.\n- **Administer Jira**: Granted by the _Jira Administrators_ global permission. There is a default group for this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and [Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n- **Administer a project in Jira**: Granted by the _Administer projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access a project in Jira**: Granted by the _Browse projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access Jira**: Granted by the _Jira Users_ global permission. Users in the default product access group (for example, \n_jira-software-users-acmesite_) have this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and \n[Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n\n### Anonymous access\n\nSome operations provide support for anonymous access. However, anonymous access is only available if \nthe Jira permission needed to access the object or records returned by the operation is granted to \nthe _Public_ group. See [Allowing anonymous access to your project](https://confluence.atlassian.com/x/GDxxLg) \nfor details.\n\nIf an operation is called anonymously and anonymous access is not available, the operation will return \nan error. Note that not all operations that correspond to objects that can be given public access \nprovide for anonymous access.\n" title: Permissions - anchor: expansion body: "### Expansion\n\nThe Jira REST API uses resource expansion, which means that some parts of a resource are not returned unless specified \nin the request. This simplifies responses and minimizes network traffic.\n\nTo expand part of a resource in a request, use the expand query parameter and specify the object(s) to be expanded. \nIf you need to expand nested objects, use the `.` dot notation. If you need to expand multiple objects, use a \ncomma-separated list. \n\nFor example, the following request expands the `names` and `renderedFields` properties for the _JRACLOUD-34423_ issue:\n\n`GET issue/JRACLOUD-34423?expand=names,renderedFields`\n\nTo discover which object can be expanded, refer to the `expand` property in the object. \nIn the JSON example below, the resource declares `widgets` as expandable.\n\n```json\n{\n \"expand\": \"widgets\", \n \"self\": \"https://your-domain.atlassian.net/rest/api/3/resource/KEY-1\", \n \"widgets\": {\n \"widgets\": [],\n \"size\": 5\n }\n}\n```\n\n### Pagination\n\nThe Jira REST API uses pagination to improve performance. Pagination is enforced for operations that could return a large \ncollection of items. When you make a request to a paginated resource, the response wraps the returned array of values in \na JSON object with paging metadata. For example:\n\n```json\n{\n \"startAt\" : 0,\n \"maxResults\" : 10,\n \"total\": 200,\n \"isLast\": false,\n \"values\": [\n { /* result 0 */ },\n { /* result 1 */ },\n { /* result 2 */ }\n ]\n}\n```\n\n* `startAt` is the index of the first item returned in the page.\n* `maxResults` is the maximum number of items that a page can return. Each operation can have a different limit for\n the number of items returned, and these limits may change without notice. To find the maximum number of items \n that an operation could return, set `maxResults` to a large number—for example, over 1000—and if the returned value of `maxResults` is less than the requested value, the returned value is the maximum.\n* `total` is the total number of items contained in all pages. This number **_may change_** as the client \nrequests the subsequent pages, therefore the client should always assume that the requested page can be empty. Note \nthat this property is not returned for all operations.\n* `isLast` indicates whether the page returned is the last one. Note that this property is not returned for all operations.\n\n### Ordering\n\nSome operations support ordering the elements of a response by a field. Check the documentation for the operation to \nconfirm whether ordering of a response is supported and which fields can be used. Responses are listed in ascending order \nby default. You can change the order using the `orderby` query parameter with a `-` or `+` symbol. For example:\n\n* `?orderBy=name` to order by `name` field ascending.\n* `?orderBy=+name` to order by `name` field ascending.\n* `?orderBy=-name` to order by `name` field descending.\n\n\n" title: Expansion, pagination, and ordering - anchor: timestamps body: 'By default, top-level timestamps (e.g. updated and created) are returned in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, in the system default user time zone. To return date time data in the logged in user''s timezone, please refer to `renderedFields` property under the `expand` query parameter in relevant APIs. ' title: Timestamps - anchor: special-request-headers body: 'The following request and response headers define important metadata for the Jira Cloud REST API resources. - `X-Atlassian-Token` (request): Operations that accept multipart/form-data must include the `X-Atlassian-Token: no-check` header in requests. Otherwise the request is blocked by cross-site request forgery (CSRF/XSRF) protection. - `X-Force-Accept-Language` (request): controls how the standard HTTP `Accept-Language` header is processed. By default `Accept-Language` is ignored and the response is in the language configured in the user''s profile or, when no language is configured for the user, the default Jira instance language. For the response to recognize `Accept-Language` send `X-Force-Accept-Language = true` as well. If `Accept-Language` requests a language that Jira can return the response is in that language, otherwise Jira returns the response in the default language. If `Accept-Language` is not specified the response is in the default language. - `X-AAccountId` (response): This response header contains the Atlassian account ID of the authenticated user.' title: Special headers - anchor: anonymous-operations body: " Jira provides for all permissions, except the [global permission](https://confluence.atlassian.com/x/x4dKLg) Administer Jira, to be assigned to *Anyone*. Once a permission is assigned to *Anyone*, anyone knowing a project's URL is able to use the features in Jira enabled by the permission. However, the Jira REST API does not enable anonymous access for operations by default. This means that an anonymous user who may be able to perform an action through Jira, may not be able to perform the same action where it's enabled by the REST API. \n\n The operations that provide anonymous access are annotated \"This operation can be accessed anonymously.\"" title: Anonymous operations - anchor: async-operations body: "Some Jira REST API operations may trigger long-running or computationally expensive tasks. In these cases, the operation \nwill schedule an asynchronous task and return a `303 (See Other)` response, indicating the location of the queued task \nin the `Location` header. You can query this task to get progress updates.\n\nWhen the task finishes, the response object will contain the `result` field. The content of the field is specific to the \noperation that created the task. Refer to the operation’s documentation for more information.\n\nNote that asynchronous tasks are not guaranteed to be run in order. In other words, if you need your tasks to execute \nin a certain order, you should start a task only after the prerequisite task(s) have finished." title: Asynchronous operations - anchor: experimental body: "Features and methods marked as experimental may change without notice. Feedback on experimental functionality is welcome. \nReport issues to [Developer and Marketplace support](https://developer.atlassian.com/support) (preferred) or use the \n**Give docs feedback** link at the top of this page. \n" title: Experimental features - anchor: status-codes body: "The Jira Cloud platform REST API uses the [standard HTTP status codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).\n\nOperations that return an error status code may also return a response body containing details of the error or errors. \nThe schema for the response body is shown below:\n\n\n```json\n{\n \"id\": \"https://docs.atlassian.com/jira/REST/schema/error-collection#\",\n \"title\": \"Error Collection\",\n \"type\": \"object\",\n \"properties\": {\n \"errorMessages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"errors\": {\n \"type\": \"object\",\n \"patternProperties\": {\n \".+\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": false\n },\n \"status\": { \n \"type\": \"integer\"\n }\n },\n \"additionalProperties\": false\n}\n```" title: Status codes