json.schema.api.automations.createWorkflow.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.0-rc1

{
  "$id": "https://open-metadata.org/schema/api/automations/createWorkflow.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateWorkflowRequest",
  "description": "A unit of work that will be triggered as an API call to the OpenMetadata server.",
  "type": "object",
  "javaType": "org.openmetadata.schema.entity.automations.CreateWorkflow",
  "javaInterfaces": ["org.openmetadata.schema.CreateEntity"],
  "properties": {
    "name": {
      "description": "Name of the workflow.",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this workflow definition.",
      "type": "string"
    },
    "description": {
      "description": "Description of the test connection def.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "workflowType": {
      "description": "Type of the workflow.",
      "$ref": "../../entity/automations/workflow.json#/definitions/workflowType"
    },
    "request": {
      "description": "Request body for a specific workflow type",
      "oneOf": [
        {
          "$ref": "../../entity/automations/testServiceConnection.json"
        }
      ]
    },
    "status": {
      "description": "Workflow computation status.",
      "$ref": "../../entity/automations/workflow.json#/definitions/workflowStatus",
      "default": "Pending"
    },
    "response": {
      "description": "Response to the request.",
      "oneOf": [
        {
          "$ref": "../../entity/services/connections/testConnectionResult.json"
        }
      ]
    },
    "owners": {
      "description": "Owners of this workflow.",
      "$ref": "../../type/entityReferenceList.json",
      "default": null
    },
    "domain" : {
      "description": "Fully qualified name of the domain the Table belongs to.",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": ["name", "workflowType", "request"]
}