app-workflow_engine

On this page:

childJob

Summary

Run Child Job

Description

Runs a child job inside a workflow.

Route

No Northbound API Available

Roles

admin apiwrite

Parameters

DetailsExampleSchema
Name Type Required Description
job_id string yes The job ID
task string yes The task name.
workflow string yes The id of the workflow to start.
variables object yes Job variables for the child workflow.
data_array array no Array of items to loop over. Determines number of iterations child job loop has.
transformation string no _id of transformation to run on each element of data_array to set the job variables required to start the each child job.
loopType enum no Allowed values are: [ parallel, sequential ] - Child Job Loop execution type. Parallel child job loops execute all jobs in parallel. Sequential child job loops execute each iteration one at a time, advancing to the next iteration on finish (completion or cancel) of an iteration.

Return

DetailsExampleSchema
Name Type Description
job_details array Details of the initiated job(s).