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

Operation Information

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

Description

Link documents to an entity

Request Parameters

The linkDocument API takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Required Description
application xs:string Yes Application of entity
entity xs:string Yes The type of entity
key xs:string Yes The id of the entity
documentId xs:string Yes Document Id

Response Parameters

Name Type Description
linkid xs:string RThe link Id

Code Examples

In This Document