Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Application API / chatbotUpdateReqTimeline

Operation Information

  • Application Reference: com.hornbill.servicemanager
  • Scope: Global
  • Class: Application
  • Required Privilege Level: user
  • Required Rights: Group H - executeSystemAPIs

Description

This operation posts an update to a Request's Timeline. For use with chatbot integrations.

Request Parameters

The chatbotUpdateReqTimeline API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name Type Required Description
requestId xs:string Yes This parameter must be set with the Id of a Request.
userId xs:string Yes This parameter must be set with the Id of the chatbot session user.
content xs:string Yes This parameter must be set with the content of the Timeline entry.
extra xs:string No A JSON structure representing additional content for the Timeline entry.
visibility xs:string No This parameter must be set with the visibility of the Timeline entry. The options are public, trustedGuest, colleague, manager and owner.
activityType xs:string No 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 No This parameter determines whether the Request's process is resumed following the Timeline update. By default, this parameter is set to "false".

Response Parameters

Name Type Description
outcome xs:string This parameter is set with the outcome of the operation. The options are "success" and "failure".
error xs:string This parameter is set with validation errors.

Code Examples

In This Document