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 new measure package.

description
string <= 35000 characters

The description of the new measure package.

targets
string <= 35000 characters

The targets of the new measure package.

assumptions
string <= 35000 characters

The assumptions of the new measure package.

miscellaneous
string <= 35000 characters

The miscellaneous of the new measure package.

project_hash
required
string

The parent project of the new measure package.

budgeting_item_id
integer or null >= 1

The budgeting item of the new 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_id
integer or null >= 1

The responsible user of the new measure package.

Responses
201

Successful operation

404

Not Found

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_hash": "583bf59445f18e7bf566020aa8134ddfa7c79113",
  • "responsible_user_id": 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 an umask.

  • 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.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

get/measurepackage
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "1772cae9611560f58f11e8d6d34cfb79b67135ed",
  • "data": [
    ],
  • "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 <= 35000 characters

The measure package description.

targets
string <= 35000 characters

The measure package targets.

assumptions
string <= 35000 characters

The measure package assumptions.

miscellaneous
string <= 35000 characters

The measure package assumptions.

budgeting_item_id
integer or null >= 1

The measure package budgeting item id.

budgeting_item_inheritance
boolean
Default: false

The budgeting item inheritance flag of the budgeting item.

This flag sets the budgeting item to the selected budgeting item for all children of the package.

responsible_user_id
integer or null >= 1

The measure package responsible user id.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/measurepackage/{measurepackage}
Request samples
application/json
{
  • "targets": "Increase the working capital.",
  • "budgeting_item_id": 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 to a new parent project.

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_hash
required
string

The hash of the new parent project.

Responses
200

Successful operation

404

Not Found

post/measurepackage/{measurepackage}/copy
Request samples
application/json
{
  • "project_hash": "467587883ad2a3d5abc79085b1caf4ef80df3f68"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": [ ],
  • "timestamp": 1658913730749
}

Freeze a measure package

Freeze 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.

locked
boolean
Default: true

The locked flag for a 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.

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 a 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.

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 a 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.

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_hash
required
string

The hash of the new parent project.

Responses
200

Successful operation

404

Not Found

put/measurepackage/{measurepackage}/relocate
Request samples
application/json
{
  • "project_hash": "467587883ad2a3d5abc79085b1caf4ef80df3f68"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "ec46628083e9257e2edb711f45803b41ad4439a0",
  • "data": {
    },
  • "timestamp": 1658916543194
}

Restore a measure package

Restore 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

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 measure.

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.

measure_package_hash
required
string

The measure package to transform the measure to.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/measurepackage/{measurepackage}/transform
Request samples
application/json
{
  • "measure_package_hash": "3ba94b204bb540e79bb3abdd58f3648a74fbc06d"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "6d7ea153c8939373ee1f27575904142f1874c744",
  • "data": {
    },
  • "timestamp": 1658917515608
}