Atlassian · Schema

WorkflowSchemeUpdateRequest

The update workflow scheme payload.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
defaultWorkflowId string The ID of the workflow for issue types without having a mapping defined in this workflow scheme. Only used in global-scoped workflow schemes. If the `defaultWorkflowId` isn't specified, this is set to
description string The new description for this workflow scheme.
id string The ID of this workflow scheme.
name string The new name for this workflow scheme.
statusMappingsByIssueTypeOverride array Overrides, for the selected issue types, any status mappings provided in `statusMappingsByWorkflows`. Status mappings are required when the new workflow for an issue type doesn't contain all statuses
statusMappingsByWorkflows array The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a comb
version object
workflowsForIssueTypes array Mappings from workflows to issue types.
View JSON Schema on GitHub

JSON Schema

atlassian-workflowschemeupdaterequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WorkflowSchemeUpdateRequest",
  "title": "WorkflowSchemeUpdateRequest",
  "additionalProperties": true,
  "description": "The update workflow scheme payload.",
  "properties": {
    "defaultWorkflowId": {
      "description": "The ID of the workflow for issue types without having a mapping defined in this workflow scheme. Only used in global-scoped workflow schemes. If the `defaultWorkflowId` isn't specified, this is set to *Jira Workflow (jira)*.",
      "type": "string"
    },
    "description": {
      "description": "The new description for this workflow scheme.",
      "type": "string"
    },
    "id": {
      "description": "The ID of this workflow scheme.",
      "type": "string"
    },
    "name": {
      "description": "The new name for this workflow scheme.",
      "type": "string"
    },
    "statusMappingsByIssueTypeOverride": {
      "description": "Overrides, for the selected issue types, any status mappings provided in `statusMappingsByWorkflows`. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`.",
      "items": {
        "$ref": "#/components/schemas/MappingsByIssueTypeOverride"
      },
      "type": "array"
    },
    "statusMappingsByWorkflows": {
      "description": "The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`.",
      "items": {
        "$ref": "#/components/schemas/MappingsByWorkflow"
      },
      "type": "array"
    },
    "version": {
      "$ref": "#/components/schemas/DocumentVersion"
    },
    "workflowsForIssueTypes": {
      "description": "Mappings from workflows to issue types.",
      "items": {
        "$ref": "#/components/schemas/WorkflowSchemeAssociation"
      },
      "type": "array"
    }
  },
  "required": [
    "description",
    "id",
    "name",
    "version"
  ],
  "type": "object"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/atlassian-workflowschemeupdaterequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.