Measure status report

A measure status report.

Create a measure status report

Create a new measure status report for a measure.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing measure status report information.

subject
string <= 1000 characters

The subject of the measure status report.

comment
required
string <= 50000 characters

The comment of the measure status report.

risks
string <= 50000 characters

The risks of the measure status report.

decisions
string <= 50000 characters

The decisions of the measure status report.

risk_impact
integer or null
Default: null

The risk impact of the measure 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 measure 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 measure status report.

  • 1 - Green
  • 2 - Yellow
  • 3 - Red

Enum: null 1 2 3
flagged
boolean
Default: false

The flagged flag of the measure status report.

measure
required
string or integer

The measure of the measure status report.

Without a measure the request will always return a 403 Forbidden response.

Responses
201

Successful operation

422

Unprocessable Content

post/measurestatusreport
Request samples
application/json
{
  • "comment": "The re-tendering of aluminium and the volume of fittings has taken place. Answers are largely outstanding.",
  • "flagged": true,
  • "measure": "264a21089e5720c8dddc67986d5bab827a75b58e"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "f900def2f6ad5b91ea95df1375724373d0d4fd3b",
  • "data": {
    },
  • "timestamp": 1653472490807
}

Get all measure status reports

Get all measure 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
measure
string or integer

Filter the measure status report list for a measure.

measure_package
string or integer

Filter the measure status report list for a measure package.

project
string or integer

Filter the measure status report list for a project.

program
string or integer

Filter the measure status report list for a program.

tags
Array of strings or integers

Filter the measure status report list for measure tags.

workflow_phases
Array of strings or integers

Filter the measure status report list for measure workflow phases.

responsible_users
Array of strings or integers

Filter the measure status report list for measure responsible users.

strategic_users
Array of strings or integers

Filter the measure status report list for measure strategic users.

flagged
boolean

Filter the measure status report list for flagged measure status reports.

status
integer

Filter the measure status report list for measure status report status.

  • 0 - Open
  • 1 - Solved
Enum: 0 1
umask
integer

Filter the measure status report list 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 measure status report list for a created user.

modified_user
string or integer

Filter the measure 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/measurestatusreport
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "be4887664ec41c95d29724f832e9b2e6da41091c",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1655993398494
}

Get a measure status report

Get a measure status report.

SecurityJWT
Request
path Parameters
measurestatusreport
required
string or integer

The id/hash of the measure status report.

Responses
200

Successful operation

404

Not Found

get/measurestatusreport/{measurestatusreport}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "06a4056ce2ef957656b1d32cba288de0d2b839db",
  • "data": {
    },
  • "timestamp": 1655993759040
}

Update a measure status report

Update a measure status report.

SecurityJWT
Request
path Parameters
measurestatusreport
required
string or integer

The id/hash of the measure status report.

Request Body schema: application/json

A JSON object containing measure status report information

subject
string <= 1000 characters

The measure status report subject.

comment
string <= 50000 characters

The measure status report comment.

risks
string <= 50000 characters

The measure status report risks.

decisions
string <= 50000 characters

The measure status report decisions.

risk_impact
integer or null

The risk impact of the measure 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 measure 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 measure status report.

  • 1 - Green
  • 2 - Yellow
  • 3 - Red

Enum: null 1 2 3
flagged
boolean

The flagged flag for the measure status report.

solved
boolean

The solved flag for the measure status report.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/measurestatusreport/{measurestatusreport}
Request samples
application/json
{
  • "flagged": false,
  • "solved": true
}
Response samples
application/json
{
  • "success": true,
  • "hash": "f900def2f6ad5b91ea95df1375724373d0d4fd3b",
  • "data": {
    },
  • "timestamp": 1655995125677
}

Delete a measure status report

Delete a measure status report.

SecurityJWT
Request
path Parameters
measurestatusreport
required
string or integer

The id/hash of the measure status report.

Responses
200

Successful operation

404

Not Found

delete/measurestatusreport/{measurestatusreport}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1656684563958
}

Restore a measure status report

Restore a measure status report.

SecurityJWT
Request
path Parameters
measurestatusreport
required
string or integer

The id/hash of the measure status report.

Responses
200

Successful operation

404

Not Found

put/measurestatusreport/{measurestatusreport}/restore
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1656685344231
}

Filter all measure 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/measurestatusreport/filter
Request samples