Project
API for Project object
Method & Permission
API | GET | POST | PUT | PATCH | DELETE |
Project List | Admin, Project Admin*, Project Edit*, Project View* | Admin, Project Admin** | - | - | - |
Project Detail | Admin, Project Admin, Project Edit, Project View | - | - | Admin, Project Admin | - |
*Can only view/edit the project they are allowed to view/edit
** Project Admin can only create sub projects.
Project List
GET
{{ base_url }} /projects/project/list/{level}/{sid}/{serializer}/
Path Parameters
Name | Type | Description |
---|---|---|
level | string | organization |
sid | string | organization sid |
serializer | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Project List
POST
{{ base_url }} /projects/project/list/{level}/{sid}/{serializer}/
Path Parameters
Name | Type | Description |
---|---|---|
level | string | sid |
sid | string | organization sid |
serializer | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Request Body
Name | Type | Description |
---|---|---|
name | string | |
description | string | |
date_start | string | |
date_end | string | |
is_archived | boolean | |
open_to_organization | boolean | |
metadata | object |
Project Detail
GET
{{ base_url }} /projects/project/detail/{sid}/
Path Parameters
Name | Type | Description |
---|---|---|
sid | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Project Detail
PATCH
{{ base_url }} /projects/project/detail/{sid}/
Path Parameters
Name | Type | Description |
---|---|---|
sid | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Request Body
Name | Type | Description |
---|---|---|
name | string | |
description | string | |
date_start | string | |
date_end | string | |
is_archived | boolean | |
open_to_organization | boolean | |
metadata | object |
Last updated