openapi: 3.1.0 info: title: Atlassian Admin Account Workflow Scheme Drafts API description: The Atlassian Admin API provides programmatic access to manage Atlassian organizations, users, domains, policies, and events. It enables administrators to automate organization management tasks, integrate with identity providers, and ensure appropriate access to Atlassian products. version: 1.0.0 contact: name: Atlassian Developer url: https://developer.atlassian.com/cloud/admin/ license: name: Atlassian Developer Terms url: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/ x-logo: url: https://wac-cdn.atlassian.com/assets/img/favicons/atlassian/favicon.png servers: - url: https://api.atlassian.com description: Atlassian Cloud API security: - bearerAuth: [] - oauth2: [] tags: - name: Workflow Scheme Drafts paths: /rest/api/3/workflowscheme/{id}/createdraft: post: deprecated: false description: Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianCreateworkflowschemedraftfromparent parameters: - description: The ID of the active workflow scheme that the draft is created from. in: path name: id required: true schema: format: int64 type: integer responses: '201': content: application/json: example: '{"defaultWorkflow":"scrum workflow","description":"The description of the example workflow scheme.","draft":true,"id":17218781,"issueTypeMappings":{"10000":"jira","10001":"jira"},"lastModified":"Today 6:38 PM","lastModifiedUser":{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":true,"applicationRoles":{"items":[],"size":1},"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia Krystof","emailAddress":"mia@example.com","groups":{"items":[],"size":3},"key":"","name":"","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","timeZone":"Australia/Sydney"},"name":"Example workflow scheme","originalDefaultWorkflow":"jira","originalIssueTypeMappings":{"10001":"builds workflow"},"self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"}' 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: Atlassian Create Draft Workflow Scheme tags: - Workflow Scheme Drafts 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:group:jira - read:issue-security-level:jira - read:project-role:jira - read:screen:jira - read:status:jira - read:user:jira - read:workflow-scheme:jira - read:workflow:jira - write:workflow-scheme:jira - read:application-role:jira - read:avatar:jira - read:issue-type:jira - read:project-category:jira - read:project:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/workflowscheme/{id}/draft: delete: deprecated: false description: Deletes a draft workflow scheme.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianDeleteworkflowschemedraft parameters: - description: The ID of the active workflow scheme that the draft was created from. in: path name: id required: true schema: format: int64 type: integer responses: '204': 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:\n\n * the original active workflow scheme is not found.\n * the original active workflow scheme does not have a draft." security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Atlassian Delete Draft Workflow Scheme tags: - Workflow Scheme Drafts 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 draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg) for more information.
Note that:

