Project

Represents an abstraction layer for a company or organizational unit, capturing key data such as the number of employees and platform-relevant information like the number of users and project status.

Version

2.0.0

OpenAPI version

3.0.0

Authentication

OAuth2

Security scheme type: oauth2

Flow type: password

Token URL: https://auth.4hse.com/realms/4hse/protocol/openid-connect/token

AccessToken

Security scheme type: apiKey

Query parameter name: access-token

Operations

index

POST

/v2/project/index

Returns a paginated and filterable list of projects. Use POST to allow complex filters via JSON payload.

Authorizations

• OAuth2
• AccessToken

Request Body

Parameters for searching projects

object

filter

object

project_id

The unique identifier of the project (primary key).

string format: uuid

name

The name of the project, with a maximum length of 50 characters.

string

<= 50 characters

description

A description of the project, if available.

string

nullable

status

The current status of the project (active, suspended, or deleted).

string

Allowed values: active suspended deleted

project_type

The type of the project (either ‘safety’ or ‘template’).

string

Allowed values: safety template

data

Additional data associated with the project in JSON format.

object

refund

The refund amount associated with the project.

integer

icon

The URL of the project’s icon, with a maximum length of 255 characters.

string format: url

<= 255 characters

npeople

The number of people associated with the project.

integer

subscription_id

The unique identifier of the subscription linked to the project.

string format: uuid

customer_id

The unique identifier of the customer associated with the project.

string format: uuid

partner_id

The unique identifier of the partner associated with the project.

string format: uuid

created_at

The date when the project was created.

string format: date

updated_at

The date when the project details were last updated.

string format: date

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "name": "Project 1",
    "project_type": "safety"
  },
  "per-page": 20,
  "page": 1,
  "sort": "name"
}

Responses

200

List of projects

Array<object>

object

project_id

The unique identifier of the project (primary key).

string format: uuid

name

The name of the project, with a maximum length of 50 characters.

string

<= 50 characters

description

A description of the project, if available.

string

nullable

status

The current status of the project (active, suspended, or deleted).

string

Allowed values: active suspended deleted

project_type

The type of the project (either ‘safety’ or ‘template’).

string

Allowed values: safety template

data

Additional data associated with the project in JSON format.

object

refund

The refund amount associated with the project.

integer

icon

The URL of the project’s icon, with a maximum length of 255 characters.

string format: url

<= 255 characters

npeople

The number of people associated with the project.

integer

subscription_id

The unique identifier of the subscription linked to the project.

string format: uuid

customer_id

The unique identifier of the customer associated with the project.

string format: uuid

partner_id

The unique identifier of the partner associated with the project.

string format: uuid

created_at

The date when the project was created.

string format: date

updated_at

The date when the project details were last updated.

string format: date

Example

