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 new project.

description
string <= 35000 characters

The description of the new project.

targets
string <= 35000 characters

The targets of the new project.

assumptions
string <= 35000 characters

The assumptions of the new project.

miscellaneous
string <= 35000 characters

The miscellaneous of the new project.

program_hash
required
string

The parent program of the new project.

budgeting_item_id
integer or null >= 1

The budgeting item of the new 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_id
integer or null >= 1

The responsible user of the new project.

Responses
201

Successful operation

404

Not Found

422

Unprocessable Content

post/project
Request samples
application/json
{
  • "name": "Project",
  • "description": "This is an example project.",
  • "program_hash": "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 an umask.

  • 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.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

get/project
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "e838373eb5f80ad0bee2e4a27222c8bce1258c8d",
  • "data": [
    ],
  • "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 <= 35000 characters

The project description.

targets
string <= 35000 characters

The project targets.

assumptions
string <= 35000 characters

The project assumptions.

miscellaneous
string <= 35000 characters

The project assumptions.

budgeting_item_id
integer or null >= 1

The project 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 package and measure children of the project.

responsible_user_id
integer or null >= 1

The project responsible user id.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/project/{project}
Request samples
application/json
{
  • "miscellaneous": "Some miscellaneous text.",
  • "responsible_user_id": 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 to a new parent program.

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_hash
required
string

The hash of the new parent program.

Responses
200

Successful operation

404

Not Found

post/project/{project}/copy
Request samples
application/json
{
  • "program_hash": "5319a62f26b5efb629f5b12457398c194b79d26f"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": [ ],
  • "timestamp": 1659005747130
}

Freeze a project

Freeze 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.

locked
boolean
Default: true

The locked flag for a 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.

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 a 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.

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 a 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.

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_hash
required
string

The hash of the new parent program.

Responses
200

Successful operation

404

Not Found

put/project/{project}/relocate
Request samples
application/json
{
  • "program_hash": "5319a62f26b5efb629f5b12457398c194b79d26f"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "c7153bba422eb1c256ee0f7bcd9e36f0171e5024",
  • "data": {
    },
  • "timestamp": 1659010275624
}

Restore a project

Restore a 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 <= 35000 characters

The description of the new project.

start_time
required
string <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The start time of the new project.

The date must be before or equal to the end time.

end_time
required
string <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The end time of the new project.

The date must be after or equal to the start time.

scaling
required
integer

The budgeting scaling type of the new project.

  • 1 - Weekly
  • 2 - Monthly
  • 3 - Quarterly
  • 4 - Yearly
Enum: 1 2 3 4
offset
required
integer [ 0 .. 11 ]

The offset for the financial year 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_id
required
integer >= 1

The project setup from which the project gets created.

responsible_user_id
integer or null >= 1

The responsible user of the new project.

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