{ "$id": "resource-action-execution-common", "description": "A history item that tracks the status of an action run on an instance.", "definitions": { "actionId": { "description": "Identifier of the action that was run", "$ref": "resource-model-common#/definitions/action-identifier" }, "modelName": { "description": "The name of the model as it was when the action was run", "type": "string" }, "instanceName": { "description": "The name of the instance as it was when the action was run", "type": "string" }, "actionName": { "description": "The name of the action as it was when the action was run", "type": "string" }, "startTime": { "description": "The time at which the action was started", "type": "string", "format": "date-time" }, "endTime": { "description": "The time at which the action ended", "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "jobId": { "description": "Identifier of the job associated with the action", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "userDefinedError": { "description": "An error reported back by one of the components attached this action in the 'error' output. There is no restriction on what type of data may be stored here." }, "instanceDataSnapshot": { "anyOf": [ { "type": "null" }, { "$ref": "resource-instance-common#/definitions/instanceData" } ] }, "status": { "description": "A single string describing the current activity status of this action", "type": "string", "enum": [ "running", "error", "complete", "canceled", "paused" ] }, "progressItem": { "description": "A record indicating a progress point in the flow of the action", "type": "object", "additionalProperties": false, "required": [ "progressType", "status", "error", "_id", "componentName", "componentId" ], "properties": { "_id": { "description": "Uniquely identifies the progress point within the overall sequence", "type": "string" }, "componentId": { "description": "The id of the component related to the step", "type": "string" }, "componentName": { "description": "The name of the component related to the step", "type": "string" }, "progressType": { "description": "Designates what type of progress point this object describes", "const": "resource:action" }, "error": { "description": "Records any errors directly related to the components in the progress item", "oneOf": [ { "type": "object" }, { "type": "null" } ] }, "status": { "description": "Designates the status of the progress item", "type": "string", "enum": [ "pending", "complete", "error" ] } } }, "progress": { "description": "A sequence of key points in the action describing its overall progress", "type": "object", "patternProperties": { ".*": { "$ref": "#/definitions/progressItem" } } } } }
2023.2 (latest)