Atlassian · Schema

WorkflowSchemeUpdateRequest

The update workflow scheme payload.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
defaultWorkflowId string 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
description string The new description for this workflow scheme.
id string The ID of this workflow scheme.
name string The new name for this workflow scheme.
statusMappingsByIssueTypeOverride array 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
statusMappingsByWorkflows array 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 comb
version object
workflowsForIssueTypes array Mappings from workflows to issue types.
View JSON Schema on GitHub

JSON Schema

atlassian-workflowschemeupdaterequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WorkflowSchemeUpdateRequest",
  "title": "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"
}