app-operations_manager

addJobGroup

Adds a group ID to the groups array of a job

Adds a group ID to the groups array of a job

addWatchersToJob

Adds the specified user ids as watchers of a job

Adds the specified user ids as watchers of a job

assignTask

Assign a task to a user

Assign a task to a user.

cancelJobs

Cancels jobs.

Cancels all jobs specified by the job id array.

claimTask

Claim a task

Mark a task's ownership with the current user's user id.

cloneAutomation

Clone Automation

Clone an automation document from a user supplied JSON document.

continueJobFrom

Continue a job from a specified task

Continue a job from a specified task

createAutomation

Create Automation

Create a new Automation document in IAP.

createTrigger

Create Trigger

Create a Trigger document

deleteAutomation

Delete Automation

Delete an Automation document from IAP.

deleteJobGroup

Removes a group ID from a job

Removes a group ID from a job

deleteJobGroups

Removes all groups from a job

Removes all groups from a job

deleteTrigger

Delete Trigger

Delete a Trigger document

deleteTriggersByActionId

Delete Triggers By Action ID

Deletes all Trigger documents associated with the provided action id

exportAutomation

Export Automation

Exports a single Automation document from IAP that is formatted for importing into another IAP instance.

exportTrigger

Export Trigger

Exports a single Trigger document from IAP that is formatted for importing into another IAP instance.

finishManualTask

Finish a manual task

Finish a manual task.

getAutomation

Get Automation

Get a single Automation document

getAutomations

Get Automations

Query the Automation document collection

getEventDefinition

undefined

get an eventSystem definition given its source and topic

getEvents

undefined

search through event system events that can be used in an event trigger

getJob

Get a job by ID

Get a job by ID. Include or exclude fields with the 'include' and 'exclude' parameters. Dereference foreign references with the 'dereference' parameter. Note on dereference parameter: The main function of this parameter is to pull in extra information on a job that would not ordinarily be included. If the output of a Gen 2 workflow job is needed, the dereference parameter may be given a value of 'output'. This will look up the output of the job and place the resulting value under the 'output' property at the top level of the job document. Note that the output of a Gen 1 workflow job is just its job variables, and so the caller may refer to the 'variables' property to obtain that information. If the inputs and outputs of the job's individual tasks are needed, the dereference parameter may be set to 'task'. This will look up all iterations (runs) of each task in the job, and will place those documents under the 'iterations' array in each task definition in the job. If a job is a child of another job, and details on the parent job are needed, the dereference parameter may be given a value of 'parent'. This will place the full parent job document under the property 'parent.job'. Please see the search documentation page for further information: https://docs.itential.com/docs/search-api-4

getJobs

Gets a page of job documents.

Gets a page of job documents. Note on dereference parameter: The main function of this parameter is to pull in extra information on jobs that would not ordinarily be included. If the output of a Gen 2 workflow job is needed, the dereference parameter may be given a value of 'output'. This will look up the output for each job and place the resulting value under the 'output' property at the top level of the job document. Note that the output of a Gen 1 workflow job is just its job variables, and so the caller may refer to the 'variables' property to obtain that information. If the inputs and outputs of individual tasks are needed, the dereference parameter may be given a value of 'task'. This will look up all iterations (runs) of each task in each job, and will place those documents under the 'iterations' array in each task definition in each job. If a job is a child of another job, and details on the parent job are needed, the dereference parameter may be given a value of 'parent'. This will place the full parent job document under the property 'parent.job'. Please see the search documentation page for further information: https://docs.itential.com/docs/search-api-4

getManualTaskController

Get a client-side dialog controller for a manual task

Get a client-side dialog controller for a manual task

getTask

Get a task by ID

Get a task by ID. Include or exclude fields with the 'include' and 'exclude' parameters. Dereference foreign references with the 'dereference' parameter. Note on dereference parameter: The main function of this parameter is to pull in extra information on a task that would not ordinarily be included. If information is needed on the task's parent job, the dereference parameter may be given a value of 'job'. This will look up the full job document and place it under the 'job' property in the task document. If the output of a child job task is needed, the dereference parameter may be given a value of 'child-job-output'. This will look up the output of the job initiated by the child job task. If the child job has loop settings each individual output will be provided in an array under the property 'variables.outgoing.job_details.loop'. If the child job does not have loop settings, the output of the single job document will be provided under the property 'variables.outgoing.job_details.output'.

getTasks

Gets a page of task documents, bypassing GBAC.

Gets a page of task documents, bypassing GBAC. Note on dereference parameter: The main function of this parameter is to pull in extra information on a task that would not ordinarily be included. If information is needed on the tasks' parent jobs, the dereference parameter may be given a value of 'job'. This will look up the full job document and place it under the 'job' property in each task document. If the outputs of child job tasks are needed, the dereference parameter may be given a value of 'child-job-output'. This will look up the output of the job initiated by each child job task. If the child job has loop settings, each individual output will be provided in an array under the property 'variables.outgoing.job_details.loop'. If the child job does not have loop settings, the output of the single job document will be provided under the property 'variables.outgoing.job_details.output'. Please see the search documentation page for further information: https://docs.itential.com/docs/search-api-4

getTrigger

Get Trigger

Get a Trigger document

getTriggers

Get Triggers

Query the Trigger document collection

importAutomations

Import Automations

Import Automation documents from a user supplied JSON document.

importTriggers

Import Triggers

pauseJobs

Pauses jobs.

Pauses all jobs specified by the job id array.

releaseTask

Release a currently assigned task

Release a currently assigned task

replaceJobGroups

Replaces all groups from a job with the specified group array

Replaces all groups from a job with the specified group array

resumeJobs

Resumes jobs.

Resumes all jobs specified by the job id array.

retryTask

Retry a task

Retry a task

revertJob

Revert a job from an errored task to a previously completed task

Revert a job from an errored task to a previously completed task

runEndpointTriggerWithPost

Run Endpoint Trigger With POST

Runs the action associated with the API Trigger document, given the routeName, and POST as the verb

runManualTrigger

Run Manual Trigger

Manually runs the action associated with the Trigger document

startJob

Initiates a job from a workflow.

Initiates a job from a workflow.

unwatchJob

Removes the current user as watcher of a job

Removes the current user as watcher of a job

unwatchJobs

Removes the current user as a watcher of multiple jobs

Removes the current user as a watcher of multiple jobs

updateAutomation

Update Automation

Update an Automation document

updateTrigger

Update Trigger

Update the properties of a Trigger document

watchJob

Adds the current user as watcher of a job

Adds the current user as watcher of a job

watchJobs

Adds the current user as a watcher of multiple jobs

Adds the current user as a watcher of a multiple jobs