Program

A program.

Create a program

Create a new program.

SecurityJWT

Request

Request Body schema: application/json

A JSON object containing program information.

name required	string <= 1000 characters The name of the new program.
description	string <= 35000 characters The description of the new program.
targets	string <= 35000 characters The targets of the new program.
assumptions	string <= 35000 characters The assumptions of the new program.
miscellaneous	string <= 35000 characters The miscellaneous of the new program.
budgeting_id required	integer >= 1 The budgeting of the new program.
schedule_id required	integer >= 1 The schedule of the new program.
workflow_id required	integer >= 1 The workflow of the new program.
budgeting_item_id	integer or null >= 1 The budgeting item of the new program.
responsible_user_id	integer or null >= 1 The responsible user of the new program.

Responses

201

Successful operation

404

Not Found

422

Unprocessable Content

post/program

Request samples

Payload
curl

application/json

{"name": "Airborne",
"budgeting_id": 1,
"schedule_id": 1,
"workflow_id": 1,
"responsible_user_id": 1
}

Response samples

application/json

{"success": true,
"hash": "c722168c6b63fccaecc56760ff1e29aea06049e8",
"data": {"id": 24,
"hash": "88f728db91b0d4d3dee07153b0c053935cd8a5a6",
"name": "Airborne",
"description": "",
"targets": "",
"assumptions": "",
"miscellaneous": "",
"paused": false,
"locked": false,
"guarded": false,
"created_time": "2022-07-28T16:06:57.000000Z",
"modified_time": "2022-07-28T16:06:57.000000Z",
"modified_user_time": "2022-07-28T16:06:57.000000Z",
"umask": 3,
"model": "Program",
"budgeting_item": null,
"responsible_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1659024417993
}

Get all programs

Get all programs of the authenticated hub.

SecurityJWT

Request

query Parameters

affiliated	boolean Filter the program list for affiliated programs.
paused	boolean Filter the program list for paused programs.
locked	boolean Filter the program list for locked programs.
umask	integer Filter the program list for an umask. 2 - Write 3 - Admin 4 - Owner Enum: 2 3 4
responsible_user	string or integer Filter the program list for a responsible user.
created_user	string or integer Filter the program list for a created user.
modified_user	string or integer Filter the program list for a modified user.

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

get/program

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "6d17d6014d7737fdc62b4a226b1b366b461858e3",
"data": [{"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"description": "",
"targets": "",
"assumptions": "",
"miscellaneous": "",
"paused": false,
"locked": false,
"guarded": false,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:08.000000Z",
"modified_user_time": "2022-06-27T09:48:08.000000Z",
"projects_count": 1,
"umask": 4,
"model": "Program",
"program_schedule": {"id": 1,
"start_time_plan_min": "2022-06-07",
"start_time_plan_max": "2022-08-08",
"start_time_plan_activities_count": 20,
"start_time_actual_min": "2022-06-04",
"start_time_actual_max": "2022-08-08",
"start_time_actual_activities_count": 20,
"start_time_delta_ahead_sum": 5,
"start_time_delta_ahead_min": 2,
"start_time_delta_ahead_max": 3,
"start_time_delta_ahead_avg": 2.5,
"start_time_delta_ahead_activities_count": 2,
"start_time_delta_ahead_open_activities_count": 1,
"start_time_delta_ahead_running_activities_count": 0,
"start_time_delta_ahead_finished_activities_count": 1,
"start_time_delta_delayed_sum": 203,
"start_time_delta_delayed_min": 2,
"start_time_delta_delayed_max": 25,
"start_time_delta_delayed_avg": 12.6875,
"start_time_delta_delayed_activities_count": 16,
"start_time_delta_delayed_open_activities_count": 14,
"start_time_delta_delayed_running_activities_count": 1,
"start_time_delta_delayed_finished_activities_count": 1,
"start_time_score_sum": 18,
"start_time_score_activities_count": 20,
"start_time_score_achievement": 30.92593,
"start_time_traffic_light": 3,
"end_time_plan_min": "2022-06-22",
"end_time_plan_max": "2022-08-14",
"end_time_plan_activities_count": 20,
"end_time_actual_min": "2022-06-27",
"end_time_actual_max": "2022-08-17",
"end_time_actual_activities_count": 20,
"end_time_delta_ahead_sum": 6,
"end_time_delta_ahead_min": 3,
"end_time_delta_ahead_max": 3,
"end_time_delta_ahead_avg": 3,
"end_time_delta_ahead_activities_count": 2,
"end_time_delta_ahead_open_activities_count": 2,
"end_time_delta_ahead_running_activities_count": 0,
"end_time_delta_ahead_finished_activities_count": 0,
"end_time_delta_delayed_sum": 154,
"end_time_delta_delayed_min": 1,
"end_time_delta_delayed_max": 23,
"end_time_delta_delayed_avg": 9.05882,
"end_time_delta_delayed_activities_count": 17,
"end_time_delta_delayed_open_activities_count": 13,
"end_time_delta_delayed_running_activities_count": 1,
"end_time_delta_delayed_finished_activities_count": 3,
"end_time_score_sum": 22,
"end_time_score_activities_count": 20,
"end_time_score_achievement": 41.57408,
"end_time_traffic_light": 3,
"activities_count": 21,
"open_activities_count": 17,
"running_activities_count": 1,
"finished_activities_count": 3,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-07-28T00:00:31.000000Z",
"modified_user_time": "2022-07-19T14:05:27.000000Z",
"status": 1,
"open_activities_percentage": 81,
"running_activities_percentage": 5,
"finished_activities_percentage": 14,
"model": "ProgramSchedule"
},
"budgeting": {"id": 1,
"hash": "d42985eeb5bc6fdcc81539896f58f179899335b5",
"name": "Airborne (Default)",
"start_time": "2022-04-27",
"end_time": "2023-03-27",
"scaling": 2,
"offset": 0,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "Budgeting"
},
"schedule": {"id": 1,
"hash": "2bcdb7ee82d4b10eea0f1df400c79d93499ddffb",
"name": "Airborne (Default)",
"start_time_tolerance_yellow": 3,
"start_time_tolerance_red": 7,
"start_time_tolerance_started": 7,
"start_time_score_green": 3,
"start_time_score_yellow": 1,
"start_time_score_red": 0,
"start_time_threshold_yellow": 90,
"start_time_threshold_red": 65,
"end_time_tolerance_yellow": 3,
"end_time_tolerance_red": 7,
"end_time_tolerance_finished": 7,
"end_time_score_green": 3,
"end_time_score_yellow": 1,
"end_time_score_red": 0,
"end_time_threshold_yellow": 90,
"end_time_threshold_red": 65,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "Schedule"
},
"workflow": {"id": 1,
"hash": "36324e5b988caef7338b14f841f922956d433c17",
"name": "Airborne (Default)",
"start_time_tolerance_yellow": 3,
"start_time_tolerance_red": 7,
"start_time_tolerance_started": 7,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "Workflow"
},
"budgeting_item": {"id": 2,
"hash": "ec9d9b8f7e42230489f57058cbdc07244444d1fa",
"position": 2,
"operand": 2,
"name": "Material expenditures",
"unit": 1,
"factor": 1,
"decimals": 1,
"suffix": "",
"period_type": 1,
"aggregation_type_horizontal": 1,
"aggregation_type_vertical": 1,
"target_type": 2,
"threshold_yellow": 90,
"threshold_red": 70,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "BudgetingItem"
},
"responsible_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
{"id": 24,
"hash": "88f728db91b0d4d3dee07153b0c053935cd8a5a6",
"name": "Airborne",
"description": "",
"targets": "",
"assumptions": "",
"miscellaneous": "",
"paused": false,
"locked": false,
"guarded": false,
"created_time": "2022-07-28T16:06:57.000000Z",
"modified_time": "2022-07-28T16:06:57.000000Z",
"modified_user_time": "2022-07-28T16:06:57.000000Z",
"projects_count": 0,
"umask": 4,
"model": "Program",
"program_schedule": null,
"budgeting": {"id": 1,
"hash": "d42985eeb5bc6fdcc81539896f58f179899335b5",
"name": "Airborne (Default)",
"start_time": "2022-04-27",
"end_time": "2023-03-27",
"scaling": 2,
"offset": 0,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "Budgeting"
},
"schedule": {"id": 1,
"hash": "2bcdb7ee82d4b10eea0f1df400c79d93499ddffb",
"name": "Airborne (Default)",
"start_time_tolerance_yellow": 3,
"start_time_tolerance_red": 7,
"start_time_tolerance_started": 7,
"start_time_score_green": 3,
"start_time_score_yellow": 1,
"start_time_score_red": 0,
"start_time_threshold_yellow": 90,
"start_time_threshold_red": 65,
"end_time_tolerance_yellow": 3,
"end_time_tolerance_red": 7,
"end_time_tolerance_finished": 7,
"end_time_score_green": 3,
"end_time_score_yellow": 1,
"end_time_score_red": 0,
"end_time_threshold_yellow": 90,
"end_time_threshold_red": 65,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "Schedule"
},
"workflow": {"id": 1,
"hash": "36324e5b988caef7338b14f841f922956d433c17",
"name": "Airborne (Default)",
"start_time_tolerance_yellow": 3,
"start_time_tolerance_red": 7,
"start_time_tolerance_started": 7,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "Workflow"
},
"budgeting_item": null,
"responsible_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
}
],
"timestamp": 1659025523335
}

Get a program

Get a program.

SecurityJWT

Request

path Parameters

program

required

string or integer

The id/hash of the program.

Responses

200

Successful operation

404

Not Found

get/program/{program}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "2811eb21ea199466231599542a8937dcd85715b2",
"data": {"id": 1,
"hash": "1650600bd010a50897b50572382460965fed588a",
"name": "Airborne",
"description": "",
"targets": "",
"assumptions": "",
"miscellaneous": "",
"paused": false,
"locked": false,
"guarded": false,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:08.000000Z",
"modified_user_time": "2022-06-27T09:48:08.000000Z",
"umask": 4,
"model": "Program",
"budgeting_item": {"id": 2,
"hash": "ec9d9b8f7e42230489f57058cbdc07244444d1fa",
"position": 2,
"operand": 2,
"name": "Material expenditures",
"unit": 1,
"factor": 1,
"decimals": 1,
"suffix": "",
"period_type": 1,
"aggregation_type_horizontal": 1,
"aggregation_type_vertical": 1,
"target_type": 2,
"threshold_yellow": 90,
"threshold_red": 70,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "BudgetingItem"
},
"responsible_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1659026410405
}

Update a program

SecurityJWT

Request

path Parameters

program

required

string or integer

The id/hash of the program.

Request Body schema: application/json

A JSON object containing program information

name	string <= 1000 characters The program name.
description	string <= 35000 characters The program description.
targets	string <= 35000 characters The program targets.
assumptions	string <= 35000 characters The program assumptions.
miscellaneous	string <= 35000 characters The program assumptions.
budgeting_id	integer >= 1 The program budgeting.
schedule_id	integer >= 1 The program schedule.
workflow_id	integer >= 1 The program workflow.
budgeting_item_id	integer or null >= 1 The program 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 project, package and measure children of the program.
responsible_user_id	integer or null >= 1 The program responsible user id.

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

put/program/{program}

Request samples

Payload
curl

application/json

{"description": "Another Airborne program",
"budgeting_id": 65,
"budgeting_item_id": 257
}

Response samples

application/json

{"success": true,
"hash": "ae7333f854d3c5c80b5fbf937734132fde92a44e",
"data": {"id": 24,
"hash": "88f728db91b0d4d3dee07153b0c053935cd8a5a6",
"name": "Airborne",
"description": "Another Airborne program",
"targets": "",
"assumptions": "",
"miscellaneous": "",
"paused": false,
"locked": false,
"guarded": false,
"created_time": "2022-07-28T16:06:57.000000Z",
"modified_time": "2022-08-01T09:44:23.000000Z",
"modified_user_time": "2022-08-01T09:44:23.000000Z",
"model": "Program",
"budgeting_item": {"id": 257,
"hash": "a3c47e7ff2215923bd4a8e4a525554a3ffdc04a8",
"position": 2,
"operand": 2,
"name": "#2",
"unit": 1,
"factor": 0,
"decimals": 2,
"suffix": "",
"period_type": 1,
"aggregation_type_horizontal": 1,
"aggregation_type_vertical": 1,
"target_type": 1,
"threshold_yellow": 90,
"threshold_red": 70,
"created_time": "2022-07-13T13:50:44.000000Z",
"modified_time": "2022-07-13T13:50:44.000000Z",
"modified_user_time": "2022-07-13T13:50:44.000000Z",
"model": "BudgetingItem"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Titan",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1659347063385
}

Delete a program

SecurityJWT

Request

path Parameters

program

required

string or integer

The id/hash of the program.

Responses

200

Successful operation

404

Not Found

delete/program/{program}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": [ ],
"timestamp": 1659348474284
}

Copy a program

Copy a program within the hub.

SecurityJWT

Request

path Parameters

program

required

string or integer

The id/hash of the program.

Responses

200

Successful operation

404

Not Found

post/program/{program}/copy

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": [ ],
"timestamp": 1659362515770
}

Freeze a program

Freeze a program.

SecurityJWT

Request

path Parameters

program

required

string or integer

The id/hash of the program.

Request Body schema: application/json

A JSON object containing program information.

locked

boolean

Default: true

The locked flag for a program.

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

put/program/{program}/freeze

Request samples

Payload
curl

application/json

{"locked": true
}

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": [ ],
"timestamp": 1659363549003
}

Guard a program

Guard a program.

SecurityJWT

Request

path Parameters

program

required

string or integer

The id/hash of the program.

Request Body schema: application/json

A JSON object containing program information.

guarded

boolean

Default: true

The guarded flag for a program.

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

put/program/{program}/guard

Request samples

Payload
curl

application/json

{"guarded": true
}

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": [ ],
"timestamp": 1659363879029
}

Pause a program

Pause a program.

SecurityJWT

Request

path Parameters

program

required

string or integer

The id/hash of the program.

Request Body schema: application/json

A JSON object containing program information.

paused

boolean

Default: true

The paused flag for a program.

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

put/program/{program}/pause

Request samples

Payload
curl

application/json

{"paused": true
}

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": [ ],
"timestamp": 1659371112051
}

Restore a program

Restore a program.

SecurityJWT

Request

path Parameters

program

required

string or integer

The id/hash of the program.

Responses

200

Successful operation

404

Not Found

put/program/{program}/restore

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": [ ],
"timestamp": 1659362484783
}

➔ Next to Program budgeting effect