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 Workflow schemes API version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df servers: - url: https://your-domain.atlassian.net tags: - description: This resource represents workflow schemes. name: Workflow Schemes paths: /rest/api/3/workflowscheme: get: deprecated: false description: 'Returns a paginated list of all workflow schemes, not including draft workflow schemes. **Permissions required:** *Administer Jira* global permission.' operationId: getAllWorkflowSchemes parameters: - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 format: int32 type: integer responses: '200': content: application/json: example: '{"isLast":true,"maxResults":50,"startAt":0,"total":2,"values":[{"defaultWorkflow":"jira","description":"The description of the example workflow scheme.","id":101010,"issueTypeMappings":{"10000":"scrum workflow","10001":"builds workflow"},"name":"Example workflow scheme","self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"},{"defaultWorkflow":"jira","description":"The description of the another example workflow scheme.","id":101011,"issueTypeMappings":{"10000":"scrum workflow","10001":"builds workflow"},"name":"Another example workflow scheme","self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/101011"}]}' schema: $ref: '#/components/schemas/PageBeanWorkflowScheme' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get all workflow schemes tags: - Workflow 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:workflow-scheme:jira - read:application-role:jira - read:avatar:jira - read:group:jira - read:issue-type:jira - read:project-category:jira - read:project:jira - read:user:jira state: Beta x-atlassian-connect-scope: ADMIN post: deprecated: false description: 'Creates a workflow scheme. **Permissions required:** *Administer Jira* global permission.' operationId: createWorkflowScheme parameters: [] requestBody: content: application/json: example: defaultWorkflow: jira description: The description of the example workflow scheme. issueTypeMappings: '10000': scrum workflow '10001': builds workflow name: Example workflow scheme schema: $ref: '#/components/schemas/WorkflowScheme' required: true responses: '201': content: application/json: example: '{"defaultWorkflow":"jira","description":"The description of the example workflow scheme.","draft":false,"id":101010,"issueTypeMappings":{"10000":"scrum workflow","10001":"builds workflow"},"name":"Example workflow scheme","self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"}' schema: $ref: '#/components/schemas/WorkflowScheme' description: Returned if the request is successful. '400': description: Returned if the request is invalid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Create workflow scheme tags: - Workflow 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:workflow-scheme:jira - read:application-role:jira - read:avatar:jira - read:group:jira - read:issue-type:jira - read:project-category:jira - read:project:jira - read:user:jira - read:workflow-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/workflowscheme/project/switch: post: deprecated: false description: 'Switches a workflow scheme for a project. Workflow schemes can only be assigned to classic projects. **Calculating required mappings:** If statuses from the current workflow scheme won''t exist in the target workflow scheme, you must provide `mappingsByIssueTypeOverride` to specify how issues with those statuses should be migrated. Use the required workflow scheme mappings API to determine which statuses and issue types require mappings. **Permissions required:** *Administer Jira* global permission.' operationId: switchWorkflowSchemeForProject parameters: [] requestBody: content: application/json: example: mappingsByIssueTypeOverride: - issueTypeId: '10000' statusMappings: - newStatusId: '10003' oldStatusId: '3' - newStatusId: '10009' oldStatusId: '10' - issueTypeId: '10011' statusMappings: - newStatusId: '10003' oldStatusId: '3' - newStatusId: '10002' oldStatusId: '10003' projectId: '10001' targetSchemeId: '10002' schema: $ref: '#/components/schemas/WorkflowSchemeProjectSwitchBean' description: The request containing project ID, target scheme ID, and any issue type mappings. required: true responses: '303': content: application/json: schema: $ref: '#/components/schemas/TaskProgressBeanObject' description: Returned if the request is successful and the task has been started. '400': description: Returned if the request is invalid. '401': description: Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. '409': content: application/json: example: '{"errorMessages":["Another task is currently running, please try again later."],"errors":{"conflictingTaskId":"10000"}}' description: Returned if a conflicting task is already running. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Switch workflow scheme for project tags: - Workflow 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:workflow-scheme:jira - write:project:jira state: Beta x-experimental: true x-atlassian-connect-scope: ADMIN /rest/api/3/workflowscheme/read: post: deprecated: false description: 'Returns a list of workflow schemes by providing workflow scheme IDs or project IDs. **Permissions required:** * *Administer Jira* global permission to access all, including project-scoped, workflow schemes * *Administer projects* project permissions to access project-scoped workflow schemes' operationId: readWorkflowSchemes parameters: [] requestBody: content: application/json: example: projectIds: - '10047' - '10048' workflowSchemeIds: - 3e59db0f-ed6c-47ce-8d50-80c0c4572677 schema: $ref: '#/components/schemas/WorkflowSchemeReadRequest' required: true responses: '200': content: application/json: example: '[{"defaultWorkflow":{"description":"This is the default workflow for Software Development projects.","id":"3e59db0f-ed6c-47ce-8d50-80c0c4572677","name":"Default Software Development Workflow","version":{"id":"657812fc-bc72-400f-aae0-df8d88db3d9g","versionNumber":1}},"description":"This is the workflow scheme for the Software Development project type.","id":"3g78dg2a-ns2n-56ab-9812-42h5j1464567","name":"Software Developer Workflow Scheme","scope":{"project":{"id":"10047"},"type":"GLOBAL"},"taskId":"3f83dg2a-ns2n-56ab-9812-42h5j1461629","version":{"id":"527213fc-bc72-400f-aae0-df8d88db2c8a","versionNumber":1},"workflowsForIssueTypes":[{"issueTypeIds":["10013"],"workflow":{"description":"This is the workflow for the Software Development bug issue type.","id":"5e79ae0f-ed6c-47ce-8d50-80c0c4572745","name":"Software Development Bug Workflow","version":{"id":"897812dc-bc72-400f-aae0-df8d88fe3d8f","versionNumber":1}}}]}]' schema: items: $ref: '#/components/schemas/WorkflowSchemeReadResponse' type: array description: Returned if the request is successful. '400': description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Bulk get workflow schemes tags: - Workflow 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:workflow-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/workflowscheme/update: post: deprecated: false description: 'Updates company-managed and team-managed project workflow schemes. This API doesn''t have a concept of draft, so any changes made to a workflow scheme are immediately available. When changing the available statuses for issue types, an asynchronous task migrates the issues as defined in the provided mappings. **Permissions required:** * *Administer Jira* project permission to update all, including global-scoped, workflow schemes. * *Administer projects* project permission to update project-scoped workflow schemes.' operationId: updateSchemes parameters: [] requestBody: content: application/json: example: defaultWorkflowId: 3e59db0f-ed6c-47ce-8d50-80c0c4572677 description: description id: '10000' name: name statusMappingsByIssueTypeOverride: - issueTypeId: '10001' statusMappings: - newStatusId: '2' oldStatusId: '1' - newStatusId: '4' oldStatusId: '3' - issueTypeId: '10002' statusMappings: - newStatusId: '4' oldStatusId: '1' - newStatusId: '2' oldStatusId: '3' statusMappingsByWorkflows: - newWorkflowId: 3e59db0f-ed6c-47ce-8d50-80c0c4572677 oldWorkflowId: 3e59db0f-ed6c-47ce-8d50-80c0c4572677 statusMappings: - newStatusId: '2' oldStatusId: '1' - newStatusId: '4' oldStatusId: '3' version: id: 527213fc-bc72-400f-aae0-df8d88db2c8a versionNumber: 1 workflowsForIssueTypes: - issueTypeIds: - '10000' - '10003' workflowId: 3e59db0f-ed6c-47ce-8d50-80c0c4572677 - issueTypeIds: - 10001` - '10002' workflowId: 3f83dg2a-ns2n-56ab-9812-42h5j1461629 schema: $ref: '#/components/schemas/WorkflowSchemeUpdateRequest' required: true responses: '200': content: application/json: schema: {} description: Returned if the request is successful and there is no asynchronous task. '303': content: application/json: schema: $ref: '#/components/schemas/TaskProgressBeanObject' description: Returned if the request is successful and there is an asynchronous task for the migrations. '400': description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. '409': description: Returned if another workflow configuration update task is ongoing. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Update workflow scheme tags: - Workflow 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:workflow-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/workflowscheme/update/mappings: post: deprecated: false description: 'Gets the required status mappings for the desired changes to a workflow scheme. The results are provided per issue type and workflow. When updating a workflow scheme, status mappings can be provided per issue type, per workflow, or both. **Permissions required:** * *Administer Jira* permission to update all, including global-scoped, workflow schemes. * *Administer projects* project permission to update project-scoped workflow schemes.' operationId: getRequiredWorkflowSchemeMappings parameters: [] requestBody: content: application/json: example: defaultWorkflowId: '10010' id: '10001' workflowsForIssueTypes: - issueTypeIds: - '10010' - '10011' workflowId: '10001' schema: $ref: '#/components/schemas/WorkflowSchemeUpdateRequiredMappingsRequest' required: true responses: '200': content: application/json: example: '{"statusMappingsByIssueTypes":[{"issueTypeId":"10000","statusIds":["10000","10001"]}],"statusMappingsByWorkflows":[{"sourceWorkflowId":"10000","statusIds":["10000","10001"],"targetWorkflowId":"10001"}],"statuses":[{"category":"TODO","id":"10000","name":"To Do"}],"statusesPerWorkflow":[{"initialStatusId":"10000","statuses":["10000","10001"],"workflowId":"10000"}]}' schema: $ref: '#/components/schemas/WorkflowSchemeUpdateRequiredMappingsResponse' description: Returned if the request is successful. '400': description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get required status mappings for workflow scheme update tags: - Workflow 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:workflow-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/workflowscheme/{id}: delete: deprecated: false description: 'Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project). **Permissions required:** *Administer Jira* global permission.' operationId: deleteWorkflowScheme parameters: - description: The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as `schemeId`. For example, *schemeId=10301*. in: path name: id 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 scheme is active. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the workflow scheme is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Delete workflow scheme tags: - Workflow 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:workflow-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN get: deprecated: false description: 'Returns a workflow scheme. **Permissions required:** *Administer Jira* global permission.' operationId: getWorkflowScheme parameters: - description: The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as `schemeId`. For example, *schemeId=10301*. in: path name: id required: true schema: format: int64 type: integer - description: Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned. in: query name: returnDraftIfExists schema: default: false type: boolean responses: '200': content: application/json: example: '{"defaultWorkflow":"jira","description":"The description of the example workflow scheme.","draft":false,"id":101010,"issueTypeMappings":{"10000":"scrum workflow","10001":"builds workflow"},"name":"Example workflow scheme","self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"}' schema: $ref: '#/components/schemas/WorkflowScheme' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the workflow scheme is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get workflow scheme tags: - Workflow 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:workflow-scheme:jira - read:application-role:jira - read:avatar:jira - read:group:jira - read:issue-type:jira - read:project-category:jira - read:project:jira - read:user:jira state: Beta x-atlassian-connect-scope: ADMIN put: deprecated: false description: 'Updates a company-manged project workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that `updateDraftIfNeeded` is set to `true`. **Permissions required:** *Administer Jira* global permission.' operationId: updateWorkflowScheme parameters: - description: The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as `schemeId`. For example, *schemeId=10301*. in: path name: id required: true schema: format: int64 type: integer requestBody: content: application/json: example: defaultWorkflow: jira description: The description of the example workflow scheme. issueTypeMappings: '10000': scrum workflow name: Example workflow scheme updateDraftIfNeeded: false schema: $ref: '#/components/schemas/WorkflowScheme' required: true responses: '200': content: application/json: example: '{"defaultWorkflow":"jira","description":"The description of the example workflow scheme.","draft":false,"id":101010,"issueTypeMappings":{"10000":"scrum workflow","10001":"builds workflow"},"name":"Example workflow scheme","self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"}' schema: $ref: '#/components/schemas/WorkflowScheme' description: Returned if the request is successful. '400': description: Returned if the request is invalid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the workflow scheme is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Classic update workflow scheme tags: - Workflow 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:workflow-scheme:jira - write:workflow-scheme:jira - read:application-role:jira - read:avatar:jira - read:group:jira - read:issue-type:jira - read:project-category:jira - read:project:jira - read:user:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/workflowscheme/{id}/default: delete: deprecated: false description: 'Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira''s system workflow (the *jira* workflow). Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira. **Permissions required:** *Administer Jira* global permission.' operationId: deleteDefaultWorkflow parameters: - description: The ID of the workflow scheme. in: path name: id required: true schema: format: int64 type: integer - description: Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to `false`. in: query name: updateDraftIfNeeded schema: type: boolean responses: '200': content: application/json: example: '{"defaultWorkflow":"jira","description":"The description of the example workflow scheme.","draft":false,"id":101010,"issueTypeMappings":{"10000":"scrum workflow","10001":"builds workflow"},"name":"Example workflow scheme","self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"}' schema: $ref: '#/components/schemas/WorkflowScheme' description: Returned if the request is successful. '400': description: Returned if the workflow scheme cannot be edited and `updateDraftIfNeeded` is not `true`. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the workflow scheme is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Delete default workflow tags: - Workflow 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:workflow-scheme:jira - write:workflow-scheme:jira - read:application-role:jira - read:avatar:jira - read:group:jira - read:issue-type:jira - read:project-category:jira - read:project:jira - read:user:jira state: Beta x-atlassian-connect-scope: ADMIN get: deprecated: false description: 'Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has *All Unassigned Issue Types* listed in its issue types for the workflow scheme in Jira. **Permissions required:** *Administer Jira* global permission.' operationId: getDefaultWorkflow parameters: - description: The ID of the workflow scheme. in: path name: id required: true schema: format: int64 type: integer - description: Set to `true` to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned. in: query name: returnDraftIfExists schema: default: false type: boolean responses: '200': content: application/json: example: '{"workflow":"jira"}' schema: $ref: '#/components/schemas/DefaultWorkflow' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the workflow scheme is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get default workflow tags: - Workflow 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:workflow-scheme:jira - read:workflow:jira state: Beta x-atlassian-connect-scope: ADMIN put: deprecated: false description: 'Sets the default workflow for a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira. **Permissions required:** *Administer Jira* global permission.' operationId: updateDefaultWorkflow parameters: - description: The ID of the workflow scheme. in: path name: id required: true schema: format: int64 type: integer requestBody: content: application/json: example: updateDraftIfNeeded: false workflow: jira schema: $ref: '#/components/schemas/DefaultWorkflow' description: The new default workflow. required: true responses: '200': content: application/json: example: '{"defaultWorkflow":"jira","description":"The description of the example workflow scheme.","draft":false,"id":101010,"issueTypeMappings":{"10000":"scrum workflow","10001":"builds workflow"},"name":"Example workflow scheme","self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"}' schema: $ref: '#/components/schemas/WorkflowScheme' description: Returned if the request is successful. '400': description: Returned if the workflow scheme cannot be edited and `updateDraftIfNeeded` is not `true`. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the workflow scheme is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Update default workflow tags: - Workflow 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:workflow-scheme:jira - write:workflow-scheme:jira - read:application-role:jira - read:avatar:jira - read:group:jira - read:issue-type:jira - read:project-category:jira - read:project:jira - read:user:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/workflowscheme/{id}/issuetype/{issueType}: delete: deprecated: false description: 'Deletes the issue type-workflow mapping for an issue type in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira. **Permissions required:** *Administer Jira* global permission.' operationId: deleteWorkflowSchemeIssueType parameters: - description: The ID of the workflow scheme. in: path name: id required: true schema: format: int64 type: integer - description: The ID of the issue type. in: path name: issueType required: true schema: type: string - description: Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to `false`. in: query name: updateDraftIfNeeded schema: default: false type: boolean responses: '200': content: application/json: example: '{"defaultWorkflow":"jira","description":"The description of the example workflow scheme.","draft":false,"id":101010,"issueTypeMappings":{"10000":"scrum workflow","10001":"builds workflow"},"name":"Example workflow scheme","self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"}' schema: $ref: '#/components/schemas/WorkflowScheme' description: Returned if the request is successful. '400': description: Returned if the workflow cannot be edited and `updateDraftIfNeeded` is false. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the workflow scheme or issue type is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Delete workflow for issue type in workflow scheme tags: - Workflow 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:workflow-scheme:jira - read:application-role:jira - read:avatar:jira - read:group:jira - read:issue-type:jira - read:project-category:jira - read:project:jira - read:user:jira - read:workflow-scheme:jira - read:workflow:jira state: Beta x-atlassian-connect-scope: ADMIN get: deprecated: false description: 'Returns the issue type-workflow mapping for an issue type in a workflow scheme. **Permissions required:** *Administer Jira* global permission.' operationId: getWorkflowSchemeIssueType parameters: - description: The ID of the workflow scheme. in: path name: id required: true schema: format: int64 type: integer - description: The ID of the issue type. in: path name: issueType required: true schema: type: string - description: Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned. in: query name: returnDraftIfExists schema: default: false type: boolean responses: '200': content: application/json: example: '{"issueType":"10000","workflow":"jira"}' schema: $ref: '#/components/schemas/IssueTypeWorkflowMapping' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the workflow scheme or issue type is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get workflow for issue type in workflow scheme tags: - Workflow 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:workflow-scheme:jira - read:workflow:jira - read:issue-type:jira state: Beta x-atlassian-connect-scope: ADMIN put: deprecated: false description: 'Sets the workflow for an issue type in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira. **Permissions required:** *Administer Jira* global permission.' operationId: setWorkflowSchemeIssueType parameters: - description: The ID of the workflow scheme. in: path name: id required: true schema: format: int64 type: integer - description: The ID of the issue type. in: path name: issueType required: true schema: type: string requestBody: content: application/json: example: issueType: '10000' updateDraftIfNeeded: false workflow: jira schema: $ref: '#/components/schemas/IssueTypeWorkflowMapping' description: The issue type-project mapping. required: true responses: '200': content: application/json: example: '{"defaultWorkflow":"jira","description":"The description of the example workflow scheme.","draft":false,"id":101010,"issueTypeMappings":{"10000":"scrum workflow","10001":"builds workflow"},"name":"Example workflow scheme","self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"}' schema: $ref: '#/components/schemas/WorkflowScheme' description: Returned if the request is successful. '400': description: Returned if the workflow cannot be edited and `updateDraftIfNeeded` is false. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if the workflow scheme or issue type is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Set workflow for issue type in workflow scheme tags: - Workflow 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:workflow-scheme:jira - read:workflow-scheme:jira - read:workflow:jira - read:application-role:jira - read:avatar:jira - read:group:jira - read:issue-type:jira - read:project-category:jira - read:project:jira - read:user:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/workflowscheme/{id}/workflow: delete: deprecated: false description: 'Deletes the workflow-issue type mapping for a workflow in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira. **Permissions required:** *Administer Jira* global permission.' operationId: deleteWorkflowMapping parameters: - description: The ID of the workflow scheme. in: path name: id required: true schema: format: int64 type: integer - description: The name of the workflow. in: query name: workflowName required: true schema: type: string - description: Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to `false`. in: query name: updateDraftIfNeeded schema: default: false type: boolean responses: '200': description: Returned if the request is successful. '400': description: Returned if the workflow cannot be edited and `updateDraftIfNeeded` is not true. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow is not found.\n * The workflow is not specified." security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Delete issue types for workflow in workflow scheme tags: - Workflow 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:workflow-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN get: deprecated: false description: 'Returns the workflow-issue type mappings for a workflow scheme. **Permissions required:** *Administer Jira* global permission.' operationId: getWorkflow parameters: - description: The ID of the workflow scheme. in: path name: id required: true schema: format: int64 type: integer - description: The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow. in: query name: workflowName schema: type: string - description: Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned. in: query name: returnDraftIfExists schema: default: false type: boolean responses: '200': content: application/json: example: '{"defaultMapping":false,"issueTypes":["10000","10001"],"workflow":"jira"}' schema: $ref: '#/components/schemas/IssueTypesWorkflowMapping' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: Returned if either the workflow scheme or workflow is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get issue types for workflows in workflow scheme tags: - Workflow 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:workflow-scheme:jira - read:workflow:jira - read:issue-type:jira state: Beta x-atlassian-connect-scope: ADMIN put: deprecated: false description: 'Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira. **Permissions required:** *Administer Jira* global permission.' operationId: updateWorkflowMapping parameters: - description: The ID of the workflow scheme. in: path name: id required: true schema: format: int64 type: integer - description: The name of the workflow. in: query name: workflowName required: true schema: type: string requestBody: content: application/json: example: issueTypes: - '10000' updateDraftIfNeeded: true workflow: jira schema: $ref: '#/components/schemas/IssueTypesWorkflowMapping' required: true responses: '200': content: application/json: example: '{"defaultWorkflow":"jira","description":"The description of the example workflow scheme.","draft":false,"id":101010,"issueTypeMappings":{"10000":"scrum workflow","10001":"builds workflow"},"name":"Example workflow scheme","self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"}' schema: $ref: '#/components/schemas/WorkflowScheme' description: Returned if the request is successful. '400': description: Returned if the request is invalid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': description: Returned if the user does not have the necessary permission. '404': description: "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow is not found.\n * The workflow is not specified." security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Set issue types for workflow in workflow scheme tags: - Workflow 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:workflow-scheme:jira - read:workflow-scheme:jira - read:workflow:jira - read:application-role:jira - read:avatar:jira - read:group:jira - read:issue-type:jira - read:project-category:jira - read:project:jira - read:user:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/workflowscheme/{workflowSchemeId}/projectUsages: get: deprecated: false description: Returns a page of projects using a given workflow scheme. operationId: getProjectUsagesForWorkflowScheme parameters: - description: The workflow scheme ID in: path name: workflowSchemeId required: true schema: type: string - description: The cursor for pagination in: query name: nextPageToken schema: type: string - description: The maximum number of results to return. Must be an integer between 1 and 200. in: query name: maxResults schema: default: 50 format: int32 type: integer responses: '200': content: application/json: example: '{"projects":{"nextPageToken":"eyJvIjoyfQ==","values":[{"id":"1003"}]},"workflowSchemeId":"10005"}' schema: $ref: '#/components/schemas/WorkflowSchemeProjectUsageDTO' description: Returned if the request is successful. '400': content: application/json: example: '{"errorMessages":["Invalid format of nextPageToken"],"errors":{}}' description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. '404': description: Returned if the workflow scheme with the given ID does not exist. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get projects which are using a given workflow scheme tags: - Workflow 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:project:jira - read:workflow-scheme:jira state: Beta x-atlassian-connect-scope: ADMIN components: schemas: 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 WorkflowScope: additionalProperties: false description: The scope of the workflow. properties: project: $ref: '#/components/schemas/ProjectId' type: description: The scope of the workflow. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects. enum: - PROJECT - GLOBAL type: string type: object IssueTypesWorkflowMapping: additionalProperties: false description: Details about the mapping between issue types and a workflow. properties: defaultMapping: description: Whether the workflow is the default workflow for the workflow scheme. type: boolean issueTypes: description: The list of issue type IDs. items: type: string type: array updateDraftIfNeeded: description: Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to `false`. type: boolean workflow: description: The name of the workflow. Optional if updating the workflow-issue types mapping. type: string type: object WorkflowSchemeUpdateRequiredMappingsResponse: additionalProperties: false properties: statusMappingsByIssueTypes: description: The list of required status mappings by issue type. items: $ref: '#/components/schemas/RequiredMappingByIssueType' type: array uniqueItems: true statusMappingsByWorkflows: description: The list of required status mappings by workflow. items: $ref: '#/components/schemas/RequiredMappingByWorkflows' type: array uniqueItems: true statuses: description: The details of the statuses in the associated workflows. items: $ref: '#/components/schemas/StatusMetadata' type: array uniqueItems: true statusesPerWorkflow: description: The statuses associated with each workflow. items: $ref: '#/components/schemas/StatusesPerWorkflow' type: array uniqueItems: true type: object ProjectId: additionalProperties: false description: Project ID details. properties: id: description: The ID of the project. type: string required: - id type: - object - 'null' WorkflowSchemeProjectUsageDTO: additionalProperties: false description: Projects using the workflow scheme. properties: projects: $ref: '#/components/schemas/ProjectUsagePage' workflowSchemeId: description: The workflow scheme ID. type: string type: object PageBeanWorkflowScheme: 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/WorkflowScheme' readOnly: true type: array 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 WorkflowMetadataAndIssueTypeRestModel: additionalProperties: false description: The workflow metadata and issue type IDs which use this workflow. properties: issueTypeIds: description: The list of issue type IDs for the mapping. items: description: The list of issue type IDs for the mapping. type: string type: array workflow: $ref: '#/components/schemas/WorkflowMetadataRestModel' required: - issueTypeIds - workflow type: object MappingsByWorkflow: additionalProperties: false description: The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`. properties: newWorkflowId: description: The ID of the new workflow. type: string oldWorkflowId: description: The ID of the old workflow. type: string statusMappings: description: The list of status mappings. items: $ref: '#/components/schemas/WorkflowAssociationStatusMapping' type: array required: - newWorkflowId - oldWorkflowId - statusMappings type: object StatusMetadata: additionalProperties: false description: The details of the statuses in the associated workflows. properties: category: description: The category of the status. enum: - TODO - IN_PROGRESS - DONE type: string id: description: The ID of the status. type: string name: description: The name of the status. type: string type: object 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 ProjectUsagePage: additionalProperties: false description: A page of projects. properties: nextPageToken: description: Page token for the next page of project usages. type: string values: description: The list of projects. items: $ref: '#/components/schemas/ProjectUsage' type: array type: object 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 DocumentVersion: additionalProperties: false description: The current version details of this workflow scheme. properties: id: description: The version UUID. type: string versionNumber: description: The version number. format: int64 type: integer type: object RequiredMappingByWorkflows: additionalProperties: false description: The list of required status mappings by workflow. properties: sourceWorkflowId: description: The ID of the source workflow. type: string statusIds: description: The status IDs requiring mapping. items: description: The status IDs requiring mapping. type: string type: array uniqueItems: true targetWorkflowId: description: The ID of the target workflow. type: string type: object WorkflowSchemeReadResponse: additionalProperties: false properties: defaultWorkflow: $ref: '#/components/schemas/WorkflowMetadataRestModel' description: description: The description of the workflow scheme. type: - string - 'null' id: description: The ID of the workflow scheme. type: string name: description: The name of the workflow scheme. type: string scope: $ref: '#/components/schemas/WorkflowScope' taskId: description: Indicates if there's an [asynchronous task](#async-operations) for this workflow scheme. type: - string - 'null' version: $ref: '#/components/schemas/DocumentVersion' workflowsForIssueTypes: description: Mappings from workflows to issue types. items: $ref: '#/components/schemas/WorkflowMetadataAndIssueTypeRestModel' type: array required: - id - name - scope - version - workflowsForIssueTypes 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 IssueTypeWorkflowMapping: additionalProperties: false description: Details about the mapping between an issue type and a workflow. properties: issueType: description: The ID of the issue type. Not required if updating the issue type-workflow mapping. type: string updateDraftIfNeeded: description: Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to `false`. Only applicable when updating the workflow-issue types mapping. type: boolean workflow: description: The name of the workflow. type: string 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 WorkflowMetadataRestModel: additionalProperties: false description: Workflow metadata and usage detail. properties: description: description: The description of the workflow. type: string id: description: The ID of the workflow. type: string name: description: The name of the workflow. type: string version: $ref: '#/components/schemas/DocumentVersion' required: - description - id - name - version type: object TaskProgressBeanObject: 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: 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 MappingsByIssueTypeOverride: additionalProperties: false description: The mappings for migrating issues from old statuses to new statuses when switching from one workflow scheme to another. This field is required if any statuses in the current project's workflows would no longer exist in the target workflow scheme. Each mapping defines how to update issues from an old status to the corresponding new status in the issue’s new workflow. properties: issueTypeId: type: string statusMappings: items: $ref: '#/components/schemas/WorkflowAssociationStatusMapping' type: array 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 DefaultWorkflow: additionalProperties: false description: Details about the default workflow. properties: updateDraftIfNeeded: description: Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to `false`. type: boolean workflow: description: The name of the workflow to set as the default workflow. type: string required: - workflow type: object WorkflowSchemeProjectSwitchBean: additionalProperties: true description: Request to switch a project's workflow scheme properties: mappingsByIssueTypeOverride: description: The mappings for migrating issues from old statuses to new statuses when switching from one workflow scheme to another. This field is required if any statuses in the current project's workflows would no longer exist in the target workflow scheme. Each mapping defines how to update issues from an old status to the corresponding new status in the issue’s new workflow. items: $ref: '#/components/schemas/MappingsByIssueTypeOverride' type: array projectId: description: The ID of the project to switch the workflow scheme for example: '10001' type: string targetSchemeId: description: The ID of the target workflow scheme to switch to example: '10002' type: string 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 WorkflowSchemeReadRequest: additionalProperties: false description: The workflow scheme read request body. properties: projectIds: description: The list of project IDs to query. items: description: The list of project IDs to query. type: - string - 'null' type: - array - 'null' workflowSchemeIds: description: The list of workflow scheme IDs to query. items: description: The list of workflow scheme IDs to query. type: - string - 'null' type: - array - 'null' type: object WorkflowScheme: additionalProperties: false description: Details about a workflow scheme. properties: defaultWorkflow: description: The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*. type: string description: description: The description of the workflow scheme. type: string draft: description: Whether the workflow scheme is a draft or not. readOnly: true type: boolean id: description: The ID of the workflow scheme. format: int64 readOnly: true type: integer issueTypeMappings: additionalProperties: type: string description: The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme. type: object issueTypes: additionalProperties: $ref: '#/components/schemas/IssueTypeDetails' description: The issue types available in Jira. readOnly: true type: object lastModified: description: The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows. readOnly: true type: string lastModifiedUser: allOf: - $ref: '#/components/schemas/User' description: The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows. readOnly: true name: description: The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme. type: string originalDefaultWorkflow: description: For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. readOnly: true type: string originalIssueTypeMappings: additionalProperties: readOnly: true type: string description: For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme. readOnly: true type: object self: format: uri readOnly: true type: string updateDraftIfNeeded: description: "Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:\n\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated.\n * Update an inactive workflow scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.\n\nDefaults to `false`." type: boolean type: object WorkflowAssociationStatusMapping: additionalProperties: false properties: newStatusId: type: string oldStatusId: type: string type: object WorkflowSchemeUpdateRequest: additionalProperties: true description: The update workflow scheme payload. properties: defaultWorkflowId: description: The ID of the workflow for issue types without having a mapping defined in this workflow scheme. Only used in global-scoped workflow schemes. If the `defaultWorkflowId` isn't specified, this is set to *Jira Workflow (jira)*. type: string description: description: The new description for this workflow scheme. type: string id: description: The ID of this workflow scheme. type: string name: description: The new name for this workflow scheme. type: string statusMappingsByIssueTypeOverride: description: Overrides, for the selected issue types, any status mappings provided in `statusMappingsByWorkflows`. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`. items: $ref: '#/components/schemas/MappingsByIssueTypeOverride' type: array statusMappingsByWorkflows: description: The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`. items: $ref: '#/components/schemas/MappingsByWorkflow' type: array version: $ref: '#/components/schemas/DocumentVersion' workflowsForIssueTypes: description: Mappings from workflows to issue types. items: $ref: '#/components/schemas/WorkflowSchemeAssociation' type: array required: - description - id - name - version type: object ProjectUsage: additionalProperties: false description: The project. properties: id: description: The project ID. type: string 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 RequiredMappingByIssueType: additionalProperties: false description: The list of required status mappings by issue type. properties: issueTypeId: description: The ID of the issue type. type: string statusIds: description: The status IDs requiring mapping. items: description: The status IDs requiring mapping. type: string type: array uniqueItems: true type: object StatusesPerWorkflow: additionalProperties: false description: The statuses associated with each workflow. properties: initialStatusId: description: The ID of the initial status for the workflow. type: string statuses: description: The status IDs associated with the workflow. items: description: The status IDs associated with the workflow. type: string type: array uniqueItems: true workflowId: description: The ID of the workflow. type: string type: object WorkflowSchemeAssociation: additionalProperties: false description: The explicit association between issue types and a workflow in a workflow scheme. properties: issueTypeIds: description: The issue types assigned to the workflow. items: description: The issue types assigned to the workflow. type: string type: array uniqueItems: true workflowId: description: The ID of the workflow. type: string required: - issueTypeIds - workflowId type: object WorkflowSchemeUpdateRequiredMappingsRequest: additionalProperties: false description: The request payload to get the required mappings for updating a workflow scheme. properties: defaultWorkflowId: description: The ID of the new default workflow for this workflow scheme. Only used in global-scoped workflow schemes. If it isn't specified, is set to *Jira Workflow (jira)*. type: - string - 'null' id: description: The ID of the workflow scheme. type: string workflowsForIssueTypes: description: The new workflow to issue type mappings for this workflow scheme. items: $ref: '#/components/schemas/WorkflowSchemeAssociation' type: array required: - id - workflowsForIssueTypes type: object 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