Workflow phase

A workflow phase.

Create a workflow phase

Create a new workflow phase for a workflow.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing workflow phase information.

name
required
string <= 1000 characters

The name of the new workflow phase.

summary
required
string <= 1000 characters

The summary of the new workflow phase.

umask
required
integer

The minimum user permission to start/revoke the new workflow phase.

  • 2 - Write
  • 3 - Admin
Enum: 2 3
workflow
required
string or integer

The workflow of the new workflow phase.

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

Responses
201

Successful operation

422

Unprocessable Content

post/workflowphase
Request samples
application/json
{
  • "name": "DOI3",
  • "summary": "Measure completed",
  • "umask": 3,
  • "workflow": "d016f0cee35b7dddc5b6691de4c4c083a96e6beb"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "dbfd5edba7afabc8e62562a32bb1e1d28ceaa426",
  • "data": {
    },
  • "timestamp": 1658156405332
}

Get all workflow phases

Get all workflow phases of the authenticated hub.

SecurityJWT
Request
query Parameters
measure
string or integer

Filter the workflow phase list for a measure.

measure_package
string or integer

Filter the workflow phase list for a measure package.

project
string or integer

Filter the workflow phase list for a project.

program
string or integer

Filter the workflow phase list for a program.

workflow
string or integer

Filter the workflow phase list for a workflow.

Responses
200

Successful operation

422

Unprocessable Content

get/workflowphase
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "a06322127ccc12deb6cdfdec3b59b47a4acbe587",
  • "data": [
    ],
  • "timestamp": 1658156900607
}

Get a workflow phase

Get a workflow phase.

SecurityJWT
Request
path Parameters
workflowphase
required
string or integer

The id/hash of the workflow phase.

Responses
200

Successful operation

404

Not Found

get/workflowphase/{workflowphase}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "dbfd5edba7afabc8e62562a32bb1e1d28ceaa426",
  • "data": {
    },
  • "timestamp": 1658157826082
}

Update a workflow phase

Update a workflow phase.

SecurityJWT
Request
path Parameters
workflowphase
required
string or integer

The id/hash of the workflow phase.

Request Body schema: application/json

A JSON object containing workflow phase information.

name
string <= 1000 characters

The name of the workflow phase.

summary
string <= 1000 characters

The summary of the workflow phase.

umask
integer

The minimum user permission to start/revoke the workflow phase.

  • 2 - Write
  • 3 - Admin
Enum: 2 3
Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/workflowphase/{workflowphase}
Request samples
application/json
{
  • "summary": "Effects realized",
  • "umask": 2
}
Response samples
application/json
{
  • "success": true,
  • "hash": "9bf52111e9df63d132aadf79300354ebb8fafc4c",
  • "data": {
    },
  • "timestamp": 1658158382366
}

Delete a workflow phase

Delete a workflow phase.

SecurityJWT
Request
path Parameters
workflowphase
required
string or integer

The id/hash of the workflow phase.

Responses
200

Successful operation

404

Not Found

delete/workflowphase/{workflowphase}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658158631530
}

Position a workflow phase

Position a workflow phase in relation to another workflow phase.

SecurityJWT
Request
path Parameters
workflowphase
required
string or integer

The id/hash of the workflow phase.

Request Body schema: application/json

A JSON object containing workflow phase information.

position
required
string

The position in relation to the workflow phase id.

Enum: "before" "after"
workflow_phase
required
string or integer

The workflow phase to position the given workflow phase to.

Both workflow phases must belong to the same workflow.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/workflowphase/{workflowphase}/position
Request samples
application/json
{
  • "position": "before",
  • "workflow_phase": 358
}
Response samples
application/json
{
  • "success": true,
  • "hash": "306a42e4ddf342cff5469327e3e905c5cd1e104d",
  • "data": {
    },
  • "timestamp": 1658159804838
}

Restore a workflow phase

Restore a workflow phase.

SecurityJWT
Request
path Parameters
workflowphase
required
string or integer

The id/hash of the workflow phase.

Responses
200

Successful operation

404

Not Found

put/workflowphase/{workflowphase}/restore
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1658160200126
}