Xceptor · Schema

Workflow

A workflow definition that describes a multi-step data processing pipeline in the Xceptor platform.

API IntegrationData AutomationData ExtractionDocument ProcessingETLFinancial DataFinancial ServicesIntelligent Document ProcessingReconciliationsTrade Operations

Properties

Name	Type	Description
id	string	The unique identifier of the workflow
name	string	The display name of the workflow
description	string	A detailed description of what the workflow does
status	string	The activation status of the workflow
category	string	The category or group the workflow belongs to
trigger_type	string	How the workflow is triggered for execution
schedule	string	The cron expression for scheduled workflows, applicable when trigger_type is scheduled
steps	array	The ordered list of processing steps in the workflow
created_at	string	The date and time the workflow was created
updated_at	string	The date and time the workflow was last updated
created_by	string	The identifier of the user who created the workflow

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Workflow",
  "title": "Workflow",
  "type": "object",
  "description": "A workflow definition that describes a multi-step data processing pipeline in the Xceptor platform.",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the workflow"
    },
    "name": {
      "type": "string",
      "description": "The display name of the workflow"
    },
    "description": {
      "type": "string",
      "description": "A detailed description of what the workflow does"
    },
    "status": {
      "type": "string",
      "description": "The activation status of the workflow",
      "enum": [
        "active",
        "inactive",
        "draft"
      ]
    },
    "category": {
      "type": "string",
      "description": "The category or group the workflow belongs to"
    },
    "trigger_type": {
      "type": "string",
      "description": "How the workflow is triggered for execution",
      "enum": [
        "manual",
        "scheduled",
        "event",
        "api"
      ]
    },
    "schedule": {
      "type": "string",
      "description": "The cron expression for scheduled workflows, applicable when trigger_type is scheduled"
    },
    "steps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WorkflowStep"
      },
      "description": "The ordered list of processing steps in the workflow"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the workflow was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the workflow was last updated"
    },
    "created_by": {
      "type": "string",
      "description": "The identifier of the user who created the workflow"
    }
  }
}