Atlassian · Schema

WorkflowSchemeReadResponse

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
defaultWorkflow object
description string The description of the workflow scheme.
id string The ID of the workflow scheme.
name string The name of the workflow scheme.
projectIdsUsingScheme array The IDs of projects using the workflow scheme.
scope object
taskId string Indicates if there's an [asynchronous task](#async-operations) for this workflow scheme.
version object
workflowsForIssueTypes array Mappings from workflows to issue types.
View JSON Schema on GitHub

JSON Schema

atlassian-workflowschemereadresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WorkflowSchemeReadResponse",
  "title": "WorkflowSchemeReadResponse",
  "additionalProperties": false,
  "properties": {
    "defaultWorkflow": {
      "$ref": "#/components/schemas/WorkflowMetadataRestModel"
    },
    "description": {
      "description": "The description of the workflow scheme.",
      "nullable": true,
      "type": "string"
    },
    "id": {
      "description": "The ID of the workflow scheme.",
      "type": "string"
    },
    "name": {
      "description": "The name of the workflow scheme.",
      "type": "string"
    },
    "projectIdsUsingScheme": {
      "description": "The IDs of projects using the workflow scheme.",
      "items": {
        "description": "The IDs of projects using the workflow scheme.",
        "type": "string"
      },
      "type": "array"
    },
    "scope": {
      "$ref": "#/components/schemas/WorkflowScope"
    },
    "taskId": {
      "description": "Indicates if there's an [asynchronous task](#async-operations) for this workflow scheme.",
      "nullable": true,
      "type": "string"
    },
    "version": {
      "$ref": "#/components/schemas/DocumentVersion"
    },
    "workflowsForIssueTypes": {
      "description": "Mappings from workflows to issue types.",
      "items": {
        "$ref": "#/components/schemas/WorkflowMetadataAndIssueTypeRestModel"
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "name",
    "projectIdsUsingScheme",
    "scope",
    "version",
    "workflowsForIssueTypes"
  ],
  "type": "object"
}