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
level
string
organization
sid
string
organization sid
serializer
string
Headers
token
string
# serializer = name
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 2,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "Sample Project"
},
...
]
}
# serializer = list
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 2,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "Sample Project",
"parent": null,
"description": "This is a sample project created automatically. Please archive it on your production data.",
"date_start": "2020-02-10",
"date_end": null,
"is_archived": false,
"change_permission": true
},
...
]
}
# serializer = detail
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 2,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "Sample Project",
"parent": null,
"description": "This is a sample project created automatically. Please archive it on your production data.",
"date_start": "2020-02-10",
"date_end": null,
"should_receive_weekly_digest": true,
"open_to_organization": false,
"open_to_public": false,
"metadata": [
],
"is_archived": false,
"number_of_records": 0,
"updated_by": "xxx",
"date_updated": "2020-02-10T03:02:22.241376Z",
"date_created": "2020-02-10T03:02:22.240056Z",
"change_permission": true
},
...
]
}Project List
POST {{ base_url }} /projects/project/list/{level}/{sid}/{serializer}/
Path Parameters
level
string
sid
sid
string
organization sid
serializer
string
Headers
token
string
Request Body
name
string
description
string
date_start
string
date_end
string
is_archived
boolean
open_to_organization
boolean
metadata
object
{
"sid": "xxx",
"name": "Sample Project",
"parent": null,
"description": "This is a sample project created automatically. Please archive it on your production data.",
"date_start": "2020-02-10",
"date_end": null,
"should_receive_weekly_digest": true,
"open_to_organization": false,
"open_to_public": false,
"metadata": [
],
"is_archived": false,
"number_of_records": 0,
"updated_by": "xxx",
"date_updated": "2020-02-10T03:02:22.241376Z",
"date_created": "2020-02-10T03:02:22.240056Z",
"change_permission": true
}Project Detail
GET {{ base_url }} /projects/project/detail/{sid}/
Path Parameters
sid
string
Headers
token
string
{
"sid": "xxx",
"name": "Sample Project",
"parent": null,
"description": "This is a sample project created automatically. Please archive it on your production data.",
"date_start": "2020-02-10",
"date_end": null,
"should_receive_weekly_digest": true,
"open_to_organization": false,
"open_to_public": false,
"metadata": [
],
"is_archived": false,
"number_of_records": 0,
"updated_by": "xxx",
"date_updated": "2020-02-10T03:02:22.241376Z",
"date_created": "2020-02-10T03:02:22.240056Z",
"change_permission": true
}Project Detail
PATCH {{ base_url }} /projects/project/detail/{sid}/
Path Parameters
sid
string
Headers
token
string
Request Body
name
string
description
string
date_start
string
date_end
string
is_archived
boolean
open_to_organization
boolean
metadata
object
{
"sid": "xxx",
"name": "Sample Project",
"parent": null,
"description": "This is a sample project created automatically. Please archive it on your production data.",
"date_start": "2020-02-10",
"date_end": null,
"should_receive_weekly_digest": true,
"open_to_organization": false,
"open_to_public": false,
"metadata": [
],
"is_archived": false,
"number_of_records": 0,
"updated_by": "xxx",
"date_updated": "2020-02-10T03:02:22.241376Z",
"date_created": "2020-02-10T03:02:22.240056Z",
"change_permission": true
}Last updated