{
  "project_id": "proj-1",
  "name": "Project 1",
  "description": "Safety project",
  "status": "active",
  "project_type": "safety",
  "customer_id": "cus-1",
  "partner_id": "par-1",
  "created_at": "2024-01-01",
  "updated_at": "2024-01-02"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

create

POST

/v2/project/create

Create a new project by providing the required details.

Authorizations

• OAuth2
• AccessToken

Request Body ^required

Project object to be created

object

project_id

The unique identifier of the project (primary key).

string format: uuid

name

The name of the project, with a maximum length of 50 characters.

string

<= 50 characters

description

A description of the project, if available.

string

nullable

status

The current status of the project (active, suspended, or deleted).

string

Allowed values: active suspended deleted

project_type

The type of the project (either ‘safety’ or ‘template’).

string

Allowed values: safety template

data

Additional data associated with the project in JSON format.

object

refund

The refund amount associated with the project.

integer

icon

The URL of the project’s icon, with a maximum length of 255 characters.

string format: url

<= 255 characters

npeople

The number of people associated with the project.

integer

subscription_id

The unique identifier of the subscription linked to the project.

string format: uuid

customer_id

The unique identifier of the customer associated with the project.

string format: uuid

partner_id

The unique identifier of the partner associated with the project.

string format: uuid

created_at

The date when the project was created.

string format: date

updated_at

The date when the project details were last updated.

string format: date

deleted_at

The date when the project was deleted (if applicable).

string format: date

Example

{
  "name": "Project 2",
  "description": "New project",
  "status": "active",
  "project_type": "safety",
  "customer_id": "cus-2",
  "partner_id": "par-2"
}

Responses

201

Project created successfully

object

project_id

The unique identifier of the project (primary key).

string format: uuid

name

The name of the project, with a maximum length of 50 characters.

string

<= 50 characters

description

A description of the project, if available.

string

nullable

status

The current status of the project (active, suspended, or deleted).

string

Allowed values: active suspended deleted

project_type

The type of the project (either ‘safety’ or ‘template’).

string

Allowed values: safety template

data

Additional data associated with the project in JSON format.

object

refund

The refund amount associated with the project.

integer

icon

The URL of the project’s icon, with a maximum length of 255 characters.

string format: url

<= 255 characters

npeople

The number of people associated with the project.

integer

subscription_id

The unique identifier of the subscription linked to the project.

string format: uuid

customer_id

The unique identifier of the customer associated with the project.

string format: uuid

partner_id

The unique identifier of the partner associated with the project.

string format: uuid

created_at

The date when the project was created.

string format: date

updated_at

The date when the project details were last updated.

string format: date

deleted_at

The date when the project was deleted (if applicable).

string format: date

Example

{
  "project_id": "proj-2",
  "name": "Project 2",
  "description": "New project",
  "status": "active",
  "project_type": "safety",
  "customer_id": "cus-2",
  "partner_id": "par-2"
}

view

GET

/v2/project/view/{id}

Retrieve a project by its unique ID.

Authorizations

• OAuth2
• AccessToken

Path Parameters

id

required

string format: uuid

ID of the project to retrieve

Responses

200

Project found

object

project_id

The unique identifier of the project (primary key).

string format: uuid

name

The name of the project, with a maximum length of 50 characters.

string

<= 50 characters

description

A description of the project, if available.

string

nullable

status

The current status of the project (active, suspended, or deleted).

string

Allowed values: active suspended deleted

project_type

The type of the project (either ‘safety’ or ‘template’).

string

Allowed values: safety template

data

Additional data associated with the project in JSON format.

object

refund

The refund amount associated with the project.

integer

icon

The URL of the project’s icon, with a maximum length of 255 characters.

string format: url

<= 255 characters

npeople

The number of people associated with the project.

integer

subscription_id

The unique identifier of the subscription linked to the project.

string format: uuid

customer_id

The unique identifier of the customer associated with the project.

string format: uuid

partner_id

The unique identifier of the partner associated with the project.

string format: uuid

created_at

The date when the project was created.

string format: date

updated_at

The date when the project details were last updated.

string format: date

Example

{
  "project_id": "proj-1",
  "name": "Project 1",
  "description": "Safety project",
  "status": "active",
  "project_type": "safety",
  "customer_id": "cus-1",
  "partner_id": "par-1",
  "created_at": "2024-01-01",
  "updated_at": "2024-01-02"
}

404

Project not found

delete

DELETE

/v2/project/delete/{id}

Delete a project by its unique ID. If force=true, all related entities will also be deleted.

Authorizations

• OAuth2
• AccessToken

Path Parameters

id

required

string format: uuid

ID of the project to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Project deleted successfully

400

If force=false, the operation is interrupted and the list of connected entities that will be deleted in case of confirmation (force=true) is returned

update

PUT

/v2/project/update/{id}

Update an existing project by its unique ID.

Authorizations

• OAuth2
• AccessToken

Path Parameters

id

required

string format: uuid

ID of the project to update

Request Body ^required

Project object with updated data

object

project_id

The unique identifier of the project (primary key).

string format: uuid

name

The name of the project, with a maximum length of 50 characters.

string

<= 50 characters

description

A description of the project, if available.

string

nullable

status

The current status of the project (active, suspended, or deleted).

string

Allowed values: active suspended deleted

project_type

The type of the project (either ‘safety’ or ‘template’).

string

Allowed values: safety template

data

Additional data associated with the project in JSON format.

object

refund

The refund amount associated with the project.

integer

icon

The URL of the project’s icon, with a maximum length of 255 characters.

string format: url

<= 255 characters

npeople

The number of people associated with the project.

integer

subscription_id

The unique identifier of the subscription linked to the project.

string format: uuid

customer_id

The unique identifier of the customer associated with the project.

string format: uuid

partner_id

The unique identifier of the partner associated with the project.

string format: uuid

created_at

The date when the project was created.

string format: date

updated_at

The date when the project details were last updated.

string format: date

deleted_at

The date when the project was deleted (if applicable).

string format: date

Example

{
  "name": "Updated Project",
  "status": "suspended"
}

Responses

200

Project updated successfully

object

project_id

The unique identifier of the project (primary key).

string format: uuid

name

The name of the project, with a maximum length of 50 characters.

string

<= 50 characters

description

A description of the project, if available.

string

nullable

status

The current status of the project (active, suspended, or deleted).

string

Allowed values: active suspended deleted

project_type

The type of the project (either ‘safety’ or ‘template’).

string

Allowed values: safety template

data

Additional data associated with the project in JSON format.

object

refund

The refund amount associated with the project.

integer

icon

The URL of the project’s icon, with a maximum length of 255 characters.

string format: url

<= 255 characters

npeople

The number of people associated with the project.

integer

subscription_id

The unique identifier of the subscription linked to the project.

string format: uuid

customer_id

The unique identifier of the customer associated with the project.

string format: uuid

partner_id

The unique identifier of the partner associated with the project.

string format: uuid

created_at

The date when the project was created.

string format: date

updated_at

The date when the project details were last updated.

string format: date

deleted_at

The date when the project was deleted (if applicable).

string format: date

Example

{
  "project_id": "proj-1",
  "name": "Updated Project",
  "status": "suspended"
}

404

Project not found