Developer Documentation

Task

Properties

Required Property Name Type Description
optional correlation_id string

(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.

required created string Not available
optional end_resource_entity_version integer

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

optional end_time string Not available
optional error_message string Not available
optional estimated_remaining_minutes integer

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

required id string

Unique ID for this entity

optional localized_error_message string Not available
optional org_id string Not available
optional org_type string Not available
optional params object Not available
optional parent_task_id string

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

optional phase_in_progress string

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

optional progress_percent integer

Estimated progress percentage the task executed

optional resource_id string

UUID of the resource the task is acting upon

optional resource_type string

Type of resource being acted upon

optional service_errors array of ServiceError

Service errors returned from SDDC services.

optional start_resource_entity_version integer

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

required start_time string Not available
required status string Not available
required sub_status string Not available
optional task_progress_phases array of TaskProgressPhase

Task progress phases involved in current task execution

required task_type string Not available
optional task_version string Not available
required updated string Not available
required updated_by_user_id string

User id that last updated this record

optional updated_by_user_name string

User name that last updated this record

required user_id string

User id that last updated this record

required user_name string

User name that last updated this record

required version integer

Version of this entity

Feedback

Was this page helpful?