Atlassian · Schema

CreateWorkflowTransitionDetails

The details of a workflow transition.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
description string The description of the transition. The maximum length is 1000 characters.
from array The statuses the transition can start from.
name string The name of the transition. The maximum length is 60 characters.
properties object The properties of the transition.
rules object The rules of the transition.
screen object The screen of the transition.
to string The status the transition goes to.
type string The type of the transition.
View JSON Schema on GitHub

JSON Schema

atlassian-createworkflowtransitiondetails-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateWorkflowTransitionDetails",
  "title": "CreateWorkflowTransitionDetails",
  "additionalProperties": false,
  "description": "The details of a workflow transition.",
  "properties": {
    "description": {
      "description": "The description of the transition. The maximum length is 1000 characters.",
      "type": "string"
    },
    "from": {
      "description": "The statuses the transition can start from.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "name": {
      "description": "The name of the transition. The maximum length is 60 characters.",
      "type": "string"
    },
    "properties": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "The properties of the transition.",
      "type": "object"
    },
    "rules": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateWorkflowTransitionRulesDetails"
        }
      ],
      "description": "The rules of the transition."
    },
    "screen": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateWorkflowTransitionScreenDetails"
        }
      ],
      "description": "The screen of the transition."
    },
    "to": {
      "description": "The status the transition goes to.",
      "type": "string"
    },
    "type": {
      "description": "The type of the transition.",
      "enum": [
        "global",
        "initial",
        "directed"
      ],
      "type": "string"
    }
  },
  "required": [
    "name",
    "to",
    "type"
  ],
  "type": "object",
  "writeOnly": true
}