Atlassian · Schema

JiraWorkflowStatus

Details of a status.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
description string The description of the status.
id string The ID of the status.
name string The name of the status.
scope object
statusCategory string The category of the status.
statusReference string The reference of the status.
usages array The `statuses.usages` expand is an optional parameter that can be used when reading and updating statuses in Jira. It provides additional information about the projects and issue types associated with
View JSON Schema on GitHub

JSON Schema

atlassian-jiraworkflowstatus-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/JiraWorkflowStatus",
  "title": "JiraWorkflowStatus",
  "additionalProperties": false,
  "description": "Details of a status.",
  "properties": {
    "description": {
      "description": "The description of the status.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the status.",
      "type": "string"
    },
    "name": {
      "description": "The name of the status.",
      "type": "string"
    },
    "scope": {
      "$ref": "#/components/schemas/WorkflowScope"
    },
    "statusCategory": {
      "description": "The category of the status.",
      "enum": [
        "TODO",
        "IN_PROGRESS",
        "DONE"
      ],
      "type": "string"
    },
    "statusReference": {
      "description": "The reference of the status.",
      "type": "string"
    },
    "usages": {
      "description": "The `statuses.usages` expand is an optional parameter that can be used when reading and updating statuses in Jira. It provides additional information about the projects and issue types associated with the requested statuses.",
      "items": {
        "$ref": "#/components/schemas/ProjectIssueTypes"
      },
      "type": "array",
      "uniqueItems": true
    }
  },
  "type": "object"
}