Project

Last updated 7 months ago
API for Project object
get
Project List
{{ base_url }}
 /projects/project/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
​
sid
required
string
​
serializer
required
string
​
Headers
token
required
string
​
200: OK
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 1,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "xxx",
            "description": "xxx",
            "date_start": "2017-11-16",
            "date_end": null,
            "is_archived": false,
            "open_to_organization": false,
            "change_permission": true
        },
        ...
    ]
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
Wrong level - the provided level is not acceptable
post
Project List
{{ base_url }}
 /projects/project/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
​
sid
required
string
​
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
​
201: Created
{
    "sid": "xxx",
    "organization": 1,
    "name": "xxx",
    "description": "xxx",
    "date_start": "2017-11-16",
    "date_end": null,
    "is_archived": false,
    "open_to_organization": false,
    "metadata": [],
    "updated_by": 1,
    "date_updated": "2018-02-09T09:07:44.948941Z",
    "date_created": "2017-11-16T16:22:50.295079Z",
    "change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
Wrong level - the provided level is not acceptable
get
Project Detail
{{ base_url }}
 /projects/project/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
​
Headers
token
required
string
​
200: OK
{
    "sid": "xxx",
    "organization": 1,
    "name": "xxx",
    "description": "xxx",
    "date_start": "2017-11-16",
    "date_end": null,
    "is_archived": false,
    "open_to_organization": false,
    "metadata": [],
    "updated_by": 1,
    "date_updated": "2018-02-09T09:07:44.948941Z",
    "date_created": "2017-11-16T16:22:50.295079Z",
    "change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
patch
Project Detail
{{ base_url }}
 /projects/project/detail/{sid}/
Request
Response
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
​
200: OK
{
    "sid": "xxx",
    "organization": 1,
    "name": "xxx",
    "description": "xxx",
    "date_start": "2017-11-16",
    "date_end": null,
    "is_archived": false,
    "open_to_organization": false,
    "metadata": [],
    "updated_by": 1,
    "date_updated": "2018-02-09T09:07:44.948941Z",
    "date_created": "2017-11-16T16:22:50.295079Z",
    "change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
​
Backup
Project Member
Project

getProject List

postProject List

getProject Detail

patchProject Detail

get
Project List

post
Project List

get
Project Detail

patch
Project Detail
