Search people
https://api.knod.es/people/search
Search for people.
Requirements
Acting Customer | Yes |
---|---|
Acting User | Yes |
HTTP Methods
If a method is not listed, it is not supported for this call
GET | Execute search |
---|
Parameters
Parameters optional unless specified
Name | Description | Required? | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
user_id | ID of user to query as. | Yes | ||||||||||
type |
Type of search to execute. Valid values:
|
Yes | ||||||||||
q |
Search query. Defaults to parsing natural language query. For more advanced queries, can include exact phrases surrounded by double-quotes ('"') and can precede required terms/phrases by a plus ('+') sign. For expert level queries, can specify an exact query in Lucene query syntax and include the literal_context parameter. |
Yes | ||||||||||
fields |
Only for people
query type
|
|||||||||||
field_<name> | Filter the query for a specific value for a specific field. Fields are as specified for the fields parameter above. | |||||||||||
include_network_data | 'true' to have the raw network data for the person's network identity(ies) included in the response | |||||||||||
literal_syntax | 'true' to pass an exact Lucene-compatible query to be interpreted literally. (Note: for relevance queries with literal syntax, use text as the query attribute name) | |||||||||||
num | Number of results to return. | |||||||||||
page | Page of results to return (1-based). | |||||||||||
detailed_results | 'true' to return detailed person objects, rather than the default compact ones. |
Response
Search Results object.