Program status report

A program status report.

Create a program status report

Create a new program status report for a program.

SecurityJWT

Request

Request Body schema: application/json

A JSON object containing program status report information.

subject	string <= 1000 characters The subject of the program status report.
comment required	string <= 50000 characters The comment of the program status report.
risks	string <= 50000 characters The risks of the program status report.
decisions	string <= 50000 characters The decisions of the program status report.
risk_impact	integer or null Default: null The risk impact of the program 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 program 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 program status report. 1 - Green 2 - Yellow 3 - Red Enum: null 1 2 3
flagged	boolean Default: false The flagged flag for the program status report.
program required	string or integer The program of the program status report. Without a program the request will always return a `403 Forbidden` response.

Responses

201

Successful operation

422

Unprocessable Content

post/programstatusreport

Request samples

Payload
curl

application/json

{"comment": "We see a risk in regard to further inventory reduction. Seasonal planning is supplemented to minimize this.",
"program": "1650600bd010a50897b50572382460965fed588a"
}

Response samples

application/json

{"success": true,
"hash": "17c8260c9282633fb372bdc4908ce3c65dc5b987",
"data": {"id": 3,
"hash": "da3d7fdf88daef2ae24eddbac386d0e3aa7e6a52",
"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-11-29T13:12:46.000000Z",
"modified_time": "2022-11-29T13:12:46.000000Z",
"modified_user_time": "2022-11-29T13:12:46.000000Z",
"umask": 2,
"status": 0,
"model": "ProgramStatusReport",
"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": 1669727566604
}

Get all program status reports

Get all program 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

program	string or integer Filter the program status report list for a program.
tags	Array of strings or integers Filter the program status report list for measure tags.
workflow_phases	Array of strings or integers Filter the program status report list for measure workflow phases.
responsible_users	Array of strings or integers Filter the program status report list for measure responsible users.
strategic_users	Array of strings or integers Filter the program status report list for measure strategic users.
flagged	boolean Filter the program status report list for flagged program status reports.
status	integer Filter the program status report list for program status report status. 0 - Open 1 - Solved Enum: 0 1
umask	integer Filter the program 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 program status report list for a created user.
modified_user	string or integer Filter the program status report list for a modified user.
page	integer Default: 1 The page number of the response.

Responses

200

Successful operation

get/programstatusreport

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "61ae18fcc6fa38bf1a621c363b5a25122989e5ae",
"data": [{"id": 3,
"hash": "da3d7fdf88daef2ae24eddbac386d0e3aa7e6a52",
"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-11-29T13:12:46.000000Z",
"modified_time": "2022-11-29T13:12:46.000000Z",
"modified_user_time": "2022-11-29T13:12:46.000000Z",
"umask": 1,
"status": 0,
"model": "ProgramStatusReport",
"program": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"paused": false,
"locked": false,
"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": 1669737374571
}

Get a program status report

Get a program status report.

SecurityJWT

Request

path Parameters

programstatusreport

required

string or integer

The id/hash of the program status report.

Responses

200

Successful operation

404

Not Found

get/programstatusreport/{programstatusreport}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "44cdfb332ec043cd63cff32ad20249f66768898f",
"data": {"id": 3,
"hash": "da3d7fdf88daef2ae24eddbac386d0e3aa7e6a52",
"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": {"program_budgeting_effect_traffic_lights": [{"percent": 29,
"count": 58
},
{"percent": 0,
"count": 0
},
{"percent": 71,
"count": 141
}
],
"program_activity_start_time_traffic_lights": [{"percent": 8,
"count": 1
},
{"percent": 0,
"count": 0
},
{"percent": 92,
"count": 11
}
],
"program_activity_end_time_traffic_lights": [{"percent": 8,
"count": 1
},
{"percent": 0,
"count": 0
},
{"percent": 92,
"count": 11
}
]
},
"solved_time": null,
"flagged": false,
"created_time": "2022-11-29T13:12:46.000000Z",
"modified_time": "2022-11-29T13:12:46.000000Z",
"modified_user_time": "2022-11-29T13:12:46.000000Z",
"umask": 1,
"status": 0,
"model": "ProgramStatusReport",
"program": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"paused": false,
"locked": false,
"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": 1669737778233
}

Update a program status report

Update a program status report.

SecurityJWT

Request

path Parameters

programstatusreport

required

string or integer

The id/hash of the program status report.

Request Body schema: application/json

A JSON object containing program status report information.

subject	string <= 1000 characters The program status report subject.
comment	string <= 50000 characters The program status report comment.
risks	string <= 50000 characters The program status report risks.
decisions	string <= 50000 characters The program status report decisions.
risk_impact	integer or null The risk impact of the program 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 program 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 program status report. 1 - Green 2 - Yellow 3 - Red Enum: null 1 2 3
flagged	boolean The flagged flag for the program status report.
solved	boolean The solved flag for the program status report.

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

put/programstatusreport/{programstatusreport}

Request samples

Payload
curl

application/json

{"solved": true
}

Response samples

application/json

{"success": true,
"hash": "1b62615f82cea304bc1f5264d650a486e92c50dc",
"data": {"id": 3,
"hash": "da3d7fdf88daef2ae24eddbac386d0e3aa7e6a52",
"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": {"program_budgeting_effect_traffic_lights": [{"percent": 29,
"count": 58
},
{"percent": 0,
"count": 0
},
{"percent": 71,
"count": 141
}
],
"program_activity_start_time_traffic_lights": [{"percent": 8,
"count": 1
},
{"percent": 0,
"count": 0
},
{"percent": 92,
"count": 11
}
],
"program_activity_end_time_traffic_lights": [{"percent": 8,
"count": 1
},
{"percent": 0,
"count": 0
},
{"percent": 92,
"count": 11
}
]
},
"solved_time": "2022-11-29T16:11:23.000000Z",
"flagged": false,
"created_time": "2022-11-29T13:12:46.000000Z",
"modified_time": "2022-11-29T16:11:23.000000Z",
"modified_user_time": "2022-11-29T16:11:23.000000Z",
"status": 1,
"model": "ProgramStatusReport",
"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": 1669738283164
}

Delete a program status report

Delete a program status report.

SecurityJWT

Request

path Parameters

programstatusreport

required

string or integer

The id/hash of the program status report.

Responses

200

Successful operation

404

Not Found

delete/programstatusreport/{programstatusreport}

Request samples

curl

Response samples

application/json

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

Restore a program status report

Restore a program status report.

SecurityJWT

Request

path Parameters

programstatusreport

required

string or integer

The id/hash of the program status report.

Responses

200

Successful operation

404

Not Found

put/programstatusreport/{programstatusreport}/restore

Request samples

curl

Response samples

application/json

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

Filter all program 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/programstatusreport/filter

Request samples

curl

➔ Next to Program workflow