Atlassian · Schema

WorkflowMetadataRestModel

Workflow metadata and usage detail.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
description string The description of the workflow.
id string The ID of the workflow.
name string The name of the workflow.
usage array Use the optional `workflows.usages` expand to get additional information about the projects and issue types associated with the workflows in the workflow scheme.
version object
View JSON Schema on GitHub

JSON Schema

atlassian-workflowmetadatarestmodel-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WorkflowMetadataRestModel",
  "title": "WorkflowMetadataRestModel",
  "additionalProperties": false,
  "description": "Workflow metadata and usage detail.",
  "properties": {
    "description": {
      "description": "The description of the workflow.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the workflow.",
      "type": "string"
    },
    "name": {
      "description": "The name of the workflow.",
      "type": "string"
    },
    "usage": {
      "description": "Use the optional `workflows.usages` expand to get additional information about the projects and issue types associated with the workflows in the workflow scheme.",
      "items": {
        "$ref": "#/components/schemas/SimpleUsage"
      },
      "type": "array"
    },
    "version": {
      "$ref": "#/components/schemas/DocumentVersion"
    }
  },
  "required": [
    "description",
    "id",
    "name",
    "usage",
    "version"
  ],
  "type": "object"
}