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

description
string <= 35000 characters

The description of the new measure.

targets
string <= 35000 characters

The targets of the new measure.

assumptions
string <= 35000 characters

The assumptions of the new measure.

miscellaneous
string <= 35000 characters

The miscellaneous of the new measure.

tags
Array of strings <= 200

The tags of the new measure.

measure_package_hash
required
string

The parent measure package for the new measure.

budgeting_item_id
integer or null >= 1

The budgeting item of the new measure.

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

responsible_user_id
integer or null >= 1

The responsible user of the new measure.

Responses
201

Successful operation

404

Not Found

422

Unprocessable Content

post/measure
Request samples
application/json
{
  • "name": "ABC analysis",
  • "measure_package_hash": "950870b767420110ddd95b169b6b105493556b36",
  • "budgeting_item_id": 2,
  • "responsible_user_id": 1
}
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 an umask.

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

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

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

The measure description.

targets
string <= 35000 characters

The measure targets.

assumptions
string <= 35000 characters

The measure assumptions.

miscellaneous
string <= 35000 characters

The measure assumptions.

tags
Array of strings <= 200

The tags of the measure.

budgeting_item_id
integer or null >= 1

The measure budgeting item id.

responsible_user_id
integer or null >= 1

The measure responsible user id.

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_id": 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 to a new parent measure package.

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

The hash of the new parent measure package.

Responses
200

Successful operation

404

Not Found

post/measure/{measure}/copy
Request samples
application/json
{
  • "measure_package_hash": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": [ ],
  • "timestamp": 1658490925820
}

Freeze a measure

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

locked
boolean
Default: true

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

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

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

The hash of the new parent measure package.

Responses
200

Successful operation

404

Not Found

put/measure/{measure}/relocate
Request samples
application/json
{
  • "measure_package_hash": "7c2638758ccd704cc9320e3495db3850d9c19a99"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "c8541d997166f2af20ef0acc4aef2ba83345e02e",
  • "data": {
    },
  • "timestamp": 1658497144915
}

Restore a measure

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

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:

Transform a measure to a measure package within the parent project.

any (Transform to measure packge)

Transform a measure to a measure package within the parent project.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/measure/{measure}/transform
Request samples
application/json
{
  • "measure_hash": "6e0770a9d5d6f1924b382a88138daf439ad7719f"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "d2c40724fd3c4260c3ca0260e693bef555a6920d",
  • "data": {
    },
  • "timestamp": 1658499641711
}