Objects are used to group the sources in a project. |
Most projects don't need more than the default object which is added automatically on project creation.Methods
List Objects
GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects
Returns an array of all objects in the project.
Parameters: | - tenant – User tenant.
- project_id – Project identifier.
|
---|
Headers: | See Common Headers. |
---|
Status Codes: | - 200 – Array of objects dictionaries is returned.
See also Common Status Codes. |
---|
Returns: | Array of objects. [
{
"title": "object1", "id": "09MVue3gRqaTrTlO-aBgMQ", "type": null,
"seeder": "salesforce"
},
{
"title": "default", "id": "6Wr8nvPhRSaKif-Vah6iRg", "type": "default",
"seeder": null
}
] |
|
---|
Create Object
POST https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects
Parameters: | - tenant – User tenant.
- project_id – Project identifier.
|
---|
Form Parameters: | - owner_id – User identifier that owns the object.
- title – Descriptive title of the object (optional, any string, max. 200 characters).
- seeder – The seeder that owns this object (optional, any string, max. 20 characters).
|
---|
Headers: | See Common Headers. |
---|
Status Codes: | - 201 – Object was created.
See also Common Status Codes. |
---|
Returns: | Object with object and project identifier. {
"id": "8aGYz97eT-yVeunA_9Zzmg",
"project_id": "sDWhzUBBSA2KDltH2u0Yaw"
} |
|
---|
Get Object
GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects/(id: object_id)
Returns information about a single object.
Parameters: | - tenant – User tenant.
- project_id – Project identifier.
- object_id – Object identifier.
|
---|
Headers: | See Common Headers. |
---|
Status Codes: | - 200 – Object is returned.
See also Common Status Codes. |
---|
Returns: | Updated object. {
"id": "8aGYz97eT-yVeunA_9Zzmg",
"title": "Python",
"weight": 0.0,
"subscriptions": [
"wTXdjK6aRBqpqYRV8w9x0A", "NKrPIPewTy-HYN7lZrimGg"
],
"subscriptions_processed": true,
"seeder": null
} |
subscriptions_processed is set to true when all subscriptions are processed. A subscription is considered processed, when its first batch of items from is available for searching.
|
---|
Update Object
PUT https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/objects/(id: object_id)
Parameters: | - tenant – User tenant.
- project_id – Project identifier.
- object_id – Object identifier.
|
---|
JSON Data: | Data is passed in as a JSON object. Valid object keys: - title – Descriptive title of this object (max. 200 characters).
- is_ready (optional, boolean) – Seeders should set this to true as soon as it’s been sourced.
- subscribed_to (optional, boolean) – Used to mark a object as subscribed.
|
---|
Headers: | See Common Headers. |
---|
Status Codes: | - 200 – Array of objects dictionaries is returned.
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 Object
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.