Measure workflow phase

A measure workflow phase.

Get all measure workflow phases

Get all measure workflow phases of the authenticated hub.

With a measure, all measure workflow phases of this measure are displayed. Otherwise, all measure workflow phases are shown grouped according to their measure.

SecurityJWT
Request
query Parameters
measure
string or integer

Filter the measure workflow phases list for a measure.

measure_package
string or integer

Filter the measure workflow phases list for a measure package.

project
string or integer

Filter the measure workflow phases list for a project.

program
string or integer

Filter the measure workflow phases list for a program.

workflow
string or integer

Filter the measure workflow phases list for a workflow.

page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

get/measureworkflowphase
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "90653272d8636b213d01b84606e73d5efeffa5e5",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1659523362176
}

Get a measure workflow phase

Get a measure workflow phase.

SecurityJWT
Request
path Parameters
measureworkflowphase
required
string or integer

The id/hash of the measure workflow phase.

Responses
200

Successful operation

404

Not Found

get/measureworkflowphase/{measureworkflowphase}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "3576c8136b3c9adb10dcd546b200059f246ae18e",
  • "data": {
    },
  • "timestamp": 1665745293767
}

Update a measure workflow phase

Update a measure workflow phase.

SecurityJWT
Request
path Parameters
measureworkflowphase
required
string or integer

The id/hash of the measure workflow phase.

Request Body schema: application/json

A JSON object containing measure workflow phase information

start_time_plan
string or null <date>

The measure workflow phase start time plan.

The date must match one of the following formats:

  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y

start_time_actual
string or null or string or null <date>

The measure workflow phase start time actual.

The date must match one of the following formats:

  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y

started
boolean

The started flag for the measure workflow phase.

The flag overwrites the start time actual of the measure workflow phase if it is not within the start time tolerance of the workflow.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/measureworkflowphase/{measureworkflowphase}
Request samples
application/json
{
  • "start_time_actual": "2022-07-17"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "dc17b65868217ade454736bb380c23a26e632048",
  • "data": {
    },
  • "timestamp": 1653472490807
}