Project
Projects can be queried using the regular query-endpoint.
Get project access
GET /api/project/{projectId}/rls
Scope: ADMIN
or DATA_MANAGER
Request
Path parameters
projectId
ID of project
Response
A list of users and departments and their access type:
[...
{
"accessType": "Read" | "Write",
"userID": string,
"user": object,
"departmentID": string,
"department": object
}
...]
Add or update access
POST /api/project/{projectId}/rls
Scope: ADMIN
or DATA_MANAGER_PROJECT_WRITE
Add or update access to a project and all associated entities.
Request
Path parameters
projectId
ID of project
Body parameters
accessType
EitherRead
orWrite
userID
ID of userdepartmentID
ID of department
Only userID
or departmentID
can be set in a request.
Remove access
DELETE /api/project/{projectId}/rls/{userIdOrDepartmentId}
Scope: ADMIN
or DATA_MANAGER_PROJECT_WRITE
Remove access for a user or department.
Request
Path parameters
projectId
ID of projectuserIdOrDepartment
ID of user or department to remove access for
Delete project
DELETE /api/project/{projectId}
Scope: ADMIN
or DATA_MANAGER_PROJECT_WRITE
Delete a project.
Request
Path parameters
projectId
ID of project
Get settings
GET /api/project/{projectId}/settings/{settingsName}
Scope: ADMIN
or DATA_MANAGER_PROJECT_WRITE
Get named settings for a project.
Request
Path parameters
projectId
ID of projectsettingsName
Name of settings
Response
A JSON object with the named setting for a project.
Add or update settings
POST /api/project/{projectId}/settings/{settingsName}
Scope: ADMIN
or DATA_MANAGER_PROJECT_WRITE
Insert or update named settings for a project.
Request
Path parameters
projectId
ID of projectsettingsName
Name of settings
Body
JSON object with settings.
Response
A JSON object with the named setting for a project.