Measure

A measure.

Create a measure

Create a new measure for a measure package.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing measure information.

name
required
string <= 1000 characters

The name of the measure.

description
string <= 50000 characters

The description of the measure.

targets
string <= 50000 characters

The targets of the measure.

assumptions
string <= 50000 characters

The assumptions of the measure.

miscellaneous
string <= 50000 characters

The miscellaneous of the measure.

tags
Array of strings or string <= 200

The names of the tags of the measure.

measure_package
required
string or integer

The measure package of the measure.

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

budgeting_item
string or integer or null

The budgeting item of the measure.

If no budgeting item is set, the new measure inherits the budgeting item from its parent measure package - if the parent has selected an item.

responsible_user
string or integer or null >= 1

The responsible user of the measure.

Responses
201

Successful operation

422

Unprocessable Content

post/measure
Request samples
application/json
{
  • "name": "ABC analysis",
  • "measure_package": "950870b767420110ddd95b169b6b105493556b36",
  • "budgeting_item": 2,
  • "responsible_user": 1,
  • "tags": [
    ]
}
Response samples
application/json
{
  • "success": true,
  • "hash": "75c21967eab2d8c562e5a54ead293f0774a2e336",
  • "data": {
    },
  • "timestamp": 1658323850458
}

Get all measures

Get all measures of the authenticated hub.

SecurityJWT
Request
query Parameters
measure_package
string or integer

Filter the measure list for a measure package.

project
string or integer

Filter the measure list for a project.

program
string or integer

Filter the measure list for a program.

paused
boolean

Filter the measure list for paused measures.

locked
boolean

Filter the measure list for locked measures.

umask
integer

Filter the measure list for the minimum permission of the authenticated user.

  • 2 - Write
  • 3 - Admin
  • 4 - Owner
Enum: 2 3 4
responsible_user
string or integer

Filter the measure list for a responsible user.

created_user
string or integer

Filter the measure list for a created user.

modified_user
string or integer

Filter the measure list for a modified user.

page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

422

Unprocessable Content

get/measure
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "c3064db73b99021ee1878eab97c22054bcd56a27",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1658324679058
}
Get a measure
Get a measure.


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


 
Responses 
200
Successful operation


404
Not Found


get/measure/{measure}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "257f407e1843d776176ac5d436493bdeb4188082",
  • "data": {
    },
  • "timestamp": 1658482390475
}
Update a measure
Update a measure.


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


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


name
string  <= 1000 characters 
The measure name.


 
description
string  <= 50000 characters 
The measure description.


 
targets
string  <= 50000 characters 
The measure targets.


 
assumptions
string  <= 50000 characters 
The measure assumptions.


 
miscellaneous
string  <= 50000 characters 
The measure assumptions.


 
tags
Array of strings or string  <= 200 
The names of the tags of the measure.
The complete stack of old and new tags of the measure must be passed.  To delete the tags of a measure an empty array must be passed. If the tags of the measure are not to be processed, the parameter can be omitted.
 
budgeting_item
string or integer or null
The measure budgeting item.


 
responsible_user
string or integer or null  >= 1 
The measure responsible user.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/measure/{measure}
Request samples 
application/json
{
  • "description": "Targets regarding the possible number of suppliers have been defined for each of our top purchasing groups. Tenders, trade fairs and other initiatives are to broaden the supplier base in the coming months and ensure better prices and high delivery reliability.",
  • "tags": [
    ],
  • "budgeting_item": 1
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "2f5ddac904736d6b665d6cc37d21b2dcc30021c5",
  • "data": {
    },
  • "timestamp": 1658483966995
}
Delete a measure
Delete a measure.


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


 
Responses 
200
Successful operation


404
Not Found


delete/measure/{measure}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658484727140
}
Copy a measure
Copy a measure into a measure package.
If a measure is copied within a shared budgeting, the budgeting item and the measure budgeting effects are maintained. When copying within a shared workflow, the settings of the measure workflow phases are also retained. If you copy a measure into a measure package with a different budgeting or workflow, the corresponding information cannot be preserved and will be cleared.
The attached files of the measure are never included in the copy.
SecurityJWT 
Request 
path Parameters
measure
required
string or integer
The id/hash of the measure.


 
Request Body schema: application/json
A JSON object containing measure information.


measure_package
required
string or integer
The new parent measure package of the measure.
Without a measure package the request will always return a 403 Forbidden response.
 
Responses 
200
Successful operation


404
Not Found


post/measure/{measure}/copy
Request samples 
application/json
{
  • "measure_package": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658490925820
}
Freeze a measure
Freeze a measure and all of its activities.


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


 
Request Body schema: application/json
A JSON object containing measure information.


locked
boolean
 Default:  true
The locked flag for the measure.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/measure/{measure}/freeze
Request samples 
application/json
{
  • "locked": true
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658491447698
}
Guard a measure
Guard a measure.


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


 
Request Body schema: application/json
A JSON object containing measure information.


guarded
boolean
 Default:  true
