Project

A project.

Create a project

Create a new project for a program.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing project information.

name
required
string <= 1000 characters

The name of the project.

description
string <= 50000 characters

The description of the project.

targets
string <= 50000 characters

The targets of the project.

assumptions
string <= 50000 characters

The assumptions of the project.

miscellaneous
string <= 50000 characters

The miscellaneous of the project.

program
required
string or integer

The program of the project.

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

budgeting_item
string or integer or null

The budgeting item of the project.

If no budgeting item is set, the new project inherits the budgeting item from its parent program - if the parent has selected an item.

responsible_user
string or integer or null >= 1

The responsible user of the project.

Responses
201

Successful operation

422

Unprocessable Content

post/project
Request samples
application/json
{
  • "name": "Project",
  • "description": "This is an example project.",
  • "program": "1650600bd010a50897b50572382460965fed588a"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "525154017c10c64de66c5e221e48b59f1d2d1485",
  • "data": {
    },
  • "timestamp": 1659002477893
}

Get all projects

Get all projects of the authenticated hub.

SecurityJWT
Request
query Parameters
program
string or integer

Filter the project list for a program.

affiliated
boolean

Filter the project list for affiliated projects.

paused
boolean

Filter the project list for paused projects.

locked
boolean

Filter the project list for locked projects.

umask
integer

Filter the project 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 project list for a responsible user.

created_user
string or integer

Filter the project list for a created user.

modified_user
string or integer

Filter the project list for a modified user.

page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

422

Unprocessable Content

get/project
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "e838373eb5f80ad0bee2e4a27222c8bce1258c8d",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1659002940873
}
Get a project
Get a project.


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


 
Responses 
200
Successful operation


404
Not Found


get/project/{project}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "2bf71f88d5533639a2ca06a54f2c96e35426ec61",
  • "data": {
    },
  • "timestamp": 1659004262408
}
Update a project
Update a project.


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


 
Request Body schema: application/json
A JSON object containing project information.


name
string  <= 1000 characters 
The project name.


 
description
string  <= 50000 characters 
The project description.


 
targets
string  <= 50000 characters 
The project targets.


 
assumptions
string  <= 50000 characters 
The project assumptions.


 
miscellaneous
string  <= 50000 characters 
The project assumptions.


 
budgeting_item
string or integer or null
The project 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 package and measure children of the project.
 
responsible_user
string or integer or null  >= 1 
The project responsible user.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/project/{project}
Request samples 
application/json
{
  • "miscellaneous": "Some miscellaneous text.",
  • "responsible_user": 1
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "20d75362e72057fdc98c58ccee73258687e1673a",
  • "data": {
    },
  • "timestamp": 1659005160467
}
Delete a project
Delete a project.


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


 
Responses 
200
Successful operation


404
Not Found


delete/project/{project}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1659005453453
}
Copy a project
Copy a project into a program.
If a project is copied within a shared budgeting, the budgeting item and the measure budgeting effects are maintained. When copying within a shared workflow, the settings of the measure workflow phases are also retained. If you copy a project into a program with a different budgeting or workflow, the corresponding information cannot be preserved and will be cleared.
The attached files of the project and all its children are never included in the copy.
SecurityJWT 
Request 
path Parameters
project
required
string or integer
The id/hash of the project.


 
Request Body schema: application/json
A JSON object containing project information.


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


404
Not Found


post/project/{project}/copy
Request samples 
application/json
{
  • "program": "5319a62f26b5efb629f5b12457398c194b79d26f"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1659005747130
}
Freeze a project
Freeze a project and all of its measure packages, measures and activities.


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


 
Request Body schema: application/json
A JSON object containing project information.


locked
boolean
 Default:  true
The locked flag for the project.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/project/{project}/freeze
Request samples 
application/json
{
  • "locked": true
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1659006162922
}
Guard a project
Guard a project and all of its measure packages and measures.


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


 
Request Body schema: application/json
A JSON object containing project information.


guarded
boolean
 Default:  true
The guarded flag for the project.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/project/{project}/guard
Request samples 
application/json
{
  • "guarded": true
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1659006435869
}
Pause a project
Pause a project and all of its measure packages, measures and activities.


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


 
Request Body schema: application/json
A JSON object containing project information.


paused
boolean
 Default:  true
