WorkflowScheme

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