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 / chatbotCancelRequest

Operation Information

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

Description

This operation cancels a request. For use with chatbot integrations.

Request Parameters

The chatbotCancelRequest 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.
reason xs:string Yes Reason for cancelling the request. See Simple List for options: CancellationReasons
comment xs:string No Comment provided by the user when cancelling the request

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