Atlassian · Schema

WorkflowRulesSearch

Details of the workflow and its transition rules.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
expand string Use expand to include additional information in the response. This parameter accepts `transition` which, for each rule, returns information about the transition the rule is assigned to.
ruleIds array The list of workflow rule IDs.
workflowEntityId string The workflow ID.
View JSON Schema on GitHub

JSON Schema

atlassian-workflowrulessearch-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WorkflowRulesSearch",
  "title": "WorkflowRulesSearch",
  "description": "Details of the workflow and its transition rules.",
  "properties": {
    "expand": {
      "description": "Use expand to include additional information in the response. This parameter accepts `transition` which, for each rule, returns information about the transition the rule is assigned to.",
      "example": "transition",
      "type": "string"
    },
    "ruleIds": {
      "description": "The list of workflow rule IDs.",
      "items": {
        "description": "Workflow rule ID.",
        "example": "55d44f1d-c859-42e5-9c27-2c5ec3f340b1",
        "format": "uuid",
        "type": "string"
      },
      "maxItems": 10,
      "minItems": 1,
      "type": "array"
    },
    "workflowEntityId": {
      "description": "The workflow ID.",
      "example": "a498d711-685d-428d-8c3e-bc03bb450ea7",
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "ruleIds",
    "workflowEntityId"
  ],
  "type": "object"
}