Atlassian: Workflow schemes schemas
30 Atlassian schemas with complete fields and constraints.
← Workflow schemes operations · All schemas
Bulk get workflow schemes — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The workflow scheme read request body. Additional keys: not allowed |
projectIds | JSON | Optional | |
projectIds (anyOf 1) | array | Alternative | The list of project IDs to query. |
projectIds (anyOf 1)[] | JSON | Each item | |
projectIds (anyOf 1)[] (anyOf 1) | string | Alternative | The list of project IDs to query. |
projectIds (anyOf 1)[] (anyOf 2) | null | Alternative | |
projectIds (anyOf 2) | null | Alternative | |
workflowSchemeIds | JSON | Optional | |
workflowSchemeIds (anyOf 1) | array | Alternative | The list of workflow scheme IDs to query. |
workflowSchemeIds (anyOf 1)[] | JSON | Each item | |
workflowSchemeIds (anyOf 1)[] (anyOf 1) | string | Alternative | The list of workflow scheme IDs to query. |
workflowSchemeIds (anyOf 1)[] (anyOf 2) | null | Alternative | |
workflowSchemeIds (anyOf 2) | null | Alternative |
Bulk get workflow schemes — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
defaultWorkflow | JSON | Optional | |
defaultWorkflow (anyOf 1) | Model | Alternative | Expand Bulk get workflow schemes — response body — item default Workflow Workflow metadata and usage detail |
defaultWorkflow (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | JSON | Alternative | |
description (anyOf 1) (anyOf 1) | string | Alternative | The description of the workflow scheme. |
description (anyOf 1) (anyOf 2) | null | Alternative | |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the workflow scheme. |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the workflow scheme. |
name (anyOf 2) | null | Alternative | |
scope | JSON | Optional | |
scope (anyOf 1) | Model | Alternative | Expand Bulk get workflow schemes — response body — item scope The scope of the workflow |
scope (anyOf 2) | null | Alternative | |
taskId | JSON | Optional | |
taskId (anyOf 1) | JSON | Alternative | |
taskId (anyOf 1) (anyOf 1) | string | Alternative | Indicates if there's an [asynchronous task](#async-operations) for this workflow scheme. |
taskId (anyOf 1) (anyOf 2) | null | Alternative | |
taskId (anyOf 2) | null | Alternative | |
version | JSON | Optional | |
version (anyOf 1) | Model | Alternative | Expand Bulk get workflow schemes — response body — item version id, version Number |
version (anyOf 2) | null | Alternative | |
workflowsForIssueTypes | JSON | Optional | |
workflowsForIssueTypes (anyOf 1) | array | Alternative | Mappings from workflows to issue types. |
workflowsForIssueTypes (anyOf 1)[] | Model | Each item | Expand Bulk get workflow schemes — response body — item workflows For Issue Types Mappings from workflows to issue types item |
workflowsForIssueTypes (anyOf 2) | null | Alternative |
Referenced models: Bulk get workflow schemes — response body — item version id, version Number, Bulk get workflow schemes — response body — item workflows For Issue Types Mappings from workflows to issue types item, Bulk get workflow schemes — response body — item default Workflow Workflow metadata and usage detail, Bulk get workflow schemes — response body — item scope The scope of the workflow
Bulk get workflow schemes — response body — item default Workflow Workflow metadata and usage detail
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Workflow metadata and usage detail. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the workflow. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the workflow. |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the workflow. |
name (anyOf 2) | null | Alternative | |
version | JSON | Optional | |
version (anyOf 1) | Model | Alternative | Expand Bulk get workflow schemes — response body — item version id, version Number |
version (anyOf 2) | null | Alternative |
Referenced models: Bulk get workflow schemes — response body — item version id, version Number
Bulk get workflow schemes — response body — item scope The scope of the workflow
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The scope of the workflow. |
project | JSON | Optional | |
project (anyOf 1) | Model | Alternative | Expand Bulk get statuses — response body — item scope The scope of the status project value |
project (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The scope of the workflow. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects. Known values: PROJECT, GLOBAL |
type (anyOf 2) | null | Alternative |
Referenced models: Bulk get statuses — response body — item scope The scope of the status project value
Bulk get workflow schemes — response body — item version id, version Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The current version details of this workflow scheme. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The version UUID. |
id (anyOf 2) | null | Alternative | |
versionNumber | JSON | Optional | |
versionNumber (anyOf 1) | JSON | Alternative | |
versionNumber (anyOf 1) (anyOf 1) | integer | Alternative | The version number. Format: int64 |
versionNumber (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
versionNumber (anyOf 2) | null | Alternative |
Bulk get workflow schemes — response body — item workflows For Issue Types Mappings from workflows to issue types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The workflow metadata and issue type IDs which use this workflow. |
issueTypeIds | JSON | Optional | |
issueTypeIds (anyOf 1) | array | Alternative | The list of issue type IDs for the mapping. |
issueTypeIds (anyOf 1)[] | string | Each item | The list of issue type IDs for the mapping. |
issueTypeIds (anyOf 2) | null | Alternative | |
workflow | JSON | Optional | |
workflow (anyOf 1) | Model | Alternative | Expand Bulk get workflow schemes — response body — item default Workflow Workflow metadata and usage detail |
workflow (anyOf 2) | null | Alternative |
Referenced models: Bulk get workflow schemes — response body — item default Workflow Workflow metadata and usage detail
Create workflow scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a workflow scheme. Additional keys: not allowed |
defaultWorkflow | string | Optional | 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)*. |
description | string | Optional | The description of the workflow scheme. |
draft | boolean | Optional | Whether the workflow scheme is a draft or not. Read only: true |
id | integer | Optional | The ID of the workflow scheme. Format: int64 Read only: true |
issueTypeMappings | object | Optional | 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. Additional keys: see wildcard field |
issueTypeMappings.* | string | Additional keys | |
issueTypes | object | Optional | The issue types available in Jira. Read only: true Additional keys: see wildcard field |
issueTypes.* | Model | Additional keys | Expand Create workflow scheme — request body — body issue Types value |
lastModified | string | Optional | 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. Read only: true |
lastModifiedUser | Model | Optional | Expand Assign issue — request body — body 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. Read only: true |
name | string | Optional | The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme. |
originalDefaultWorkflow | string | Optional | 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. Read only: true |
originalIssueTypeMappings | object | Optional | 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. Read only: true Additional keys: see wildcard field |
originalIssueTypeMappings.* | string | Additional keys | Read only: true |
self | string | Optional | Format: uri Read only: true |
updateDraftIfNeeded | boolean | Optional | 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: * 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. * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated. * 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. Defaults to `false`. |
Referenced models: Create workflow scheme — request body — body issue Types value, Assign issue — request body — body
Create workflow scheme — request body — body issue Types value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about an issue type. Additional keys: not allowed |
avatarId | integer | Optional | The ID of the issue type's avatar. Format: int64 Read only: true |
description | string | Optional | The description of the issue type. Read only: true |
entityId | string | Optional | Unique ID for next-gen projects. Format: uuid Read only: true |
hierarchyLevel | integer | Optional | Hierarchy level of the issue type. Format: int32 Read only: true |
iconUrl | string | Optional | The URL of the issue type's avatar. Read only: true |
id | string | Optional | The ID of the issue type. Read only: true |
name | string | Optional | The name of the issue type. Read only: true |
scope | Model | Optional | Expand Create permission scheme — request body — body scope Details of the next-gen projects the issue type is available in. Read only: true |
self | string | Optional | The URL of these issue type details. Read only: true |
subtask | boolean | Optional | Whether this issue type is used to create subtasks. Read only: true |
Referenced models: Create permission scheme — request body — body scope
Get all workflow schemes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get workflow scheme — response body |
values (anyOf 2) | null | Alternative |
Referenced models: Get workflow scheme — response body
Get default workflow — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the default workflow. |
updateDraftIfNeeded | JSON | Optional | |
updateDraftIfNeeded (anyOf 1) | boolean | Alternative | 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`. |
updateDraftIfNeeded (anyOf 2) | null | Alternative | |
workflow | JSON | Optional | |
workflow (anyOf 1) | string | Alternative | The name of the workflow to set as the default workflow. |
workflow (anyOf 2) | null | Alternative |
Get issue types for workflows in workflow scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the mapping between issue types and a workflow. |
defaultMapping | JSON | Optional | |
defaultMapping (anyOf 1) | boolean | Alternative | Whether the workflow is the default workflow for the workflow scheme. |
defaultMapping (anyOf 2) | null | Alternative | |
issueTypes | JSON | Optional | |
issueTypes (anyOf 1) | array | Alternative | The list of issue type IDs. |
issueTypes (anyOf 1)[] | string | Each item | |
issueTypes (anyOf 2) | null | Alternative | |
updateDraftIfNeeded | JSON | Optional | |
updateDraftIfNeeded (anyOf 1) | boolean | Alternative | 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`. |
updateDraftIfNeeded (anyOf 2) | null | Alternative | |
workflow | JSON | Optional | |
workflow (anyOf 1) | string | Alternative | The name of the workflow. Optional if updating the workflow-issue types mapping. |
workflow (anyOf 2) | null | Alternative |
Get projects which are using a given workflow scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Projects using the workflow scheme. |
projects | JSON | Optional | |
projects (anyOf 1) | Model | Alternative | Expand Get projects using a given workflow — response body — projects A page of projects |
projects (anyOf 2) | null | Alternative | |
workflowSchemeId | JSON | Optional | |
workflowSchemeId (anyOf 1) | string | Alternative | The workflow scheme ID. |
workflowSchemeId (anyOf 2) | null | Alternative |
Referenced models: Get projects using a given workflow — response body — projects A page of projects
Get required status mappings for workflow scheme update — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request payload to get the required mappings for updating a workflow scheme. Additional keys: not allowed |
defaultWorkflowId | JSON | Optional | |
defaultWorkflowId (anyOf 1) | string | Alternative | 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)*. |
defaultWorkflowId (anyOf 2) | null | Alternative | |
id | string | Required within parent | The ID of the workflow scheme. |
workflowsForIssueTypes | array | Required within parent | The new workflow to issue type mappings for this workflow scheme. |
workflowsForIssueTypes[] | Model | Each item | Expand Update workflow scheme — request body — body workflows For Issue Types item |
Referenced models: Update workflow scheme — request body — body workflows For Issue Types item
Get required status mappings for workflow scheme update — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
statusMappingsByIssueTypes | JSON | Optional | |
statusMappingsByIssueTypes (anyOf 1) | array | Alternative | The list of required status mappings by issue type. Unique items: true |
statusMappingsByIssueTypes (anyOf 1)[] | Model | Each item | Expand Get required status mappings for workflow scheme update — response body — status Mappings By Issue Types The list of required status mappings by issue type item |
statusMappingsByIssueTypes (anyOf 2) | null | Alternative | |
statusMappingsByWorkflows | JSON | Optional | |
statusMappingsByWorkflows (anyOf 1) | array | Alternative | The list of required status mappings by workflow. Unique items: true |
statusMappingsByWorkflows (anyOf 1)[] | Model | Each item | Expand Get required status mappings for workflow scheme update — response body — status Mappings By Workflows The list of required status mappings by workflow item |
statusMappingsByWorkflows (anyOf 2) | null | Alternative | |
statuses | JSON | Optional | |
statuses (anyOf 1) | array | Alternative | The details of the statuses in the associated workflows. Unique items: true |
statuses (anyOf 1)[] | Model | Each item | Expand Get required status mappings for workflow scheme update — response body — statuses array item |
statuses (anyOf 2) | null | Alternative | |
statusesPerWorkflow | JSON | Optional | |
statusesPerWorkflow (anyOf 1) | array | Alternative | The statuses associated with each workflow. Unique items: true |
statusesPerWorkflow (anyOf 1)[] | Model | Each item | Expand Get required status mappings for workflow scheme update — response body — statuses Per Workflow The statuses associated with each workflow item |
statusesPerWorkflow (anyOf 2) | null | Alternative |
Referenced models: Get required status mappings for workflow scheme update — response body — status Mappings By Issue Types The list of required status mappings by issue type item, Get required status mappings for workflow scheme update — response body — status Mappings By Workflows The list of required status mappings by workflow item, Get required status mappings for workflow scheme update — response body — statuses array item, Get required status mappings for workflow scheme update — response body — statuses Per Workflow The statuses associated with each workflow item
Get required status mappings for workflow scheme update — response body — status Mappings By Issue Types The list of required status mappings by issue type item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The list of required status mappings by issue type. |
issueTypeId | JSON | Optional | |
issueTypeId (anyOf 1) | string | Alternative | The ID of the issue type. |
issueTypeId (anyOf 2) | null | Alternative | |
statusIds | JSON | Optional | |
statusIds (anyOf 1) | array | Alternative | The status IDs requiring mapping. Unique items: true |
statusIds (anyOf 1)[] | string | Each item | The status IDs requiring mapping. |
statusIds (anyOf 2) | null | Alternative |
Get required status mappings for workflow scheme update — response body — status Mappings By Workflows The list of required status mappings by workflow item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The list of required status mappings by workflow. |
sourceWorkflowId | JSON | Optional | |
sourceWorkflowId (anyOf 1) | string | Alternative | The ID of the source workflow. |
sourceWorkflowId (anyOf 2) | null | Alternative | |
statusIds | JSON | Optional | |
statusIds (anyOf 1) | array | Alternative | The status IDs requiring mapping. Unique items: true |
statusIds (anyOf 1)[] | string | Each item | The status IDs requiring mapping. |
statusIds (anyOf 2) | null | Alternative | |
targetWorkflowId | JSON | Optional | |
targetWorkflowId (anyOf 1) | string | Alternative | The ID of the target workflow. |
targetWorkflowId (anyOf 2) | null | Alternative |
Get required status mappings for workflow scheme update — response body — statuses Per Workflow The statuses associated with each workflow item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The statuses associated with each workflow. |
initialStatusId | JSON | Optional | |
initialStatusId (anyOf 1) | string | Alternative | The ID of the initial status for the workflow. |
initialStatusId (anyOf 2) | null | Alternative | |
statuses | JSON | Optional | |
statuses (anyOf 1) | array | Alternative | The status IDs associated with the workflow. Unique items: true |
statuses (anyOf 1)[] | string | Each item | The status IDs associated with the workflow. |
statuses (anyOf 2) | null | Alternative | |
workflowId | JSON | Optional | |
workflowId (anyOf 1) | string | Alternative | The ID of the workflow. |
workflowId (anyOf 2) | null | Alternative |
Get required status mappings for workflow scheme update — response body — statuses array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The details of the statuses in the associated workflows. |
category | JSON | Optional | |
category (anyOf 1) | string | Alternative | The category of the status. Known values: TODO, IN_PROGRESS, DONE |
category (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the status. |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the status. |
name (anyOf 2) | null | Alternative |
Get workflow for issue type in workflow scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the mapping between an issue type and a workflow. |
issueType | JSON | Optional | |
issueType (anyOf 1) | string | Alternative | The ID of the issue type. Not required if updating the issue type-workflow mapping. |
issueType (anyOf 2) | null | Alternative | |
updateDraftIfNeeded | JSON | Optional | |
updateDraftIfNeeded (anyOf 1) | boolean | Alternative | 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. |
updateDraftIfNeeded (anyOf 2) | null | Alternative | |
workflow | JSON | Optional | |
workflow (anyOf 1) | string | Alternative | The name of the workflow. |
workflow (anyOf 2) | null | Alternative |
Get workflow scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a workflow scheme. |
defaultWorkflow | JSON | Optional | |
defaultWorkflow (anyOf 1) | string | Alternative | 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)*. |
defaultWorkflow (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the workflow scheme. |
description (anyOf 2) | null | Alternative | |
draft | JSON | Optional | |
draft (anyOf 1) | boolean | Alternative | Whether the workflow scheme is a draft or not. Read only: true |
draft (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the workflow scheme. Format: int64 Read only: true |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
issueTypeMappings | JSON | Optional | |
issueTypeMappings (anyOf 1) | object | Alternative | 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. Additional keys: see wildcard field |
issueTypeMappings (anyOf 1).* | string | Additional keys | |
issueTypeMappings (anyOf 2) | null | Alternative | |
issueTypes | JSON | Optional | |
issueTypes (anyOf 1) | object | Alternative | The issue types available in Jira. Read only: true Additional keys: see wildcard field |
issueTypes (anyOf 1).* | Model | Additional keys | Expand Get issue type — response body |
issueTypes (anyOf 2) | null | Alternative | |
lastModified | JSON | Optional | |
lastModified (anyOf 1) | string | Alternative | 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. Read only: true |
lastModified (anyOf 2) | null | Alternative | |
lastModifiedUser | JSON | Optional | |
lastModifiedUser (anyOf 1) | Model | Alternative | Expand Get user — response body 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. Read only: true |
lastModifiedUser (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme. |
name (anyOf 2) | null | Alternative | |
originalDefaultWorkflow | JSON | Optional | |
originalDefaultWorkflow (anyOf 1) | string | Alternative | 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. Read only: true |
originalDefaultWorkflow (anyOf 2) | null | Alternative | |
originalIssueTypeMappings | JSON | Optional | |
originalIssueTypeMappings (anyOf 1) | object | Alternative | 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. Read only: true Additional keys: see wildcard field |
originalIssueTypeMappings (anyOf 1).* | string | Additional keys | Read only: true |
originalIssueTypeMappings (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
updateDraftIfNeeded | JSON | Optional | |
updateDraftIfNeeded (anyOf 1) | boolean | Alternative | 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: * 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. * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated. * 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. Defaults to `false`. |
updateDraftIfNeeded (anyOf 2) | null | Alternative |
Referenced models: Get issue type — response body, Get user — response body
Set issue types for workflow in workflow scheme — workflow Schemes update Workflow Mapping — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the mapping between issue types and a workflow. Additional keys: not allowed |
defaultMapping | boolean | Optional | Whether the workflow is the default workflow for the workflow scheme. |
issueTypes | array | Optional | The list of issue type IDs. |
issueTypes[] | string | Each item | |
updateDraftIfNeeded | boolean | Optional | 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`. |
workflow | string | Optional | The name of the workflow. Optional if updating the workflow-issue types mapping. |
Set workflow for issue type in workflow scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the mapping between an issue type and a workflow. Additional keys: not allowed |
issueType | string | Optional | The ID of the issue type. Not required if updating the issue type-workflow mapping. |
updateDraftIfNeeded | boolean | Optional | 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. |
workflow | string | Optional | The name of the workflow. |
Switch workflow scheme for project — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request to switch a project's workflow scheme Additional keys: allowed |
mappingsByIssueTypeOverride | array | Optional | 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. |
mappingsByIssueTypeOverride[] | Model | Each item | Expand Switch workflow scheme for project — request body — body mappings By Issue Type Override item |
projectId | string | Optional | The ID of the project to switch the workflow scheme for |
targetSchemeId | string | Optional | The ID of the target workflow scheme to switch to |
Referenced models: Switch workflow scheme for project — request body — body mappings By Issue Type Override item
Switch workflow scheme for project — request body — body mappings By Issue Type Override item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. Additional keys: not allowed |
issueTypeId | string | Optional | |
statusMappings | array | Optional | |
statusMappings[] | Model | Each item | Expand Update workflow scheme — request body — body status Mappings By Workflows item status Mappings item |
Referenced models: Update workflow scheme — request body — body status Mappings By Workflows item status Mappings item
Update default workflow — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the default workflow. Additional keys: not allowed |
updateDraftIfNeeded | boolean | Optional | 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`. |
workflow | string | Required within parent | The name of the workflow to set as the default workflow. |
Update workflow scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The update workflow scheme payload. Additional keys: allowed |
defaultWorkflowId | string | Optional | 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)*. |
description | string | Required within parent | The new description for this workflow scheme. |
id | string | Required within parent | The ID of this workflow scheme. |
name | string | Required within parent | The new name for this workflow scheme. |
statusMappingsByIssueTypeOverride | array | Optional | 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`. |
statusMappingsByIssueTypeOverride[] | Model | Each item | Expand Switch workflow scheme for project — request body — body mappings By Issue Type Override item |
statusMappingsByWorkflows | array | Optional | 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`. |
statusMappingsByWorkflows[] | Model | Each item | Expand Update workflow scheme — request body — body status Mappings By Workflows item |
version | Model | Required within parent | Expand Update workflow scheme — request body — body version |
workflowsForIssueTypes | array | Optional | Mappings from workflows to issue types. |
workflowsForIssueTypes[] | Model | Each item | Expand Update workflow scheme — request body — body workflows For Issue Types item |
Referenced models: Update workflow scheme — request body — body version, Switch workflow scheme for project — request body — body mappings By Issue Type Override item, Update workflow scheme — request body — body status Mappings By Workflows item, Update workflow scheme — request body — body workflows For Issue Types item
Update workflow scheme — request body — body status Mappings By Workflows item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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`. Additional keys: not allowed |
newWorkflowId | string | Required within parent | The ID of the new workflow. |
oldWorkflowId | string | Required within parent | The ID of the old workflow. |
statusMappings | array | Required within parent | The list of status mappings. |
statusMappings[] | Model | Each item | Expand Update workflow scheme — request body — body status Mappings By Workflows item status Mappings item |
Referenced models: Update workflow scheme — request body — body status Mappings By Workflows item status Mappings item
Update workflow scheme — request body — body status Mappings By Workflows item status Mappings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
newStatusId | string | Optional | |
oldStatusId | string | Optional |
Update workflow scheme — request body — body version
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The current version details of this workflow scheme. Additional keys: not allowed |
id | string | Optional | The version UUID. |
versionNumber | integer | Optional | The version number. Format: int64 |
Update workflow scheme — request body — body workflows For Issue Types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The explicit association between issue types and a workflow in a workflow scheme. Additional keys: not allowed |
issueTypeIds | array | Required within parent | The issue types assigned to the workflow. Unique items: true |
issueTypeIds[] | string | Each item | The issue types assigned to the workflow. |
workflowId | string | Required within parent | The ID of the workflow. |