main-concepts

No menu items for this category
OpenMetadata Documentation

CreateWorkflowRequest

A unit of work that will be triggered as an API call to the OpenMetadata server.

  • name: Name of the workflow. Refer to ../../type/basic.json#/definitions/entityName.
  • displayName (string): Display Name that identifies this workflow definition.
  • description: Description of the test connection def. Refer to ../../type/basic.json#/definitions/markdown.
  • workflowType: Type of the workflow. Refer to ../../entity/automations/workflow.json#/definitions/workflowType.
  • request: Request body for a specific workflow type.
  • status: Workflow computation status. Refer to ../../entity/automations/workflow.json#/definitions/workflowStatus. Default: Pending.
  • response: Response to the request.
  • owners: Owners of this workflow. Refer to ../../type/entityReferenceList.json. Default: None.
  • domains (array): Fully qualified names of the domains the Workflow belongs to.
    • Items (string)

Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.