...
| Table of Contents |
|---|
| outline | true |
|---|
| exclude | Methods |
|---|
|
List Objects
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: | - 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. | Code Block |
|---|
| [
{
"title": "object1", "id": "09MVue3gRqaTrTlO-aBgMQ", "type": null,
"seeder": "salesforce"
},
{
"title": "default", "id": "6Wr8nvPhRSaKif-Vah6iRg", "type": "default",
"seeder": null
}
] |
|
|---|
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: | - tenant – User tenant.
- project_id – Project identifier.
- start – Index of the first object to be returned, useful for pagination (default: 0).
- count – Number of objects returned (default 100).
|
|---|
| Headers: | See Common Headers. |
|---|
| Status Codes: | - 200 – Array of objects dictionaries is returned.
See also Common Status Codes. |
|---|
| Returns: | Array of objects. | Code Block |
|---|
| {
'start': 0,
'count': 100,
'objects': [
{
"title": "object1", "id": "09MVue3gRqaTrTlO-aBgMQ", "type": null,
"seeder": "salesforce"
},
{
"title": "default", "id": "6Wr8nvPhRSaKif-Vah6iRg", "type": "default",
"seeder": null
}
]
} |
Please note that the response in the example above has been cut to display only 2 objects out of otherwise 100 objects. |
|---|
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. | Code Block |
|---|
| {
"id": "8aGYz97eT-yVeunA_9Zzmg",
"project_id": "sDWhzUBBSA2KDltH2u0Yaw"
} |
|
|---|
POST https://squirro-endpoint/api/topic/v1/(string: tenant)/projects/(id: project_id)/objects
...