The paused flag for the project.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/project/{project}/pause
Request samples 
application/json
{
  • "paused": true
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1659009889862
}
Relocate a project
Relocate a project to a new parent program.
If a project is relocated within a shared budgeting, the budgeting item and the measure budgeting effects are maintained. When relocating within a shared workflow, the settings of the measure workflow phases are also retained. If you relocate a project into a program with a different budgeting or workflow, the corresponding information cannot be preserved and will be cleared.
SecurityJWT 
Request 
path Parameters
project
required
string or integer
The id/hash of the project.


 
Request Body schema: application/json
A JSON object containing project information.


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


404
Not Found


put/project/{project}/relocate
Request samples 
application/json
{
  • "program": "5319a62f26b5efb629f5b12457398c194b79d26f"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "c7153bba422eb1c256ee0f7bcd9e36f0171e5024",
  • "data": {
    },
  • "timestamp": 1659010275624
}
Restore a project
Restore a project and all elements that have been deleted with the project.


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


 
Responses 
200
Successful operation


404
Not Found


put/project/{project}/restore
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1659005559369
}
Create a project from a project setup
Create a new project for a project setup.


SecurityJWT 
Request 
Request Body schema: application/json
A JSON object containing project information.


One of:
Choose a project setup from which the project is created.


name
required
string  <= 1000 characters 
The name of the new project.


 
description
string  <= 50000 characters 
The description of the new project.


 
guarded
boolean or null
 Default:  true
The guarded flag of the new project.


 
start_time
required
string <date> 
The start time for the new budgeting of the new project.
The date must be before or equal to the end time. It must match one of the following formats:
  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y
 
end_time
required
string <date> 
The end time for the new budgeting of the new project.
The date must be after or equal to the start time. It must match one of the following formats:
  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y
 
scaling
required
integer
The budgeting scaling type for the new budgeting of the new project.


    

  • 1 - Weekly
    • 

  • 2 - Monthly
    • 

  • 3 - Quarterly
    • 

  • 4 - Yearly
    • 



 Enum: 1 2 3 4  
offset
required
integer  [ 0 .. 11 ] 
The starting month of the financial year for the new budgeting of the new project.


    

  • 0 - January
    • 

  • 1 - February
    • 

  • 2 - March
    • 

  • 3 - April
    • 

  • 4 - May
    • 

  • 5 - June
    • 

  • 6 - July
    • 

  • 7 - August
    • 

  • 8 - September
    • 

  • 9 - October
    • 

  • 10 - November
    • 

  • 11 - December
    • 



 
project_setup
required
string or integer
The project setup from which the project gets created.


 
responsible_user
string or integer or null  >= 1 
The user responsible for all tree items and activities created with the project setup.


 
Responses 
201
Successful operation


404
Not Found


422
Unprocessable Content


post/project/prepare
Request samples 
application/json
{
  • "name": "Phoenix",
  • "start_time": "2022-08-01",
  • "end_time": "2023-07-31",
  • "scaling": 2,
  • "offset": 7,
  • "project_setup": 3
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1659631290665
}
Transform a project
Transform a project to a program or a measure package.
With a project hash, the project is transformed to a measure package in the given project. The project attributes name, description, targets, assumptions and miscellaneous as well as the flags paused, locked and guarded are transferred to the new measure package. The responsible user and the budgeting item (if the new measure package stays within the same budgeting) are also adopted.
Without a project hash, the project is transformed into a program within the authenticated hub. The project attributes name, description, targets, assumptions and miscellaneous as well as the flags paused, locked and guarded are transferred to the new program. The responsible user and the budgeting item (if the new program stays within the same budgeting) are also adopted.
The project will be deleted afterwards, but can be restored from the trash.
SecurityJWT 
Request 
path Parameters
project
required
string or integer
The id/hash of the project.


 
Request Body schema: application/json
A JSON object containing authentication information.


One of:
Transform a project to a program within the authenticated hub.


any (Transform to program) 
 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/project/{project}/transform
Request samples 
application/json
{
  • "project": "583bf59445f18e7bf566020aa8134ddfa7c79113"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1681315002269
}
Export a project
Export a project for an export type.


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


 
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/project/{project}/{type}/export
Request samples 
application/json
{
  • "file_type": 3
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1653656536595
}
Report a project
Report a project for a report type.


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


 
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.
 
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/project/{project}/{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 Project accounting