Measure package

A measure package.

Create a measure package

Create a new measure package for a project.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing measure package information.

name
required
string <= 1000 characters

The name of the measure package.

description
string <= 50000 characters

The description of the measure package.

targets
string <= 50000 characters

The targets of the measure package.

assumptions
string <= 50000 characters

The assumptions of the measure package.

miscellaneous
string <= 50000 characters

The miscellaneous of the measure package.

project
required
string or integer

The project of the measure package.

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

budgeting_item
string or integer or null

The budgeting item of the measure package.

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

responsible_user
string or integer or null >= 1

The responsible user of the measure package.

Responses
201

Successful operation

422

Unprocessable Content

post/measurepackage
Request samples
application/json
{
  • "name": "Working Capital",
  • "description": "The working capital measures of stock reduction and turnover are aimed at a sustainable reduction of cash and cash equivalents tied up in current assets and should create the necessary resources for our company to be able to make important investments in the coming year under its own steam.",
  • "project": "583bf59445f18e7bf566020aa8134ddfa7c79113",
  • "responsible_user": 1
}
Response samples
application/json
{
  • "success": true,
  • "hash": "96ed12faacebf287b16298b43830d10c2cbd0864",
  • "data": {
    },
  • "timestamp": 1658850648398
}

Get all measure packages

Get all measure packages of the authenticated hub.

SecurityJWT
Request
query Parameters
project
string or integer

Filter the measure package list for a project.

program
string or integer

Filter the measure package list for a program.

affiliated
boolean

Filter the measure package list for affiliated measure packages.

paused
boolean

Filter the measure package list for paused measure packages.

locked
boolean

Filter the measure package list for locked measure packages.

umask
integer

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

created_user
string or integer

Filter the measure package list for a created user.

modified_user
string or integer

Filter the measure package list for a modified user.

page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

422

Unprocessable Content

get/measurepackage
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "1772cae9611560f58f11e8d6d34cfb79b67135ed",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1658907703299
}
Get a measure package
Get a measure package.


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


 
Responses 
200
Successful operation


404
Not Found


get/measurepackage/{measurepackage}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "54362f56f219cc65b5089e4327b5dbc9cffe70d5",
  • "data": {
    },
  • "timestamp": 1658907308398
}
Update a measure package
Update a measure package.


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


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


name
string  <= 1000 characters 
The measure package name.


 
description
string  <= 50000 characters 
The measure package description.


 
targets
string  <= 50000 characters 
The measure package targets.


 
assumptions
string  <= 50000 characters 
The measure package assumptions.


 
miscellaneous
string  <= 50000 characters 
The measure package assumptions.


 
budgeting_item
string or integer or null
The measure package budgeting item.


 
budgeting_item_inheritance
boolean
 Default:  false
The budgeting item inheritance flag for the budgeting item.
This flag sets the budgeting item to the selected budgeting item for all children of the package.
 
responsible_user
string or integer or null  >= 1 
The measure package responsible user.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/measurepackage/{measurepackage}
Request samples 
application/json
{
  • "targets": "Increase the working capital.",
  • "budgeting_item": 4
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "d705736c25c98737d93d81128a2c842911cb1ad6",
  • "data": {
    },
  • "timestamp": 1658908794717
}
Delete a measure package
Delete a measure package.


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


 
Responses 
200
Successful operation


404
Not Found


delete/measurepackage/{measurepackage}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658910223170
}
Copy a measure package
Copy a measure package into a project.
If a measure package 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 package into a project with a different budgeting or workflow, the corresponding information cannot be preserved and will be cleared.
The attached files of the measure package and all its measures are never included in the copy.
SecurityJWT 
Request 
path Parameters
measurepackage
required
string or integer
The id/hash of the measure package.


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


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


404
Not Found


post/measurepackage/{measurepackage}/copy
Request samples 
application/json
{
  • "project": "467587883ad2a3d5abc79085b1caf4ef80df3f68"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658913730749
}
Freeze a measure package
Freeze a measure package and all of its measures and activities.


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


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


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


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/measurepackage/{measurepackage}/freeze
Request samples 
application/json
{
  • "locked": true
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658914312875
}
Guard a measure package
Guard a measure package and all of its measures.


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


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


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


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/measurepackage/{measurepackage}/guard
Request samples 
application/json
{
  • "guarded": true
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658915171965
}
Pause a measure package
Pause a measure package and all of its measures and activities.


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


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


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


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/measurepackage/{measurepackage}/pause
Request samples 
application/json
{
  • "paused": true
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658916041714
}
Relocate a measure package
Relocate a measure package to a new parent project.
If a measure package 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 package into a project with a different budgeting or workflow, the corresponding information cannot be preserved and will be cleared.
SecurityJWT 
Request 
path Parameters
measurepackage
required
string or integer
The id/hash of the measure package.


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


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


404
Not Found


put/measurepackage/{measurepackage}/relocate
Request samples 
application/json
{
  • "project": "467587883ad2a3d5abc79085b1caf4ef80df3f68"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "ec46628083e9257e2edb711f45803b41ad4439a0",
  • "data": {
    },
  • "timestamp": 1658916543194
}
Restore a measure package
Restore a measure package and all elements that have been deleted with the emasure package.


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


 
Responses 
200
Successful operation


404
Not Found


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


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


One of:
measure_package
required
string or integer
The parent measure package in which the new measure will be created.
The measure package shall not be the given measure package.
 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/measurepackage/{measurepackage}/transform
Request samples 
application/json
{
  • "measure_package": "3ba94b204bb540e79bb3abdd58f3648a74fbc06d"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1681304973041
}
Export a measure package
Export a measure package for an export type.


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


 
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/measurepackage/{measurepackage}/{type}/export
Request samples 
application/json
{
  • "file_type": 3
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1653656536595
}
Report a measure package
Report a measure package for a report type.


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


 
type
required
string
The type of the report.


 Enum: "overview" "detail" "summary"  
Request Body schema: application/json
A JSON object containing 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.
 
responsible_users
Array of strings or integers
Filters the measures of the reportable element on the responsible user(s).
With this filter, only measures with the responsible user(s) are included in the report.
 
tags
Array of strings or integers
Filters the measures of the reportable element on the tag(s).
With this filter, only measures with the tag(s) are included in the report.
 
workflow_phases
Array of strings or integers
Filters the measures of the reportable element on the workflow phase(s).
With this filter, only measures with the workflow phase(s) are included in the report.
 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


post/measurepackage/{measurepackage}/{type}/report
Request samples 
application/json
{
  • "budgeting_item": 2,
  • "factor": 0,
  • "decimals": 0,
  • "period_type": 6,
  • "responsible_users": [
    ],
  • "scaling": 2,
  • "tags": [
    ],
  • "workflow_phases": [
    ]
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1653658573774
}
➔ Next to Measure package accounting