SyntheticClassTaskAllOf1

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.


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
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 Optional
Not available

string
status Optional
Not available

Possible values are: STARTEDCANCELINGFINISHEDFAILEDCANCELED


string
sub_status Optional
Not available

task_progress_phases Optional

Task progress phases involved in current task execution


string
task_type Optional
Not available

string
task_version Optional
Not available

JSON Example

{
    "correlation_id": "string",
    "end_resource_entity_version": 5,
    "end_time": "string",
    "error_message": "string",
    "estimated_remaining_minutes": 4,
    "localized_error_message": "string",
    "org_id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
    "org_type": "string",
    "parent_task_id": "string",
    "phase_in_progress": "string",
    "progress_percent": 75,
    "resource_id": "string",
    "resource_type": "string",
    "service_errors": [
        {
            "default_message": "string",
            "localized_message": "string",
            "original_service": "string",
            "original_service_error_code": "string"
        }
    ],
    "start_resource_entity_version": 0,
    "start_time": "string",
    "status": "string",
    "sub_status": "string",
    "task_progress_phases": [
        {
            "id": "string",
            "name": "string",
            "progress_percent": 0
        }
    ],
    "task_type": "string",
    "task_version": "string"
}
Feedback

Was this page helpful?