Task

Properties

string
correlation_id Optional

(Optional) Client provided uniqifier to make task creation idempotent. Be aware not all tasks support this. For tasks that do - supplying the same correlation Id, for the same task type, within a predefined window will ensure the operation happens at most once.


string
created Required
Not available

integer
end_resource_entity_version Optional

Entity version of the resource at the end of the task. This is only set for some task types.


string
end_time Optional
Not available

string
error_message Optional
Not available

integer
estimated_remaining_minutes Optional

Estimated remaining time in minute of the task execution, < 0 means no estimation for the task.


string
id Required

Unique ID for this entity


string
localized_error_message Optional
Not available

string
org_id Optional
Not available

string
org_type Optional
Not available

object
params Optional
Not available

string
parent_task_id Optional

If this task was created by another task - this provides the linkage. Mostly for debugging.


string
phase_in_progress Optional

The current in progress phase ID in the task execution, if none in progress, empty string returned.


integer
progress_percent Optional

Estimated progress percentage the task executed


string
resource_id Optional

UUID of the resource the task is acting upon


string
resource_type Optional

Type of resource being acted upon


array of ServiceError
service_errors Optional

Service errors returned from SDDC services.


integer
start_resource_entity_version Optional

Entity version of the resource at the start of the task. This is only set for some task types.


string
start_time Required
Not available

string
status Required
Not available

Possible values are: STARTEDCANCELINGFINISHEDFAILEDCANCELED


string
sub_status Required
Not available

task_progress_phases Optional

Task progress phases involved in current task execution


string
task_type Required
Not available

string
task_version Optional
Not available

string
updated Required
Not available

string
updated_by_user_id Required

User id that last updated this record


string
updated_by_user_name Optional

User name that last updated this record


string
user_id Required

User id that last updated this record


string
user_name Required

User name that last updated this record


integer
version Required

Version of this entity

JSON Example

{
    "created": "string",
    "id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
    "start_time": "string",
    "status": "string",
    "sub_status": "string",
    "task_type": "string",
    "updated": "string",
    "updated_by_user_id": "string",
    "user_id": "string",
    "user_name": "string",
    "version": 5
}
Feedback

Was this page helpful?