Measure package status report

A measure package status report.

Create a measure package status report

Create a new measure package status report for a measure package.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing measure package status report information

subject
string <= 1000 characters

The subject of the measure package status report.

comment
required
string <= 50000 characters

The comment of the measure package status report.

risks
string <= 50000 characters

The risks of the measure package status report.

decisions
string <= 50000 characters

The decisions of the measure package status report.

risk_impact
integer or null
Default: null

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

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

Enum: null 1 2 3
flagged
boolean
Default: false

The flagged flag of the measure package status report.

measure_package
required
string or integer

The measure package of the measure package status report.

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

Responses
201

Successful operation

422

Unprocessable Content

post/measurepackagestatusreport
Request samples
application/json
{
  • "comment": "There are problems with future target quantities, especially for articles with seasonal fluctuations (see also measure Turnover).",
  • "flagged": true,
  • "measure_package": "cc4834e67e8517e2c061aa347a7c353a5414df10"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "348774f1b9d2203ed1381384242f595ae0760796",
  • "data": {
    },
  • "timestamp": 1653472490807
}

Get all measure package status reports

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

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

project
string or integer

Filter the measure package status report list for a project.

program
string or integer

Filter the measure package status report list for a program.

tags
Array of strings or integers

Filter the measure package status report list for measure tags.

workflow_phases
Array of strings or integers

Filter the measure package status report list for measure workflow phases.

responsible_users
Array of strings or integers

Filter the measure package status report list for measure responsible users.

strategic_users
Array of strings or integers

Filter the measure package status report list for measure strategic users.

flagged
boolean

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

status
integer

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

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

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

modified_user
string or integer

Filter the measure package 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/measurepackagestatusreport
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "a205fa564cc639fc20c9399b7082150e09003ad0",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1653644713046
}
Get a measure package status report
Get a measure package status report.


SecurityJWT 
Request 
path Parameters
measurepackagestatusreport
required
string or integer
The id/hash of the measure package status report.


 
Responses 
200
Successful operation


404
Not Found


get/measurepackagestatusreport/{measurepackagestatusreport}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "f15f469b01c8b84cbcd17874cc5c58dadd570343",
  • "data": {
    },
  • "timestamp": 1653645131203
}
Update a measure package status report
Update a measure package status report.


SecurityJWT 
Request 
path Parameters
measurepackagestatusreport
required
string or integer
The id/hash of the measure package status report.


 
Request Body schema: application/json
A JSON object containing measure package status report information


subject
string  <= 1000 characters 
The measure package status report subject.


 
comment
string  <= 50000 characters 
The measure package status report comment.


 
risks
string  <= 50000 characters 
The measure package status report risks.


 
decisions
string  <= 50000 characters 
The measure package status report decisions.


 
risk_impact
integer or null
The risk impact of the measure package 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 package 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 package status report.
  • 1 - Green
  • 2 - Yellow
  • 3 - Red
 Enum: null 1 2 3  
flagged
boolean
The flagged flag for the measure package status report.


 
solved
boolean
The solved flag for the measure package status report.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/measurepackagestatusreport/{measurepackagestatusreport}
Request samples 
application/json
{
  • "flagged": false,
  • "solved": true
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "91a9fb9006dca581f8b818b855ca7fd7d7c8c178",
  • "data": {
    },
  • "timestamp": 1653472490807
}
Delete a measure package status report
Delete a measure package status report.


SecurityJWT 
Request 
path Parameters
measurepackagestatusreport
required
string or integer
The id/hash of the measure package status report.


 
Responses 
200
Successful operation


404
Not Found


delete/measurepackagestatusreport/{measurepackagestatusreport}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1656686222930
}
Restore a measure package status report
Restore a measure package status report.


SecurityJWT 
Request 
path Parameters
measurepackagestatusreport
required
string or integer
The id/hash of the measure package status report.


 
Responses 
200
Successful operation


404
Not Found


put/measurepackagestatusreport/{measurepackagestatusreport}/restore
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1656686274268
}
Filter all measure package 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/measurepackagestatusreport/filter
Request samples 
➔ Next to Measure package workflow