Project status report

A project status report.

Create a project status report

Create a new project status report for a project.

SecurityJWT

Request

Request Body schema: application/json

A JSON object containing project status report information.

subject	string <= 1000 characters The subject of the project status report.
comment required	string <= 50000 characters The comment of the project status report.
risks	string <= 50000 characters The risks of the project status report.
decisions	string <= 50000 characters The decisions of the project status report.
risk_impact	integer or null Default: null The risk impact of the project status report. 1 - Low 2 - Medium 3 - High 4 - Very high Enum: null 1 2 3 4
risk_probability	integer or null Default: null The risk probability of the project status report. 1 - Low 2 - Medium 3 - High 4 - Very high Enum: null 1 2 3 4
status_traffic_light	integer or null Default: null The status traffic light of the project status report. 1 - Green 2 - Yellow 3 - Red Enum: null 1 2 3
flagged	boolean Default: false The flagged flag for the project status report.
project required	string or integer The project of the project status report. Without a project the request will always return a `403 Forbidden` response.

Responses

201

Successful operation

422

Unprocessable Content

post/projectstatusreport

Request samples

Payload
curl

application/json

{"comment": "We see a risk in regard to further inventory reduction. Seasonal planning is supplemented to minimize this.",
"flagged": true,
"project": "3768a155ad95449839a74880d633c10ad48f67c1"
}

Response samples

application/json

{"success": true,
"hash": "10a518b32bde9ca903810dcafa01cf2981704817",
"data": {"id": 2754,
"hash": "1ee82b704f83af3aec73744e83dd0613695736b9",
"subject": "",
"comment": "We see a risk in regard to further inventory reduction. Seasonal planning is supplemented to minimize this.",
"risks": "",
"decisions": "",
"risk_impact": null,
"risk_probability": null,
"status_traffic_light": null,
"data": {"project_budgeting_effect_traffic_lights": [{"percent": 61,
"count": 22
},
{"percent": 14,
"count": 5
},
{"percent": 25,
"count": 9
}
],
"project_activity_start_time_traffic_lights": [{"percent": 24,
"count": 10
},
{"percent": 12,
"count": 5
},
{"percent": 63,
"count": 26
}
],
"project_activity_end_time_traffic_lights": [{"percent": 24,
"count": 10
},
{"percent": 15,
"count": 6
},
{"percent": 61,
"count": 25
}
]
},
"solved_time": null,
"flagged": true,
"created_time": "2022-05-27T10:38:37.000000Z",
"modified_time": "2022-05-27T10:38:37.000000Z",
"modified_user_time": "2022-05-27T10:38:37.000000Z",
"umask": 4,
"status": 0,
"model": "ProjectStatusReport",
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-25T09:02:43.000000Z",
"modified_user_time": "2022-05-25T09:02:43.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-25T09:02:43.000000Z",
"modified_user_time": "2022-05-25T09:02:43.000000Z",
"model": "User"
}
},
"timestamp": 1653472490807
}

Get all project status reports

Get all project status reports of the authenticated hub.

Since there are different maximum lengths for URLs in different browsers, there is also a filter route that can work with an unlimited number of body parameters as an alternative to this index route. The filter route accepts the same parameters and returns the same response as this index route.

SecurityJWT

Request

query Parameters

project	string or integer Filter the project status report list for a project.
program	string or integer Filter the project status report list for a program.
tags	Array of strings or integers Filter the project status report list for measure tags.
workflow_phases	Array of strings or integers Filter the project status report list for measure workflow phases.
responsible_users	Array of strings or integers Filter the project status report list for measure responsible users.
strategic_users	Array of strings or integers Filter the project status report list for measure strategic users.
flagged	boolean Filter the project status report list for flagged project status reports.
status	integer Filter the project status report list for project status report status. 0 - Open 1 - Solved Enum: 0 1
umask	integer Filter the project status report for the minimum permission of the authenticated user. 2 - Write 3 - Admin 4 - Owner Enum: 2 3 4
created_user	string or integer Filter the project status report list for a created user.
modified_user	string or integer Filter the project status report list for a modified user.
page	integer Default: 1 The page number of the response.

Responses

200

Successful operation

422

Unprocessable Content

get/projectstatusreport

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "a205fa564cc639fc20c9399b7082150e09003ad0",
"data": [{"id": 1,
"hash": "1ee82b704f83af3aec73744e83dd0613695736b9",
"subject": "",
"comment": "We see a risk in regard to further inventory reduction. Seasonal planning is supplemented to minimize this.",
"risks": "",
"decisions": "",
"risk_impact": null,
"risk_probability": null,
"status_traffic_light": null,
"data": {"project_budgeting_effect_traffic_lights": [{"percent": 61,
"count": 22
},
{"percent": 14,
"count": 5
},
{"percent": 25,
"count": 9
}
],
"project_activity_start_time_traffic_lights": [{"percent": 24,
"count": 10
},
{"percent": 12,
"count": 5
},
{"percent": 63,
"count": 26
}
],
"project_activity_end_time_traffic_lights": [{"percent": 24,
"count": 10
},
{"percent": 15,
"count": 6
},
{"percent": 61,
"count": 25
}
]
},
"solved_time": null,
"flagged": false,
"created_time": "2022-05-27T10:38:37.000000Z",
"modified_time": "2022-05-27T10:38:37.000000Z",
"modified_user_time": "2022-05-27T10:38:37.000000Z",
"umask": 4,
"status": 0,
"model": "ProjectStatusReport",
"project": {"id": 1,
"hash": "3768a155ad95449839a74880d633c10ad48f67c1",
"name": "Phoenix",
"paused": false,
"locked": false,
"model": "Project",
"program": {"id": 1,
"hash": "d347f256577eb205313a6e112b8e44a4af45ecfa",
"name": "Airborne",
"model": "Program"
}
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
}
],
"meta": {"page": 1,
"first": 1,
"last": 1,
"total": 1,
"limit": 1000,
"pages": 1
},
"timestamp": 1653644713046
}

