API V1 Reference

Collaborators

The Collaborators API allows you to list the collaborators of a project, define new collaborators, retrieve, modify and delete existing ones.

A collaborator has a role. Possible roles are:

Name	Description
admin	The owner of a project is always admin of the project. He can add and remove collaborators
manager	Can add or remove collaborators
editor	Can edit data
reporter	Can only insert data (no update nor delete). (Don’t have to be a collaborator?)
reader	Can read data. (Don’t have to be a collaborator?)

A higher role always include also the lower ones.

Note

A collaborator of an project owned by a simple user can only be reporter or reader. Editor or manager role can only be set to an organization’s project.

List collaborators of a project

List all the collaborators of a project. Anyone logged in can use this endpoint.

GET /collaborators​/{projectid}​/

Parameters

Name	Type	In	Description
projectid	string	path	The project id (uuid)

Default response

Status: 200 OK

[
  {
    "collaborator": "albus",
    "role": "admin"
  },
  {
    "collaborator": "severus",
    "role": "manager"
  },

]

Forbidden

Status: 403 Forbidden

Define a new collaborator

Define a user as collaborator of a project.

POST /collaborators​/{projectid}​/

Parameters

Name	Type	In	Description
projectid	string	path	The project id (uuid)
collaborator	string	body	Required. The username of the new collaborator
role	string	body	Required. The role of the new collaborator (admin, manager, editor, reporter, reader)

... To be continued...