The guarded flag for the measure.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/measure/{measure}/guard
Request samples 
application/json
{
  • "guarded": true
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "57ba069142eec764916fe687e97bd1c4c033df78",
  • "data": {
    },
  • "timestamp": 1658494358423
}
Pause a measure
Pause a measure and all of its activities.


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


 
Request Body schema: application/json
A JSON object containing measure information.


paused
boolean
 Default:  true
The paused flag for the measure.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/measure/{measure}/pause
Request samples 
application/json
{
  • "paused": true
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658496201084
}
Relocate a measure
Relocate a measure to a new parent measure package.
If a measure is relocated within a shared budgeting, the budgeting item and the measure budgeting effects are maintained. When relocating within a shared workflow, the settings of the measure workflow phases are also retained. If you relocate a measure into a measure package with a different budgeting or workflow, the corresponding information cannot be preserved and will be cleared.
SecurityJWT 
Request 
path Parameters
measure
required
string or integer
The id/hash of the measure.


 
Request Body schema: application/json
A JSON object containing measure information.


measure_package
required
string or integer
The new parent measure package of the measure.
Without a measure package the request will always return a 403 Forbidden response.
 
Responses 
200
Successful operation


404
Not Found


put/measure/{measure}/relocate
Request samples 
application/json
{
  • "measure_package": "7c2638758ccd704cc9320e3495db3850d9c19a99"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "c8541d997166f2af20ef0acc4aef2ba83345e02e",
  • "data": {
    },
  • "timestamp": 1658497144915
}
Restore a measure
Restore a measure and all elements that have been deleted with the measure.


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


 
Responses 
200
Successful operation


404
Not Found


put/measure/{measure}/restore
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658490830361
}
Transform a measure
Transform a measure to a measure package or an activity.
With a project hash, the measure is transformed into a measure package in the given project. The measure attributes name, description, targets, assumptions and miscellaneous as well as the flags paused, locked and guarded are transferred to the new measure package. The responsible user and the budgeting item (if the new package stays within the same budgeting) are also adopted.
With a measure hash, the measure is transformed to an activity in the given measure. The measure attributes name and description as well as the flags paused and locked are transferred to the new activity. The responsible user of the measure is also adopted.
The measure will be deleted afterwards, but can be restored from the trash.
SecurityJWT 
Request 
path Parameters
measure
required
string or integer
The id/hash of the measure.


 
Request Body schema: application/json
A JSON object containing authentication information.


One of:
project
required
string or integer
The parent project in which the new measure package will be created.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/measure/{measure}/transform
Request samples 
application/json
{
  • "project": "583bf59445f18e7bf566020aa8134ddfa7c79113"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1681314734648
}
Export a measure
Export a measure for an export type.


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


 
type
required
string
The type of the export.


 Enum: "profile" "process" "schedule" "effects" "status"  
Request Body schema: application/json
A JSON object containing hub export information.


file_type
required
integer
The file type of the export.


    

  • 1 - csv
    • 

  • 2 - tsv
    • 

  • 3 - xls
    • 

  • 4 - xlsx
    • 



 Enum: 1 2 3 4  
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


post/measure/{measure}/{type}/export
Request samples 
application/json
{
  • "file_type": 3
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1653656536595
}
Report a measure
Report a measure for a report type.


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


 
type
required
string
The type of the report.


 Enum: "overview" "detail"  
Request Body schema: application/json
A JSON object containing measure report information.


file_type
integer
The file type of the report.


    

  • 1 - pptx
    • 



 Value: 1  
factor
integer or null
The factor of the report.
  • 0 - None
  • 1 - Thousand
  • 2 - Million
Without a factor, the factor selected for the elements in the budgeting item will be used to create the report.
 Enum: 0 1 2  
decimals
integer or null  [ 0 .. 5 ] 
The number of displayed decimals of the report.
Without a decimals, the decimals selected for the elements in the budgeting item will be used to create the report.
 
period_type
integer or null
The period type of the report.
  • 1 - Overall
  • 2 - Pre previous year
  • 3 - Previous year
  • 4 - Year to date
  • 5 - Actual year
  • 6 - Date to year
  • 7 - Upcoming year
  • 8 - Last year
  • 9 - Start to date
  • 10 - Rolling year to date
  • 11 - Pre previous period
  • 12 - Previous period
  • 13 - Actual period
  • 14 - Upcoming period
  • 15 - Date to rolling year
  • 16 - Date to end
  • 17 - Last period
Without a period type, the period type selected for the elements in the budgeting item will be used to create the report.
 Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17  
scaling
integer or null
The scaling of the report.
  • 1 - Weekly
  • 2 - Monthly
  • 3 - Quarterly
  • 4 - Yearly
The selected scaling must be equal to or smaller than the scaling of the selected budgeting for the reportable element. Without a scaling, the scaling of the selected budgeting for the reportable element is used to create the report.
 Enum: 1 2 3 4  
budgeting_item
string or integer or null
The budgeting item of the report.
Without a budgeting item, the budgeting item selected for each element will be used to create the report.
 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


post/measure/{measure}/{type}/report
Request samples 
application/json
{
  • "budgeting_item": 2,
  • "period_type": 6,
  • "scaling": 2
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1653658573774
}
➔ Next to Measure accounting