Projects are the main entry point in Squirro. |
GET https://topic-api.squirro.com/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.
|
POST https://topic-api.squirro.com/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.
|
GET https://topic-api.squirro.com/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.
|
PUT https://topic-api.squirro.com/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 https://topic-api.squirro.com/v0/(string: tenant)/projects/(id: project_id)
Parameters: |
|
---|---|
Headers: | See Common Headers. |
Status Codes: |
See also Common Status Codes. |