Activity addActivityTimeline request

Description

This API 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 provisioning updates or similar actions to end users.

API stability classification

Unassigned

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/Activity/addActivityTimeline

Activity

1

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP request and response headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objects 

Name

Type

Multi-
plicity

Description

callbackURL

String

0..1

URL to call when the operation finishes

postCallout

String

0..1

Identifier of a callout to run after the operation executes

preCallout

String

0..1

Identifier of a callout to run before the operation executes

timeout

Integer

0..1

Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values:

  • 0: Immediate timeout
  • -1: Uses the system default timeout value
  • 1..*: Times out in the specified number of seconds

operationParams

OperationParameter

1

Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing input parameters with an API request.

 
Input parameters to include in operationParams 

Name

Type

Multi-
plicity

Description

contextInstanceGuid

String

1

Instance GUID of cloud object on which the action is being performed, for example, ServiceOfferingInstance.guid.

header

String

1

Header name to group all messages populated through your custom business logic. Choose a header name that will not overwrite out-of-the-box headers that BMC Cloud Lifecycle Management populates.

isError

Boolean

0..1

The options are:

  • true: The action being performed has failed
  • false (the default): The action being performed is successful.

message

String

1

Message specific to your custom business logic.

subheader

String

1

Subheader name to group all messages populated through your custom business logic.

transactionId

String

1

Transaction ID of the current operation. It will be available in CSMRequest XML in case of BMC Atrium Orchestrator or Task object in case of the SDK.

 If you include both the fillFields and ignoreFields parameters in your query and the same field is listed in both parameters, the ignoreFields parameter takes precedence.

HTTP response message

Response message headers

This API uses only common headers listed in HTTP request and response headers.

Response message body

The response message body contains a Task object.

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

Comments