The ID of the task definition this method was run from
modelId
string
yes
The ID of the Resource Model to run an action on
actionId
string
yes
The ID of the action to run
instance
*
no
Information that identifies the instance that the action will be run against. This may be an instance ID, an instance name, or a full instance object. This is required if the action is of the 'update' or 'delete' types; it is not permitted if the action is of the 'create' type.
instanceName
string
no
The name to assign to the new instance if the action is a create action
instanceDescription
string
no
The description to assign to the new instance if the action is a create action
variables
object
no
An object specifying inputs to provide to the action. Required only if the referenced action requires inputs.
Copied to Clipboard
{
"job_id": "veniam",
"task": "occaecat qui ut",
"modelId": "deserunt officia minim commodo occaecat",
"actionId": "tempor ut exercitation irure eu",
"instance": "nisi exercitation sed amet aliqua",
"instanceName": "sed cupidatat ad sint officia",
"instanceDescription": "incididunt",
"variables": null
}
{
"title": "result",
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "The ID of the action job"
},
"initiator": {
"type": "string",
"description": "The ID of the user who started the action"
},
"error": {
"type": "object",
"description": "An error designating a failure which occurred while the action was running"
},
"instance": {
"$ref": "resource-instance-database",
"description": "The final instance document created, updated, or deleted by the action"
}
}
}
