Projects
Projects are the main entry point in Squirro.Projects contain objects, which contain the data subscriptions. Projects give access to items that are contained in their index.
Methods
List Projects
GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects
Returns all projects in this tenant that the logged in user can access.
Parameters: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Returns: | Array of project objects. [ { "title": "Accounts", "id": "-q7bsMrxTlefD9CCmMdMXg", "seeder": "salesforce" }, { "title": "JavaScript", "id": "Uenn0QUiTEKxJWgg5NlRgw", "seeder": null } ] |
Create Project
POST https://squirro-endpoint/api/topic/v0/
(string: tenant)/projects
Create a new project. On creation a default object is created.
Parameters: |
|
---|---|
Form Parameters: |
|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Returns: | Object with project identifier. { "id": "pa-bX3aiTPOTaH7HV5JCgw" } |
Get Project
GET https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)
Returns information about a single project.
Parameters: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Returns: | Project object. { "id": "Uenn0QUiTEKxJWgg5NlRgw", "title": "JavaScript", "seeder": null, "type": null } |
Update Project
PUT https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_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/Uenn0QUiTEKxJWgg5NlRgw Host: topic-api.squirro.com Accept: application/json Content-Type: application/json {"title": "Web development"}
Delete Project
DELETE https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)
Parameters: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |
Reset Project
Resets different entities of a Squirro project based on boolean flags. This currently supports resetting the following three Squirro Entities
- Dashboards – Deletes all the dashboards in the Squirro project
- Elasticsearch Index – Deletes all the documents in the Elasticsearch index.
- Facets – Deletes all the facets. Please note that in order to do a reset of facets, a reset of elasticsearch is mandatory (in the same API call using the relevant boolean flags).
POST https://squirro-endpoint/api/topic/v0/(string: tenant)/projects/(id: project_id)/reset
Parameters: |
|
---|---|
JSON Data |
|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |