TaskDetail class
The TaskDetail class persists a Task object, and represents a discrete activity performed by the system.
TaskDetail class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the TaskDetail class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
get | GET | Retrieves a TaskDetail object. | |
search | POST | Searches for TaskDetail objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
getHierarchy | POST |
|
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the children relationship. | |
relation | GET | Retrieves the maps to relationship. | |
relation | GET | Retrieves the parent relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
TaskDetail class relationships and attributes
The following tables list the relationships and attributes of the TaskDetail class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
children | 0..* |
| |
maps to | BMC_TaskDetail |
|
|
parent | 0..1 |
| |
cloudClass | 1 | Fully-qualified name of the class to which the object belongs | |
provider | 1 | Provider that created the object | |
tags | 0..* | Tags associated with the object |
Attributes
Name | Type | Multi- | Description |
|---|---|---|---|
targetClassName | String | 0..1 | Name of the class |
targetOperationName | String | 0..1 | URI of the task result. Issue a GET request on this URI to retrieve the task result. |
taskEndDate | 0..1 | Time the task was completed | |
taskErrorDetails | String | 0..1 | Task progress indicator |
taskErrorMessage | String | 0..1 | Errors associated with the task |
taskProviderDefName | String | 0..1 | Identifier for the object |
taskProviderName | String | 0..1 | Name of the object |
taskStartDate | 1 | Time the task was created | |
taskStatus | 0..1 | Task state | |
taskTransactionID | String | 1 | Transaction identifier |
taskUUID | String | 1 | Task identifier |
userName | String | 1 | Task result |
userOrganizationName | String | 1 | Task sub-state |
description | String | 0..1 | Text that describes the object |
guid | String | 1 | Globally unique identifier for the object |
labels | String | 0..* |
|
modifiedDate | 0..1 | Date the Cloudobject was modified | |
name | String | 1 | Human-readable name of the object |