Atlassian · Schema

JiraWorkflow

Details of a workflow.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
description string The description of the workflow.
id string The ID of the workflow.
isEditable boolean Indicates if the workflow can be edited.
name string The name of the workflow.
scope object
startPointLayout object
statuses array The statuses referenced in this workflow.
taskId string If there is a current [asynchronous task](#async-operations) operation for this workflow.
transitions array The transitions of the workflow.
usages array Use the optional `workflows.usages` expand to get additional information about the projects and issue types associated with the requested workflows.
version object
View JSON Schema on GitHub

JSON Schema

atlassian-jiraworkflow-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/JiraWorkflow",
  "title": "JiraWorkflow",
  "additionalProperties": false,
  "description": "Details of a workflow.",
  "properties": {
    "description": {
      "description": "The description of the workflow.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the workflow.",
      "type": "string"
    },
    "isEditable": {
      "description": "Indicates if the workflow can be edited.",
      "type": "boolean"
    },
    "name": {
      "description": "The name of the workflow.",
      "type": "string"
    },
    "scope": {
      "$ref": "#/components/schemas/WorkflowScope"
    },
    "startPointLayout": {
      "$ref": "#/components/schemas/WorkflowLayout"
    },
    "statuses": {
      "description": "The statuses referenced in this workflow.",
      "items": {
        "$ref": "#/components/schemas/WorkflowReferenceStatus"
      },
      "type": "array",
      "uniqueItems": true
    },
    "taskId": {
      "description": "If there is a current [asynchronous task](#async-operations) operation for this workflow.",
      "nullable": true,
      "type": "string"
    },
    "transitions": {
      "description": "The transitions of the workflow.",
      "items": {
        "$ref": "#/components/schemas/WorkflowTransitions"
      },
      "type": "array",
      "uniqueItems": true
    },
    "usages": {
      "description": "Use the optional `workflows.usages` expand to get additional information about the projects and issue types associated with the requested workflows.",
      "items": {
        "$ref": "#/components/schemas/ProjectIssueTypes"
      },
      "type": "array",
      "uniqueItems": true
    },
    "version": {
      "$ref": "#/components/schemas/DocumentVersion"
    }
  },
  "type": "object"
}