Search items from a Squirro project. |
GET/POST https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/items/query
Returns a selection of items from the project. The items be filtered with a query and other parameters.
Parameters: |
| |
---|---|---|
JSON Data: | Data is passed in as a JSON object. Valid object keys:
| |
Headers: | See Common Headers. | |
Status Codes: |
See also Common Status Codes. | |
Returns: | Results including some pagination information. Response fields:
|
GET/POST https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/items/query_encryption
Returns the encrypted and signed version of the query and other query parameters. This encrypted query can then be used with the `Query Items` endpoint using `encrypted_query` parameter to get items matching the encrypted query.
Parameters: |
| |
---|---|---|
JSON Data: | Data is passed in as a JSON object. Valid object keys:
Example request body:
| |
Headers: | See Common Headers. | |
Status Codes: |
See also Common Status Codes. | |
Returns: | Response fields:
|
GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/items
Returns a selection of items from the project. The items be filtered with a query and other parameters.
Parameters: |
| |
---|---|---|
Query Parameters: |
| |
Headers: | See Common Headers. | |
Status Codes: |
See also Common Status Codes. | |
Returns: | Results including some pagination information. Response fields:
|
GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/items/(id: item_id)
Returns a single item from the project.
Parameters: |
| |
---|---|---|
Query Parameters: |
| |
Headers: | See Common Headers. | |
Status Codes: |
See also Common Status Codes. | |
Returns: | The item in the item response field.
|
PUT https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/items/(id: item_id)
Updates an item in the project. This can only be used to modify the keywords and states.
Parameters: |
| |
---|---|---|
JSON Data: | Data is passed in as a JSON object. Valid object keys:
Example request body:
| |
Headers: | See Common Headers. | |
Status Codes: |
See also Common Status Codes. |
DELETE https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/items/(id: item_id)
This resource can only be used on projects which have their own project index
This resource
Parameters: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |