GET /projects
Get project list
Request header
Name |
Type |
Mandatory fields |
Description |
Token |
String |
Yes |
Authentication credentials Token |
Parameter
Name |
Type |
Mandatory fields |
Description |
page |
String |
No |
Page number. 1 is set by default. |
limit |
String |
No |
The number of projects per page. 20 is set by default. |
Response
Name |
Type |
Mandatory fields |
Description |
page |
int |
Yes |
page number |
total |
int |
Yes |
total number of projects |
limit |
int |
Yes |
the number of projects per page |
projects |
array |
Yes |
project list |
∟ id |
int |
Yes |
project ID |
∟ name |
string |
Yes |
project name |
∟ code |
string |
Yes |
project code |
∟ model |
string |
Yes |
project model (scrum | waterfall) |
∟ budget |
int |
Yes |
project budget |
∟ budgetUnit |
string |
Yes |
project currency(CNY | USD) |
∟ parent |
int |
Yes |
affiliated program |
∟ begin |
date |
Yes |
estimated start time |
∟ end |
date |
Yes |
estimated end time |
∟ status |
string |
Yes |
project status(wait | doing | suspend | closed) |
∟ openedBy |
string |
Yes |
create by |
∟ openedDate |
datetime |
No |
create time |
∟ PM |
string |
No |
project manager |
∟ progress |
int |
No |
progress |
Response example
{
"page": 1,
"total": 2,
"limit": 20,
"projects": [
{
"id": 7,
"name": "business management system",
"code": "",
"model": "scrum",
"type": "project",
"budget": "0",
"budgetUnit": "CNY",
"parent": 6,
"begin": "2021-06-05",
"end": "2022-06-04",
"status": "doing",
"openedBy": "admin",
"openedDate": "2021-04-28T03:22:04Z",
"PM": "projectManager",
"progress": 33
},
{
"id": 8,
"name": "branch project",
"code": "bb",
"model": "scrum",
"type": "project",
"budget": "",
"budgetUnit": "CNY",
"parent": 6,
"begin": "2021-11-23",
"end": "2021-12-23",
"status": "wait",
"openedBy": "admin",
"openedDate": "2021-11-23T07:45:16Z",
"PM": "",
"progress": 0
}
]
}