Workflow User API allows users to manually control Aidbox workflows by RPC methods.
awf.workflow/create-and-execute
Creates an instance of a defined workflow and makes it ready to be executed immediately or at a specified time.
Params:
Parameter
Type
Required
Description
id
string
Identifier of workflow (If not provided, will be auto-generated).
label
string
Human- or machine-readable description of workflow instance.
Example: Import Patient resources
definition
string
Definition of predefined workflow or
custom-defined workflow.
Example:aidbox.bulk/import-resources-workflow
params
object
The input parameters described in the workflow definition.
executeAt
string
Time at which the workflow will become ready. If not provided - workflow will become ready immediately.
Example: 2023-05-03T13:30:43
Result:
Parameter
Type
Description
resources
object[]
Created AidboxWorkflow resources.
POST /rpccontent-type:text/yamlaccept:text/yamlmethod:awf.workflow/create-and-executeparams:definition:aidbox.bulk/import-resources-workflowparams:type:aidboxinputs: - url:https://storage.googleapis.com/aidbox-public/synthea/100/Organization.ndjson.gzresourceType:Organization
status:422error:type:workflow-has-been-donemessage:>- Workflow id:'af10a9cf-3313-45f0-bbf4-7d3bf3a4da37' has already been done. Couldn't cancel it.
awf.workflow/status
Returns the status of a workflow instance with the specified id.
Params:
Parameter
Type
Required
Description
id
string
Id of the workflow whose status will be returned.
include-activities?
boolean
If true , includes tasks and another workflows started by workflow.
Default: false
include-decisions?
boolean
If true, includes all workflow's decision tasks.
Default: false
Result:
Parameter
Type
Description
resource
object
AidboxWorkflow resource.
activities
object[]
Activities started by workflow.
decisions
object[]
Decision task resources of workflow.
POST /rpccontent-type:text/yamlaccept:text/yamlmethod:awf.workflow/statusparams:id:abbc317d-f9b0-415e-b5b5-df059e000060include-activities?:trueinclude-decisions?:true