-
addWatchers
Add watchers to a job
POST /workflow_engine/job/watchers/watchAdd users to the watchers list of a job by job ID and username.
-
cancelJob
Cancel a job
POST /workflow_engine/cancelJobCancel an active job by job ID.
-
checkWorkflowForJobVariables
Get job variables of a workflow
GET /workflow_engine/workflows/variables/:nameGet job variables of a workflow by workflow name.
-
childJob
Run child job
No Northbound API AvailableRun a child job inside a workflow.
-
claimJob
Claim a Job
POST /workflow_engine/claimJobClaim a Job by Job ID and username.
-
claimTask
Claim Task
POST /workflow_engine/tasks/claimClaim a manual Task
-
createJobGroupEntry
Add Group to Job
POST /workflow_engine/jobs/:id/groupsAdd a group to the list of groups for a Job
-
deepmerge
Deep Merge Data
No Northbound API AvailableMerge data using extend
-
delay
Delay a Job
No Northbound API AvailableDelay a Job for a duration by Job ID and number of seconds.
-
deleteJobGroups
Delete all Groups for a Job
DELETE /workflow_engine/jobs/:id/groupsRemove all authorization restriction for a Job
-
evaluation
Run Evaluation Task
No Northbound API AvailableRun an evaluation
-
exportWorkflow
Export Workflow
POST /workflow_engine/workflows/exportExport a single Workflow
-
find
Find Job Documents
POST /workflow_engine/jobs/findFind Job Documents based on a query and additional options
-
findForwardPaths
Find Forward Paths
POST /workflow_engine/findForwardPathsFind the paths between two Tasks in a Workflow by Task ids and Workflow details.
-
fixJob
Revert an errored Job
POST /workflow_engine/fixJobRevert an errored Job to a target Task by Job ID and Task names.
-
forEach
For Each Loop
No Northbound API AvailableIterate over each item in an array
-
getAllLoopTasks
Get All Loop Tasks
POST /workflow_engine/getAllLoopTasksGet all looped Tasks in a Workflow by Workflow details.
-
getAssociatedJobs
Get Associated Jobs
POST /workflow_engine/getAssociatedJobsSearch for Jobs that the user has touched.
-
getEntireJob
Get a Job
GET /workflow_engine/getEntireJob/:job_dataGet entire data of a Job by Job ID.
-
getJob
Get a Job
GET /workflow_engine/getJob/:job_idGet a Job by Job ID.
-
getJobDeep
Get Details of an Active Job
GET /workflow_engine/job/:job_id/deepGet an active Job's details of its active and completed Tasks. Returns a subset of job data, omitting tasks' returned data and transition information but adding tasks' iteration information.
-
getJobFromTaskQuery
Get Job From Task Query
POST /workflow_engine/getJobFromTaskQuerySearch for Jobs using a Task Query.
-
getJobList
Get List of Jobs
POST /workflow_engine/getJobList/:statusGet a list of Jobs by status.
-
getJobShallow
Get Shallow Data of a Job
GET /workflow_engine/getJobShallow/:job_dataGet shallow data of a Job by Job ID. Returns a subset of data returned by omitting tasks' application, tasks' incoming arguments, tasks' returned data, and tasks' error information.
-
getJobVisualizationData
Get a Job's Visualization Data
GET /workflow_engine/jobs/visdata/:job_idGet a Job's visualization data by Job ID.
-
getManualTaskController
Get a Manual Task's Controller
GET /workflow_engine/tasks/controller/:task_idGet a manual Task's controller by Task ID.
-
getTask
Get a Job's Task
POST /workflow_engine/getTaskGet the first Job's Task matching the query and return the data optionally modified by the filter.
-
getTaskDetails
Get Task Details
GET /workflow_engine/locations/:location/packages/:pckg/tasks/:methodGet the detailed information model for a task
-
getTaskIterations
Get Iterations of a Job's Task
GET /workflow_engine/getTaskIterations/:job_id/:taskGet iterations of a Job's Task by Job ID and Task name.
-
getTaskStatuses
Get Task Statuses
GET /workflow_engine/job/statuses/:job_idGet the status of each Task in a Job by Job ID.
-
getWorkflowsDetailedByName
Get Details of a Workflow
GET /workflow_engine/workflows/detailed/:nameGet the details of a Workflow by Workflow name.
-
importWorkflow
Import Workflow
POST /workflow_engine/workflows/importImport a single Workflow
-
listJobGroups
List Groups for a Job
GET /workflow_engine/jobs/:id/groupsList the groups that have access to a Job
-
merge
Merge Data
No Northbound API AvailableMerge data into a single object
-
modify
Modify Data
No Northbound API AvailableModify data
-
newVariable
Create a Job Variable
No Northbound API AvailableCreate a new Job variable by Job ID and assign it a value.
-
pauseJob
Pause a Job
POST /workflow_engine/pauseJobPause a Job by Job ID.
-
pop
Array Pop
No Northbound API AvailablePop off the end data item from a job variable array
-
push
Push Item to Array
No Northbound API AvailablePush item to a job variable array
-
query
Query Data Using 'json-query' Format
POST /workflow_engine/queryQuery data using a dot/bracket notation string and a matching key/value pair.
-
queryJobs
Get Jobs
POST /workflow_engine/queryJobsGet Jobs matching the query.
-
queryTasks
Get Jobs' Tasks
POST /workflow_engine/queryTasksGet Jobs' Tasks matching the query and return the data optionally modified by the filter.
-
queryTasksBrief
Get a brief about Task(s) for currently running Jobs
POST /workflow_engine/queryTasksBriefGet brief information about task(s) from the tasks collection in mongoDB. This will return only tasks that are attached to a currently running Job
-
releaseJob
Release a Job
POST /workflow_engine/releaseJobRelease a Job by Job ID.
-
releaseTask
Release a Task
POST /workflow_engine/tasks/releaseRelease a manual Task of a job by Task ID.
-
removeJobGroup
Remove a Group from a Job
DELETE /workflow_engine/jobs/:id/groups/:groupRemove a group from the list of authorized groups for a Job
-
replaceJobGroups
Overwrite Groups for a Job
PUT /workflow_engine/jobs/:id/groupsOverwrite the list of groups that have access to a Job
-
resumeJob
Resume a Job
POST /workflow_engine/resumeJobResume a paused or errored Job by Job ID.
-
returnCompletedTaskData
Finish a task
POST /workflow_engine/jobs/finish_task/:job_id/:task_idFinish a task and set its output data
-
revertToTask
Revert To a Task
POST /workflow_engine/revertToTaskRevert a Job from current Task to the target Task by Job ID and Task Names.
-
runEvaluationGroup
Evaluation
POST /workflow_engine/runEvaluationGroupRun a test evaluation.
-
runEvaluationGroups
Evaluation Group
POST /workflow_engine/runEvaluationGroupsRun a test evaluation group.
-
searchJobs
Search Jobs
POST /workflow_engine/jobs/searchSearch Jobs with Options
-
searchTasks
Search Tasks
POST /workflow_engine/tasks/searchSearch Tasks with Options
-
searchWorkflows
Search Workflows
POST /workflow_engine/workflows/searchSearch Workflows with Options
-
shift
Array Shift
No Northbound API AvailableShift off the top data item from a job variable array
-
startJobWithOptions
Start a Job with Options
POST /workflow_engine/startJobWithOptions/:workflowInitiate a Job of a Workflow with options.
-
unwatchJob
Unwatch a Job
DELETE /workflow_engine/job/:job_id/watchRemove the current user from the watchers list of a Job.
-
updateJobDescription
Update Job Description
No Northbound API AvailableOverwrite the job description with a new one
-
validateAllLoops
Validate All Loops
POST /workflow_engine/validateAllLoopsValidate all looped Tasks in a Workflow by Workflow details.
-
watchJob
Watch a Job
PUT /workflow_engine/job/:job_id/watchAdd current user to a Job's watchers list.
2019.1
- API REFERENCE
- USER
- ADMIN
- DEVELOPER
- PRODUCT NOTICES