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}}

Entity API / addToCollection

Operation Information

  • Application Reference: com.hornbill.docmanager
  • Scope: Entity - Collection
  • Class: Entity
  • Required Privilege Level: user
  • Required Rights: none

Description

Add a document to collection

Request Parameters

The addToCollection 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
collectionId xs:integer Yes Collection Id
documentId xs:string Yes Document Id

Response Parameters

Name Type Description
h_pk_id xs:string Record Id

Code Examples

In This Document