* Only active workflow schemes can have draft workflow schemes.
* An active workflow scheme can only have one draft workflow scheme.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).' operationId: atlassianGetworkflowschemedraft parameters: - description: The ID of the active workflow scheme that the draft was created from. in: path name: id required: true schema: format: int64 type: integer responses: '200': content: application/json: example: '{"defaultWorkflow":"scrum workflow","description":"The description of the example workflow scheme.","draft":true,"id":17218781,"issueTypeMappings":{"10000":"jira","10001":"jira"},"lastModified":"Today 6:38 PM","lastModifiedUser":{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":true,"applicationRoles":{"items":[],"size":1},"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia Krystof","emailAddress":"mia@example.com","groups":{"items":[],"size":3},"key":"","name":"","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","timeZone":"Australia/Sydney"},"name":"Example workflow scheme","originalDefaultWorkflow":"jira","originalIssueTypeMappings":{"10001":"builds workflow"},"self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"}' 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:\n\n * the original active workflow scheme is not found.\n * the original active workflow scheme does not have a draft." security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Atlassian Get Draft Workflow Scheme tags: - Workflow Scheme Drafts 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:group:jira - read:issue-security-level:jira - read:project-role:jira - read:screen:jira - read:status:jira - read:user:jira - read:workflow-scheme:jira - read:workflow:jira - read:application-role:jira - read:avatar:jira - read:issue-type:jira - read:project-category:jira - read:project:jira state: Beta x-atlassian-connect-scope: ADMIN put: deprecated: false description: Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianUpdateworkflowschemedraft parameters: - description: The ID of the active workflow scheme that the draft was created from. 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":"scrum workflow","description":"The description of the example workflow scheme.","draft":true,"id":17218781,"issueTypeMappings":{"10000":"jira","10001":"jira"},"lastModified":"Today 6:38 PM","lastModifiedUser":{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":true,"applicationRoles":{"items":[],"size":1},"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia Krystof","emailAddress":"mia@example.com","groups":{"items":[],"size":3},"key":"","name":"","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","timeZone":"Australia/Sydney"},"name":"Example workflow scheme","originalDefaultWorkflow":"jira","originalIssueTypeMappings":{"10001":"builds workflow"},"self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"}' 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:\n\n * the original active workflow scheme is not found.\n * the original active workflow scheme does not have a draft." security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Atlassian Update Draft Workflow Scheme tags: - Workflow Scheme Drafts 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:group:jira - read:issue-security-level:jira - read:project-role:jira - read:screen:jira - read:status:jira - read:user:jira - read:workflow-scheme:jira - read:workflow:jira - write:workflow-scheme:jira - read:application-role:jira - read:avatar:jira - read:issue-type:jira - read:project-category:jira - read:project:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/workflowscheme/{id}/draft/default: delete: deprecated: false description: Resets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow (the *jira* workflow).

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianDeletedraftdefaultworkflow parameters: - description: The ID of the workflow scheme that the draft belongs to. in: path name: id required: true schema: format: int64 type: integer responses: '200': content: application/json: example: '{"defaultWorkflow":"scrum workflow","description":"The description of the example workflow scheme.","draft":true,"id":17218781,"issueTypeMappings":{"10000":"jira","10001":"jira"},"lastModified":"Today 6:38 PM","lastModifiedUser":{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":true,"applicationRoles":{"items":[],"size":1},"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia Krystof","emailAddress":"mia@example.com","groups":{"items":[],"size":3},"key":"","name":"","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","timeZone":"Australia/Sydney"},"name":"Example workflow scheme","originalDefaultWorkflow":"jira","originalIssueTypeMappings":{"10001":"builds workflow"},"self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"}' 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 any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft." security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Atlassian Delete Draft Default Workflow tags: - Workflow Scheme Drafts 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 default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has *All Unassigned Issue Types* listed in its issue types for the workflow scheme in Jira.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianGetdraftdefaultworkflow parameters: - description: The ID of the workflow scheme that the draft belongs to. in: path name: id required: true schema: format: int64 type: integer 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 any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft." security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Atlassian Get Draft Default Workflow tags: - Workflow Scheme Drafts 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's draft.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianUpdatedraftdefaultworkflow parameters: - description: The ID of the workflow scheme that the draft belongs to. 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 object for the new default workflow. required: true responses: '200': content: application/json: example: '{"defaultWorkflow":"scrum workflow","description":"The description of the example workflow scheme.","draft":true,"id":17218781,"issueTypeMappings":{"10000":"jira","10001":"jira"},"lastModified":"Today 6:38 PM","lastModifiedUser":{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":true,"applicationRoles":{"items":[],"size":1},"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia Krystof","emailAddress":"mia@example.com","groups":{"items":[],"size":3},"key":"","name":"","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","timeZone":"Australia/Sydney"},"name":"Example workflow scheme","originalDefaultWorkflow":"jira","originalIssueTypeMappings":{"10001":"builds workflow"},"self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"}' 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 scheme does not have a draft." security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Atlassian Update Draft Default Workflow tags: - Workflow Scheme Drafts 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}/draft/issuetype/{issueType}: delete: deprecated: false description: Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianDeleteworkflowschemedraftissuetype parameters: - description: The ID of the workflow scheme that the draft belongs to. 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 responses: '200': content: application/json: example: '{"defaultWorkflow":"scrum workflow","description":"The description of the example workflow scheme.","draft":true,"id":17218781,"issueTypeMappings":{"10000":"jira","10001":"jira"},"lastModified":"Today 6:38 PM","lastModifiedUser":{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":true,"applicationRoles":{"items":[],"size":1},"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia Krystof","emailAddress":"mia@example.com","groups":{"items":[],"size":3},"key":"","name":"","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","timeZone":"Australia/Sydney"},"name":"Example workflow scheme","originalDefaultWorkflow":"jira","originalIssueTypeMappings":{"10001":"builds workflow"},"self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"}' 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 or issue type is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Atlassian Delete Workflow For Issue Type In Draft Workflow Scheme tags: - Workflow Scheme Drafts 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's draft.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianGetworkflowschemedraftissuetype parameters: - description: The ID of the workflow scheme that the draft belongs to. 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 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: Atlassian Get Workflow For Issue Type In Draft Workflow Scheme tags: - Workflow Scheme Drafts 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's draft.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianSetworkflowschemedraftissuetype parameters: - description: The ID of the workflow scheme that the draft belongs to. 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":"scrum workflow","description":"The description of the example workflow scheme.","draft":true,"id":17218781,"issueTypeMappings":{"10000":"jira","10001":"jira"},"lastModified":"Today 6:38 PM","lastModifiedUser":{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":true,"applicationRoles":{"items":[],"size":1},"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia Krystof","emailAddress":"mia@example.com","groups":{"items":[],"size":3},"key":"","name":"","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","timeZone":"Australia/Sydney"},"name":"Example workflow scheme","originalDefaultWorkflow":"jira","originalIssueTypeMappings":{"10001":"builds workflow"},"self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"}' 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 or issue type is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Atlassian Set Workflow For Issue Type In Draft Workflow Scheme tags: - Workflow Scheme Drafts 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}/draft/publish: post: deprecated: false description: Publishes a draft workflow scheme.

