Operation - com.hornbill.servicemanager::Requests/updateReqTimeline


General Description

This operation posts an update to a Request's Timeline.

Request Message

Input Parameters

The Requests/updateReqTimeline method takes the following input parameters. It is important to note that the parameters must be passed to the operation in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
requestId xs:string required once This parameter must be set with the Id of a Request.
action xs:string optional This parameter is deprecated.
source xs:string optional This parameter is deprecated.
content xs:string required once This parameter must be set with the content of the Timeline entry.
extra xs:string optional A JSON structure representing additional content for the Timeline entry.
visibility xs:string optional This parameter must be set with the visibility of the Timeline entry. The options are public, trustedGuest, colleague, manager and owner.
imageUrl xs:string optional This parameter can be set with the URL of an image that is associated to the Timeline entry.
activityType xs:string optional This parameter can be set with activity type that is associated to the Timeline entry. For example, "System" is used for generic updates.
skipBpm xs:boolean optional This parameter determines whether the Request's process is resumed following the Timeline update. By default, this parameter is set to "false".

Response Message

Output Parameters

The Requests/updateReqTimeline method returns the following output parameters.

Name Type Attributes Description
outcome xs:string optional This parameter is set with the outcome of the operation. The options are "success" and "failure".
activityId xs:string optional This parameter is set with the activity Id that is generated after posting a new Timeline entry.
exceptionName xs:string optional This parameter captures any validation errors. The options are "failedTimelinePost" and "failedTimelineImagePost".
exceptionDescription xs:string optional This parameter will be set with an exception's description, thrown by an API.
Powered by Hornbill, for more information click here. (page served by .)