Find documents associated with a location
https://api.knod.es/locations/:LOCATION_ID/documents/:REL_TYPE
Find documents associated with a location.
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 |
LOCATION_ID | ID of location to anchor on. | Yes |
REL_TYPE | Optionally, return only those documents associated by the specified relationship type. For valid values, see the edges attribute of the location object. | |
include_network_data | 'true' to have the raw network data for the document included in the response | |
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 document objects, rather than the default compact ones. | |
sort | Attribute to sort on (of document object) | |
sort_direction | desc or asc |
Response
Search Results object.