Task class

The Task class represents a discrete activity performed by the system. Tasks may be synchronous or asynchronous and are often linked to other tasks.

Task class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the Task class.

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/Task/guid

Retrieves a Task object.

Operation APIs

Name

HTTP
method

URI

Description

completeCallout

POST

csm/Task/guid/completeCallout

Complete the specified callout

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/Task/guid/errors

Retrieves the errors relationship.

relation

GET

csm/Task/guid/provider

Retrieves the provider relationship.

relation

GET

csm/Task/guid/tags

Retrieves the tags relationship.

Task class relationships and attributes

The following tables list the relationships and attributes of the Task class.

Relationships

Name

Type

Multi-
plicity

Description

errors

TaskError

0..*

Errors associated with the task

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

className

String

0..1

Name of the class

completionTime

String

0..1

Time the task was completed

creationTime

String

0..1

Time the task was created

isCallout

Boolean

0..1

Indicates whether the task is a callout

isError

Boolean

0..1

Indicates whether the task generated an error

isSuccess

Boolean

0..1

Indicates whether the task was successful

isWarning

Boolean

0..1

Indicates whether the task generated a warning

objectName

String

0..1

Name of the object

objectUUID

String

0..1

Identifier for the object

operationName

String

0..1

Name of the operation

parentTaskInternalUUID

String

0..1

Identifier of the parent task

results

String

0..*

Task result

taskInternalUUID

String

0..1

Task identifier

taskProgress

Float

0..1

Task progress indicator

taskResultURI

String

0..1

URI of the task result. Issue a GET request on this URI to retrieve the task result.

taskState

TaskState

0..1

Task state

taskStatusURI

String

0..1

URI of the task status. Issue a GET request on this URI to retrieve the task status.

taskSubState

String

0..1

Task sub-state

transactionID

String

0..1

Transaction identifier

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