Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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:
  • 200 – Array of project objects is returned.

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:
  • owner_id – User identifier that owns the project.
  • title – Descriptive title of the project (optional, string of max. 200 characters).
  • seeder – The seeder that owns this project (optional, string of max. 20 characters).
Headers:See Common Headers.
Status Codes:
  • 201 – Project was created.

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:
  • tenant – User tenant.
  • project_id – Project identifier.
Headers:See Common Headers.
Status Codes:
  • 200 – Project object is returned.

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:
  • tenant – User tenant.
  • project_id – Project identifier.
JSON Data:

Data is passed in as a JSON object.

Valid object keys:

  • title – Descriptive title of this project (max. 200 characters).
Headers:See Common Headers.
Status Codes:
  • 204 – Project was updated.

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:
  • tenant – User tenant.
  • project_id – Project identifier.
Headers:See Common Headers.
Status Codes:
  • 204 – Project was deleted.

See also Common Status Codes.

  • No labels