Project

API for Project object
Method & Permission
API
GET
POST
PUT
PATCH
DELETE
Project List
Admin, Project Admin*, Project Edit*, Project View*
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
get
Project List
{{ base_url }} /projects/project/list/{level}/{sid}/{serializer}/
Request
Response
Request
Path Parameters
level
required
string
organization
sid
required
string
organization sid
serializer
required
string
​
Headers
token
required
string
​
Response
200: OK
# 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
        },
        ...
    ]
}
post
Project List
{{ base_url }} /projects/project/list/{level}/{sid}/{serializer}/
Request
Response
Request
Path Parameters
level
required
string
sid
sid
required
string
organization sid
serializer
required
string
​
Headers
token
required
string
​
Form Data Parameters
name
required
string
​
description
optional
string
​
date_start
optional
string
​
date_end
optional
string
​
is_archived
optional
boolean
​
open_to_organization
optional
boolean
​
metadata
optional
object
​
Response
201: Created
{
    "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
}
get
Project Detail
{{ base_url }} /projects/project/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Response
200: OK
{
    "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
}
patch
Project Detail
{{ base_url }} /projects/project/detail/{sid}/
Request
Response
Request
Path Parameters
sid
required
string
​
Headers
token
required
string
​
Form Data Parameters
name
optional
string
​
description
optional
string
​
date_start
optional
string
​
date_end
optional
string
​
is_archived
optional
boolean
​
open_to_organization
optional
boolean
​
metadata
optional
object
​
Response
200: OK
{
    "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
}
​
Backup
Member
Last updated 8 months ago
API	GET	POST	PUT	PATCH	DELETE
Project List	Admin, Project Admin, Project Edit, Project View*	Admin	-	-	-
Project Detail	Admin, Project Admin, Project Edit, Project View	-	-	Admin, Project Admin	-
Project

Method & Permission

getProject List

postProject List

getProject Detail

patchProject Detail

get
Project List

post
Project List

get
Project Detail

patch
Project Detail
