Fetch a workload by ID
GET {{base_url}}/api/workload_management/v5/workloads/:workload_internal_or_external_id
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include_status | boolean | (Optional) Includes workload statuses in the response. |
Type: Boolean |
| include_all_attributes | boolean | | (Optional) Includes all workload attributes in the response. Mutually exclusive with include_attributes.
Type: Boolean |
| include_attributes | string | | (Optional) Includes specified workload attributes in the response. Empty array means no attributes to include. Mutually exclusive with include_all_attributes.
Type: Array of String
Array type description:
Type: String
Max items: 25 |
| include_allowed_actions | boolean | | (Optional) Includes workload allowed_actions in the response.
Type: Boolean |
| include_aggregated_aspects | boolean | | (Optional) Returns aggregates with aggregated aspects in the response.
Type: Boolean Default: true |
RESPONSES
status: OK
{"is_auto_created":true,"enabled":true,"comment":"","agent_id":"ca43f338-ad6F-8BBc-D335-0A455eb9Af6f","external_id":"","created_at":"1970-01-01T00:00:00.000Z","name":"","auto_parent_child_relationship":true,"cross_policy_status":{"names":"","running":{"state":"RUNNING","activities":["backing_up"],"progress":0,"blockers":[{"domain":"","code":"","reason":"","context":{},"kbLink":{"lineTag":"","serCode":"","version":"","build":0,"product":"","os":""},"debug":{}}]},"status":"CRITICAL"},"updated_at":"1970-01-01T00:00:00.000Z","id":"ee62dbe2-FcBC-ebbe-21f7-E58cCEd5eA0A","aggregation_status":"NOT_AGGREGATED","user_defined_name":"","attributes":{},"per_policy_type_statuses":[{"type":"","last_run_time":"1970-01-01T00:00:00.000Z","next_run_time":"1970-01-01T00:00:00.000Z","last_success_run_time":"1970-01-01T00:00:00.000Z","next_enable_time":"1970-01-01T00:00:00.000Z","run_events":[""],"enable_events":[""]}],"client_id":"","effective_parent_ids":["Fe45b2dC-b0bD-EdA8-9d34-ED78fdaDBf9a"],"tag":"","aggregate_id":"DeDDAffc-7D9b-c177-5855-29f2Df7CcACB","allowed_actions":["cti.a.p.xx.v1.0"],"explicit_parent_ids":["1a32EE0a-FBcf-a437-D0DD-E7e590e6bfEe"],"deleted_at":"1970-01-01T00:00:00.000Z","licensing_status":{"current_offering_item":"","previous_offering_item":""},"type":"","tenant_id":"cF9DEF19-dfE5-f1Aa-100a-Fa5b5E2610Fe","is_customer_managed":true}