Get a project status report

Get a project status report.

SecurityJWT

Request

path Parameters

projectstatusreport

required

string or integer

The id/hash of the project status report.

Responses

200

Successful operation

404

Not Found

get/projectstatusreport/{projectstatusreport}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "22a758b175e4fce4b9509d2de87d6f8b26445e27",
"data": {"id": 1,
"hash": "1ee82b704f83af3aec73744e83dd0613695736b9",
"subject": "",
"comment": "We see a risk in regard to further inventory reduction. Seasonal planning is supplemented to minimize this.",
"risks": "",
"decisions": "",
"risk_impact": null,
"risk_probability": null,
"status_traffic_light": null,
"data": {"project_budgeting_effect_traffic_lights": [{"percent": 61,
"count": 22
},
{"percent": 14,
"count": 5
},
{"percent": 25,
"count": 9
}
],
"project_activity_start_time_traffic_lights": [{"percent": 24,
"count": 10
},
{"percent": 12,
"count": 5
},
{"percent": 63,
"count": 26
}
],
"project_activity_end_time_traffic_lights": [{"percent": 24,
"count": 10
},
{"percent": 15,
"count": 6
},
{"percent": 61,
"count": 25
}
]
},
"solved_time": null,
"flagged": true,
"created_time": "2022-05-27T10:38:37.000000Z",
"modified_time": "2022-05-27T10:38:37.000000Z",
"modified_user_time": "2022-05-27T10:38:37.000000Z",
"status": 0,
"model": "ProjectStatusReport",
"project": {"id": 1,
"hash": "3768a155ad95449839a74880d633c10ad48f67c1",
"name": "Phoenix",
"paused": false,
"locked": false,
"model": "Project",
"program": {"id": 1,
"hash": "d347f256577eb205313a6e112b8e44a4af45ecfa",
"name": "Airborne",
"model": "Program"
}
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1653648350026
}

Update a project status report

Update a project status report.

SecurityJWT

Request

path Parameters

projectstatusreport

required

string or integer

The id/hash of the project status report.

Request Body schema: application/json

A JSON object containing project status report information.

subject	string <= 1000 characters The project status report subject.
comment	string <= 50000 characters The project status report comment.
risks	string <= 50000 characters The project status report risks.
decisions	string <= 50000 characters The project status report decisions.
risk_impact	integer or null The risk impact of the project status report. 1 - Low 2 - Medium 3 - High 4 - Very high Enum: null 1 2 3 4
risk_probability	integer or null The risk probability of the project status report. 1 - Low 2 - Medium 3 - High 4 - Very high Enum: null 1 2 3 4
status_traffic_light	integer or null The status traffic light of the project status report. 1 - Green 2 - Yellow 3 - Red Enum: null 1 2 3
flagged	boolean The flagged flag for the project status report.
solved	boolean The solved flag for the project status report.

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

put/projectstatusreport/{projectstatusreport}

Request samples

Payload
curl

application/json

{"flagged": false,
"solved": true
}

Response samples

application/json

{"success": true,
"hash": "91a9fb9006dca581f8b818b855ca7fd7d7c8c178",
"data": {"id": 1,
"hash": "1ee82b704f83af3aec73744e83dd0613695736b9",
"subject": "",
"comment": "We see a risk in regard to further inventory reduction. Seasonal planning is supplemented to minimize this.",
"risks": "",
"decisions": "",
"risk_impact": null,
"risk_probability": null,
"status_traffic_light": null,
"data": {"project_budgeting_effect_traffic_lights": [{"percent": 61,
"count": 22
},
{"percent": 14,
"count": 5
},
{"percent": 25,
"count": 9
}
],
"project_activity_start_time_traffic_lights": [{"percent": 24,
"count": 10
},
{"percent": 12,
"count": 5
},
{"percent": 63,
"count": 26
}
],
"project_activity_end_time_traffic_lights": [{"percent": 24,
"count": 10
},
{"percent": 15,
"count": 6
},
{"percent": 61,
"count": 25
}
]
},
"solved_time": "2022-05-27T10:50:25.000000Z",
"flagged": false,
"created_time": "2022-05-27T10:38:37.000000Z",
"modified_time": "2022-05-27T10:50:25.000000Z",
"modified_user_time": "2022-05-27T10:50:25.000000Z",
"status": 1,
"model": "ProjectStatusReport",
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-25T09:02:43.000000Z",
"modified_user_time": "2022-05-25T09:02:43.000000Z",
"model": "User"
}
},
"timestamp": 1653472490807
}

Delete a project status report

Delete a project status report.

SecurityJWT

Request

path Parameters

projectstatusreport

required

string or integer

The id/hash of the project status report.

Responses

200

Successful operation

404

Not Found

delete/projectstatusreport/{projectstatusreport}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": { },
"timestamp": 1656688107590
}

Restore a project status report

Restore a project status report.

SecurityJWT

Request

path Parameters

projectstatusreport

required

string or integer

The id/hash of the project status report.

Responses

200

Successful operation

404

Not Found

put/projectstatusreport/{projectstatusreport}/restore

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": { },
"timestamp": 1656688308753
}

Filter all project status reports

Alternative to the index route, since there are different maximum lengths for URLs in different browsers. The filter route accepts the same parameters and returns the same response as the index route.

SecurityJWT

post/projectstatusreport/filter

Request samples

curl

➔ Next to Project workflow