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	{{code language="none"}} String {{/code}}	1	Instance GUID of cloud object on which the action is being performed, for example, ServiceOfferingInstance.guid.
header	{{code language="none" source="string:{{code language=~"none~"~}~} String {{/code~}~}"/}} {{/code}} )))\|((( 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. ))) \|((( {{code language="none"}} isError {{/code}} )))\|((( {{code language="none"}} Boolean {{/code}} )))\|((( 0..1 )))\|((( The options are: * {{code language="none"}}true{{/code}}: The action being performed has failed * {{code language="none"}}false{{/code}} (the default): The action being performed is successful. ))) \|((( {{code language="none"}} message {{/code}} )))\|((( {{code language="none"}} String {{/code}} )))\|((( 1 )))\|((( Message specific to your custom business logic. ))) \|((( {{code language="none"}} subheader {{/code}} )))\|((( {{code language="none"}} String {{/code}} )))\|((( 1 )))\|((( Subheader name to group all messages populated through your custom business logic. ))) \|((( {{code language="none"}} transactionId {{/code}} )))\|((( {{code language="none"}} String {{/code}} )))\|((( 1 )))\|((( Transaction ID of the current operation. It will be available in {{code language="none"}}CSMRequest{{/code}} XML in case of BMC Atrium Orchestrator or {{code language="none"}}Task{{/code}} object in case of the SDK. ))) {{confluence_table-plus atlassian-macro-output-type="INLINE"}} {{/confluence_table-plus}}If you include both the {{code language="none"}}fillFields{{/code}} and {{code language="none"}}ignoreFields{{/code}} parameters in your query and the same field is listed in both parameters, the {{code language="none"}}ignoreFields{{/code}} parameter takes precedence. == {{id name="ActivityaddActivityTimelinerequest-HTTPresponsemessage"/}}HTTP response message == === {{id name="ActivityaddActivityTimelinerequest-Responsemessageheaders"/}}Response message headers === This API uses only common headers listed in [[doc:Automation-DevSecOps.Client-Management.BMC-Cloud-Lifecycle-Management.clm45.Developing.RESTful-API.Getting-started-with-the-API.HTTP-request-and-response-headers.WebHome]]. === {{id name="ActivityaddActivityTimelinerequest-Responsemessagebody"/}}Response message body === The response message body contains a ##[[Task>>doc:Automation-DevSecOps.Client-Management.BMC-Cloud-Lifecycle-Management.clm45.Developing.RESTful-API.API-reference.Cloud-API-reference.Task-class.WebHome]]## object.