Where the draft workflow includes new workflow statuses for an issue type, mappings are provided to update issues with the original workflow status to the new workflow status.

This operation is [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain updates.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianPublishdraftworkflowscheme parameters: - description: The ID of the workflow scheme that the draft belongs to. in: path name: id required: true schema: format: int64 type: integer - description: Whether the request only performs a validation. in: query name: validateOnly schema: default: false type: boolean requestBody: content: application/json: example: statusMappings: - issueTypeId: '10001' newStatusId: '1' statusId: '3' - issueTypeId: '10001' newStatusId: '2' statusId: '2' - issueTypeId: '10002' newStatusId: '10003' statusId: '10005' - issueTypeId: '10003' newStatusId: '1' statusId: '4' schema: $ref: '#/components/schemas/PublishDraftWorkflowScheme' description: Details of the status mappings. required: true responses: '204': description: Returned if the request is only for validation and is successful. '303': content: application/json: schema: $ref: '#/components/schemas/TaskProgressBeanObject' description: Returned if the request is successful. '400': content: application/json: example: '{"errorMessages":["Issue type with ID ''2'',''4'' is missing the mappings required for statuses with IDs 10004."],"errors":{}}' 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': content: application/json: example: '{"errorMessages":["Draft workflow scheme was not found."],"errors":{}}' description: "Returned if any of these are true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft.\n * A new status in the draft workflow scheme is not found." security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Atlassian Publish Draft Workflow Scheme tags: - Workflow Scheme Drafts 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}/draft/workflow: delete: deprecated: false description: Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianDeletedraftworkflowmapping parameters: - description: The ID of the workflow scheme that the draft belongs to. 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 responses: '200': 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 any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft.\n * The workflow is not found.\n * The workflow is not specified." security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Atlassian Delete Issue Types For Workflow In Draft Workflow Scheme tags: - Workflow Scheme Drafts 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's draft.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianGetdraftworkflow parameters: - description: The ID of the workflow scheme that the draft belongs to. 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 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 (if specified) is not found. session. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Atlassian Get Issue Types For Workflows In Draft Workflow Scheme tags: - Workflow Scheme Drafts 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's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: atlassianUpdatedraftworkflowmapping parameters: - description: The ID of the workflow scheme that the draft belongs to. 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 scheme does not have a draft.\n * The workflow is not found.\n * The workflow is not specified." security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Atlassian Set Issue Types For Workflow In Workflow Scheme tags: - Workflow Scheme Drafts 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 components: schemas: 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 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*. nullable: true type: string name: description: The name of group. type: string self: description: The URL for these group details. format: uri readOnly: true type: string type: object ListWrapperCallbackApplicationRole: additionalProperties: false 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 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 PublishDraftWorkflowScheme: additionalProperties: false description: Details about the status mappings for publishing a draft workflow scheme. properties: statusMappings: description: Mappings of statuses to new statuses for issue types. items: $ref: '#/components/schemas/StatusMapping' type: array uniqueItems: true 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 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 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 ListWrapperCallbackGroupName: additionalProperties: false type: object StatusMapping: additionalProperties: false description: Details about the mapping from a status to a new status for an issue type. properties: issueTypeId: description: The ID of the issue type. type: string newStatusId: description: The ID of the new status. type: string statusId: description: The ID of the status. type: string required: - issueTypeId - newStatusId - statusId 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 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 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 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 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. Depending on the user’s privacy setting, this may be returned as null. readOnly: true type: string type: object xml: name: user 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 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 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 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 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 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 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: Use an Atlassian API key as a Bearer token. Create API keys at https://admin.atlassian.com. oauth2: type: oauth2 description: OAuth 2.0 authorization for Atlassian Cloud APIs. flows: authorizationCode: authorizationUrl: https://auth.atlassian.com/authorize tokenUrl: https://auth.atlassian.com/oauth/token scopes: read:org:admin: Read organization information. write:org:admin: Modify organization settings. read:user:admin: Read user information. write:user:admin: Modify user accounts. read:policy:admin: Read organization policies. write:policy:admin: Modify organization policies. read:event:admin: Read organization events. externalDocs: description: Atlassian Admin REST API Documentation url: https://developer.atlassian.com/cloud/admin/organization/rest/intro/