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.

comment
required
string <= 50000 characters

The comment of the new program status report.

risks
string <= 50000 characters

The risks of the new program status report.

decisions
string <= 50000 characters

The decisions of the new program status report.

flagged
boolean
Default: false

The flagged flag for the new program status report.

program
required
string or integer

The program of the new 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
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": {
    },
  • "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.

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.

Responses
200

Successful operation

get/programstatusreport
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "61ae18fcc6fa38bf1a621c363b5a25122989e5ae",
  • "data": [
    ],
  • "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
Response samples
application/json
{
  • "success": true,
  • "hash": "44cdfb332ec043cd63cff32ad20249f66768898f",
  • "data": {
    },
  • "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.

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.

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
application/json
{
  • "solved": true
}
Response samples
application/json
{
  • "success": true,
  • "hash": "1b62615f82cea304bc1f5264d650a486e92c50dc",
  • "data": {
    },
  • "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
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
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