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

Operation Information

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

Description

This operation retrieves a list of assets owned by the defined user, and optionally used by & shared by. For use with chatbot integrations.

Request Parameters

The chatbotGetAssets 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
userId xs:string Yes This parameter must be set with the Id of the chatbot session user.
class xs:string No Asset class to return
type xs:integer No Asset classes to return
usedBy xs:boolean No True to return used by assets
shared xs:boolean No True to return shared assets

Response Parameters

Name Type Description
outcome xs:string This parameter is set with the outcome of the operation. The options are "success" and "failure".
assets xs:string JSON array of asset details
assetsCount xs:integer Count of returned assets
error xs:string This parameter is set with validation errors.

Code Examples

In This Document