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
Identifying information specifying the instance to run the action on, if any. May be an instance ID, an instance name, or a full instance object. Required if the action is of type 'update' or 'delete'. Not permitted if the action is of type 'create'.
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": "adipisicing qui",
"task": "cupidatat",
"modelId": "in aliqua",
"actionId": "dolor ut commodo in",
"instance": "fugiat dolore est aliquip",
"instanceName": "sunt laborum do fugiat",
"instanceDescription": "esse in Ut",
"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"
}
}
}
