WorkflowDefaultRead

Fields

11 fields

base · required

string

model_stages

array of string

reason

string or null

resolved_name

string or null

resolved_ref

string or null

source · required

string

state · required

string

updated_at

string (date-time) or null

updated_by

string or null

workflow_id · required

string

workflow_version

integer or null

Raw schema (JSON)

{
  "properties": {
    "base": {
      "title": "Base",
      "type": "string"
    },
    "model_stages": {
      "items": {
        "type": "string"
      },
      "title": "Model Stages",
      "type": "array"
    },
    "reason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reason"
    },
    "resolved_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Resolved Name"
    },
    "resolved_ref": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Resolved Ref"
    },
    "source": {
      "title": "Source",
      "type": "string"
    },
    "state": {
      "title": "State",
      "type": "string"
    },
    "updated_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    },
    "updated_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated By"
    },
    "workflow_id": {
      "title": "Workflow Id",
      "type": "string"
    },
    "workflow_version": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Workflow Version"
    }
  },
  "required": [
    "base",
    "source",
    "workflow_id",
    "state"
  ],
  "title": "WorkflowDefaultRead",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• PUT /api/v1/projects/{project_id}/workflows/defaults/{base} — Put Workflow Default
• GET /api/v1/projects/{project_id}/workflows/defaults — Get Workflow Defaults

Used by schemas

• WorkflowDefaultsResponse

More details

• Specification: OpenAPI JSON