Objects are used to group the sources in a project. |
GET https://topic-api.squirro.com/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.
|
POST https://topic-api.squirro.com/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.
|
GET https://topic-api.squirro.com/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: |
Updated object.
|
PUT https://topic-api.squirro.com/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://topic-api.squirro.com/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. |