Projectroles REST API Documentation

This document contains the HTTP REST API documentation for the projectroles app. The provided API enpoints allow project and role operations through HTTP API calls in addition to the GUI.

API Usage

Usage of the REST API is detailed in this section. These instructions also apply to REST APIs in any other application within SODAR Core and are recommended as guidelines for API development in your SODAR Core based Django site.

Authentication

The API supports authentication through Knox authentication tokens as well as logging in using your SODAR username and password. Tokens are the recommended method for security purposes.

For token access, first retrieve your token using the Tokens App. Add the token in the HTTP_AUTHORIZATION header of your HTTP request as follows:

token 90c2483172515bc8f6d52fd608e5031db3fcdc06d5a83b24bec1688f39b72bcd

Versioning

The SODAR Core REST API uses accept header versioning. While specifying the desired API version in your HTTP requests is optional, it is strongly recommended. This ensures you will get the appropriate return data and avoid running into unexpected incompatibility issues.

To enable versioning, add the HTTP_ACCEPT header to your request with the following media type and version syntax. Replace the version number with your expected version.

application/vnd.bihealth.sodar-core+json; version=0.8.0

Note

The media type and version for internal SODAR Core apps are by design intended to be different to applications implemented in your Django site. Only use the aforementioned values when calling REST API views in projectroles or other applications installed from the django-sodar-core package.

Model Access and Permissions

Objects in SODAR Core API views are accessed through their sodar_uuid field. This is strongly recommended for views implemented in your Django site as well, as using a field such as pk may reveal internal database details to users as well as be incompatible if e.g. mirroring roles between multiple SODAR Core sites.

In the remainder of this document and other REST API documentation, “UUID” refers to the sodar_uuid field of each model unless otherwise noted.

For permissions the API uses the same rules which are in effect in the SODAR Core GUI. That means you need to have appropriate project access for each operation.

API Views

class projectroles.views_api.ProjectListAPIView(**kwargs)

List all projects and categories for which the requesting user has access.

URL: /project/api/list

Methods: GET

class projectroles.views_api.ProjectRetrieveAPIView(**kwargs)

Retrieve a project or category by its UUID.

URL: /project/api/retrieve/{Project.sodar_uuid}

Methods: GET

class projectroles.views_api.ProjectCreateAPIView(**kwargs)

Create a project or a category.

URL: /project/api/create

Methods: POST

Parameters:

• title: Project title (string)

• type: Project type (string, options: PROJECT or CATEGORY)

• parent: Parent category UUID (string)

• description: Projcet description (string, optional)

• readme: Project readme (string, optional, supports markdown)

• owner: User UUID of the project owner (string)

class projectroles.views_api.ProjectUpdateAPIView(**kwargs)

Update the metadata of a project or a category.

Note that the project owner can not be updated here. Instead, use the dedicated API view RoleAssignmentOwnerTransferAPIView.

The project type can not be updated once a project has been created. The parameter is still required for non-partial updates via the PUT method.

URL: /project/api/update/{Project.sodar_uuid}

Methods: PUT, PATCH

Parameters:

• title: Project title (string)

• type: Project type (string, can not be modified)

• parent: Parent category UUID (string)

• description: Projcet description (string, optional)

• readme: Project readme (string, optional, supports markdown)

• owner: User UUID of the project owner (string)

class projectroles.views_api.RoleAssignmentCreateAPIView(**kwargs)

Create a role assignment in a project.

URL: /project/api/roles/create/{Project.sodar_uuid}

Methods: POST

Parameters:

• role: Desired role for user (string, e.g. “project contributor”)

• user: User UUID (string)

class projectroles.views_api.RoleAssignmentUpdateAPIView(**kwargs)

Update the role assignment for a user in a project.

The user can not be changed in this API view.

URL: /project/api/roles/update/{RoleAssignment.sodar_uuid}

Methods: PUT, PATCH

Parameters:

• role: Desired role for user (string, e.g. “project contributor”)

• user: User UUID (string)

class projectroles.views_api.RoleAssignmentDestroyAPIView(**kwargs)

Destroy a role assignment.

The owner role can not be destroyed using this view.

URL: /project/api/roles/destroy/{RoleAssignment.sodar_uuid}

Methods: DELETE

class projectroles.views_api.RoleAssignmentOwnerTransferAPIView(**kwargs)

Trensfer project ownership to another user with a role in the project. Reassign a different role to the previous owner.

The new owner must already have a role assigned in the project.

URL: /project/api/roles/owner-transfer/{Project.sodar_uuid}

Methods: POST

Parameters:

• new_owner User UUID for new owner (string)

• old_owner_role Role for old owner (string. e.g. “project delegate”)

class projectroles.views_api.UserListAPIView(**kwargs)

List users in the system.

URL: /project/api/users/list

Methods: GET