Objects are used to group the sources in a project. |
For pagination support, please consult the "v1" endpoint of the objects API described below.
GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects
Returns an array of all objects in the project.
Parameters: |
| |
---|---|---|
Headers: | See Common Headers. | |
Status Codes: |
See also Common Status Codes. | |
Returns: | Array of objects.
|
GET https://squirro-endpoint/api/topic/v1/(string: tenant)/projects/(id: project_id)/objects
Returns a paginated list of all objects for the project.
Parameters: |
| |
---|---|---|
Headers: | See Common Headers. | |
Status Codes: |
See also Common Status Codes. | |
Returns: | Array of objects.
Please note that the response in the example above has been cut to display only 2 objects out of otherwise 100 objects. |
POST https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects
Parameters: |
| |
---|---|---|
Form Parameters: |
| |
Headers: | See Common Headers. | |
Status Codes: |
See also Common Status Codes. | |
Returns: | Object with object and project identifier.
|
POST https://squirro-endpoint/api/topic/v1/(string: tenant)/projects/(id: project_id)/objects
Parameters: |
| |
---|---|---|
Form Parameters: |
| |
Headers: | See Common Headers. | |
Status Codes: |
See also Common Status Codes. | |
Returns: | Object with object and project identifier.
|
GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects/(id: object_id)
Returns information about a single object.
Parameters: |
| |
---|---|---|
Headers: | See Common Headers. | |
Status Codes: |
See also Common Status Codes. | |
Returns: | Object information.
|
PUT https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects/(id: object_id)
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. |
Example request:
PUT /v0/example/projects/O8Yz-mpLSK-O7FR_aWzvmQ/objects/8aGYz97eT-yVeunA_9Zzmg Host: topic-api.squirro.com Accept: application/json Content-Type: application/json {"title": "New object title"} |
DELETE https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects/(id: object_id)
Returns an array of all objects in the project.
Parameters: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
POST https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects/{id: object_id}/pause
Pauses all subscriptions of an object.
Parameters: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
POST https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects/{id: object_id}/resume
Resumes all existing subscriptions of an object.
Parameters: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Pausing an object only affects the existing subscriptions. When adding a new subscription to a paused object, the new subscription will not be paused. As a consequence thereof the object will no longer be in a paused state.