Find locations associated with a document

https://api.knod.es/documents/:DOC_ID/locations/:REL_TYPE

Find locations associated with a document.

Requirements

Acting Customer Yes
Acting User Yes

HTTP Methods

If a method is not listed, it is not supported for this call

GET Execute query

Parameters

Parameters optional unless specified

Name Description Required?
user_id ID of user to query as. Yes
DOC_ID ID of document to anchor on. Yes
REL_TYPE Optionally, return only those locations associated by the specified relationship type. For valid values, see the edges attribute of the document object.
num If querying list of users, can specify the number to return.
page If querying list of users, specify the page to return (1-based).
detailed_results 'true' to return detailed location objects, rather than the default compact ones.
sort Attribute to sort on (of location object)
sort_direction desc or asc

Response

Search Results object.