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
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": {
    },
  • "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
Response samples
application/json
{
  • "success": true,
  • "hash": "6d17d6014d7737fdc62b4a226b1b366b461858e3",
  • "data": [
    ],
  • "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
Response samples
application/json
{
  • "success": true,
  • "hash": "2811eb21ea199466231599542a8937dcd85715b2",
  • "data": {
    },
  • "timestamp": 1659026410405
}

Update a program

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
application/json
{
  • "description": "Another Airborne program",
  • "budgeting_id": 65,
  • "budgeting_item_id": 257
}
Response samples
application/json
{
  • "success": true,
  • "hash": "ae7333f854d3c5c80b5fbf937734132fde92a44e",
  • "data": {
    },
  • "timestamp": 1659347063385
}

Delete a program

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
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
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
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
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
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
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": [ ],
  • "timestamp": 1659362484783
}