Activity class
Activity class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the Activity class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
delete | DELETE | Deletes a Activity object. | |
search | POST | Searches for Activity objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
addActivityTimeline | POST | (4.6.05 and later) Adds a new timeline entry with a specified message in a specified activity record. This method is useful for BMC Atrium Orchestrator callouts or customization logic to inject additional updates of provisioning or similar actions to end users. |
Relationship APIs
The Activity class has no relationship APIs.
Activity class relationships and attributes
The following tables list the relationships and attributes of the Activity class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
childActivities | 0..* |
| |
parentActivity | 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 |
|---|---|---|---|
action | String | 0..1 |
|
completedChildActivities | Integer | 0..1 |
|
completionTime | 0..1 |
| |
context | String | 0..1 |
|
contextInstanceGuid | String | 0..1 |
|
creationTime | 0..1 |
| |
errors | String | 0..1 |
|
intendedUser | String | 0..1 |
|
objectName | String | 0..1 |
|
origination | String | 1 |
|
owner | String | 0..1 |
|
progress | Integer | 0..1 |
|
state | 1 |
| |
taskUUID | String | 1 |
|
timeline | String | 0..1 |
|
totalChildActivities | Integer | 0..1 |
|
transactionID | String | 0..1 |
|
user | String | 0..1 |
|
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 |