Program

A program.

Create a program

Create a new program for a budgeting, a schedule and a workflow.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing program information.

name
required
string <= 1000 characters

The name of the program.

description
string <= 50000 characters

The description of the program.

targets
string <= 50000 characters

The targets of the program.

assumptions
string <= 50000 characters

The assumptions of the program.

miscellaneous
string <= 50000 characters

The miscellaneous of the program.

budgeting
required
string or integer

The budgeting of the program.

schedule
required
string or integer

The schedule of the program.

workflow
required
string or integer

The workflow of the program.

budgeting_item
string or integer or null

The budgeting item of the program.

responsible_user
string or integer or null >= 1

The responsible user of the program.

strategic_user
string or integer or null >= 1

The strategic user of the program.

Responses
201

Successful operation

422

Unprocessable Content

post/program
Request samples
application/json
{
  • "name": "Airborne",
  • "budgeting": 1,
  • "schedule": 1,
  • "workflow": 1,
  • "responsible_user": 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 the minimum permission of the authenticated user.

  • 2 - Write
  • 3 - Admin
  • 4 - Owner
Enum: 2 3 4
responsible_user
string or integer

Filter the program list for a responsible user.

strategic_user
string or integer

Filter the program list for a strategic 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.

page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

422

Unprocessable Content

get/program
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "6d17d6014d7737fdc62b4a226b1b366b461858e3",
  • "data": [
    ],
  • "meta": {
    },
  • "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  <= 50000 characters 
The program description.


 
targets
string  <= 50000 characters 
The program targets.


 
assumptions
string  <= 50000 characters 
The program assumptions.


 
miscellaneous
string  <= 50000 characters 
The program assumptions.


 
budgeting
string or integer
The program budgeting.


 
schedule
string or integer
The program schedule.


 
workflow
string or integer
The program workflow.


 
budgeting_item
string or integer or null
The program budgeting item.


 
budgeting_item_inheritance
boolean
 Default:  false
The budgeting item inheritance flag for 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
string or integer or null  >= 1 
The program responsible user.


 
strategic_user
string or integer or null  >= 1 
The program strategic user.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/program/{program}
Request samples 
application/json
{
  • "description": "Another Airborne program",
  • "budgeting": 65,
  • "budgeting_item": 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 authenticated hub.
A program is always copied within the budgeting, schedule and workflow. Accordingly, the set properties of the program and all its children are always retained.
The attached files of the program and all its children are never included in the copy.
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 and all of its projects, measure packages, measures and activities.


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 the 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 and all of its projects, measure packages and measures.


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 the 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 and all of its projects, measure packages, measures and activities.


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 the 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 and all elements that have been deleted with te 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
}
Transform a program
Transform a program to a project.
The program is transformed into a project in the given program. The program attributes name, description, targets, assumptions and miscellaneous as well as the flags paused, locked and guarded are transferred to the new project. The responsible user and the strategic user are also adopted. The budgeting item is only transferred if the new project remains within the same budgeting.
The program will be deleted afterwards, but can be restored from the trash.
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.


program
required
string or integer
The parent program in which the new project will be created.
Without a program the request will always return a 403 Forbidden response.
 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/program/{program}/transform
Request samples 
application/json
{
  • "program": "1650600bd010a50897b50572382460965fed588a"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1681315053025
}
Export a program
Export a program for an export type.


SecurityJWT 
Request 
path Parameters
program
required
string or integer
The id/hash of the program.


 
type
required
string
The type of the export.


 Enum: "profile" "process" "schedule" "effects" "status"  
Request Body schema: application/json
A JSON object containing hub export information.


file_type
required
integer
The file type of the export.


    

  • 1 - csv
    • 

  • 2 - tsv
    • 

  • 3 - xls
    • 

  • 4 - xlsx
    • 



 Enum: 1 2 3 4  
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


post/program/{program}/{type}/export
Request samples 
application/json
{
  • "file_type": 3
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1653656536595
}
Report a program
Report a program for a report type.


SecurityJWT 
Request 
path Parameters
program
required
string or integer
The id/hash of the program.


 
type
required
string
The type of the report.


 Enum: "overview" "detail" "summary"  
Request Body schema: application/json
A JSON object containing report information.


file_type
integer
The file type of the report.


    

  • 1 - pptx
    • 



 Value: 1  
factor
integer or null
The factor of the report.
  • 0 - None
  • 1 - Thousand
  • 2 - Million
Without a factor, the factor selected for the elements in the budgeting item will be used to create the report.
 Enum: 0 1 2  
decimals
integer or null  [ 0 .. 5 ] 
The number of displayed decimals of the report.
Without a decimals, the decimals selected for the elements in the budgeting item will be used to create the report.
 
period_type
integer or null
The period type of the report.
  • 1 - Overall
  • 2 - Pre previous year
  • 3 - Previous year
  • 4 - Year to date
  • 5 - Actual year
  • 6 - Date to year
  • 7 - Upcoming year
  • 8 - Last year
  • 9 - Start to date
  • 10 - Rolling year to date
  • 11 - Pre previous period
  • 12 - Previous period
  • 13 - Actual period
  • 14 - Upcoming period
  • 15 - Date to rolling year
  • 16 - Date to end
  • 17 - Last period
Without a period type, the period type selected for the elements in the budgeting item will be used to create the report.
 Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17  
scaling
integer or null
The scaling of the report.
  • 1 - Weekly
  • 2 - Monthly
  • 3 - Quarterly
  • 4 - Yearly
The selected scaling must be equal to or smaller than the scaling of the selected budgeting for the reportable element. Without a scaling, the scaling of the selected budgeting for the reportable element is used to create the report.
 Enum: 1 2 3 4  
budgeting_item
string or integer or null
The budgeting item of the report.
Without a budgeting item, the budgeting item selected for each element will be used to create the report.
 
responsible_users
Array of strings or integers
Filters the measures of the reportable element on the responsible user(s).
With this filter, only measures with the responsible user(s) are included in the report.
 
strategic_users
Array of strings or integers
Filters the measures of the reportable element on the strategic user(s).
With this filter, only measures with the strategic user(s) are included in the report.
 
tags
Array of strings or integers
Filters the measures of the reportable element on the tag(s).
With this filter, only measures with the tag(s) are included in the report.
 
workflow_phases
Array of strings or integers
Filters the measures of the reportable element on the workflow phase(s).
With this filter, only measures with the workflow phase(s) are included in the report.
 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


post/program/{program}/{type}/report
Request samples 
application/json
{
  • "budgeting_item": 2,
  • "factor": 0,
  • "decimals": 0,
  • "period_type": 6,
  • "responsible_users": [
    ],
  • "scaling": 2,
  • "tags": [
    ],
  • "workflow_phases": [
    ]
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1653658573774
}
➔ Next to Program accounting