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
method

URI

Description

get

GET

csm/TaskDetail/guid

Retrieves a TaskDetail object.

search

POST

csm/TaskDetail/search

Searches for TaskDetail objects.

Operation APIs

Name

HTTP
method

URI

Description

getHierarchy

POST

csm/TaskDetail/guid/getHierarchy

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/TaskDetail/guid/children

Retrieves the children relationship.

relation

GET

csm/TaskDetail/guid/maps to

Retrieves the maps to relationship.

relation

GET

csm/TaskDetail/guid/parent

Retrieves the parent relationship.

relation

GET

csm/TaskDetail/guid/provider

Retrieves the provider relationship.

relation

GET

csm/TaskDetail/guid/tags

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-
plicity

Description

children

TaskDetail

0..*

maps to

BMC_TaskDetail

parent

TaskDetail

0..1

cloudClass

CloudClass

1

Fully-qualified name of the class to which the object belongs

provider

Provider

1

Provider that created the object

tags

Tag

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

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

Date

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

Date

1

Time the task was created

taskStatus

TaskState

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

Date

0..1

Date the Cloudobject was modified

name

String

1

Human-readable name of the object

Was this page helpful? Yes No Submitting... Thank you

Comments