Salta ai contenuti
4HSE

Action

Questi contenuti non sono ancora disponibili nella tua lingua.

Represents preventive actions designed to reduce or eliminate workplace risks, protecting workers’ health and safety. Each action falls under a specific type:

  • training: safety training and awareness courses
  • health: medical surveillance and occupational health checks
  • maintenance: equipment or infrastructure maintenance
  • per: personal equipment requirements (PPE)
  • check: operational procedures and safety checklists
Version
2.0.0
OpenAPI version
3.0.0

Authentication

Sezione intitolata “ Authentication ”

OAuth2

Sezione intitolata “OAuth2 ”

Security scheme type: oauth2

Flow type: password

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

Flow type: refreshToken

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

AccessToken

Sezione intitolata “AccessToken ”

Security scheme type: apiKey

Query parameter name: access-token

Operations

Sezione intitolata “Operations”

index

Sezione intitolata “index”
POST
/v2/action/index

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

Authorizations

Sezione intitolata “Authorizations ”

Request Body

Sezione intitolata “Request Body ”

Parameters for searching actions

object
filter
object
action_id
string format: uuid
action_type
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
code
string
name
string
subtenant_id
string format: uuid
tenant_id
string format: uuid
office_name
string
project_name
string
project_type
string
per-page
integer
default: 100 >= 1
page
integer
default: 1 >= 1
sort
string
Allowed values: code name action_type office_name project_name
history
boolean
Example
{
  "filter": {
    "name": "Safety Training",
    "action_type": "TRAINING"
  },
  "per-page": 20,
  "page": 1,
  "sort": "name"
}

Responses

Sezione intitolata “ Responses ”
200
Sezione intitolata “200 ”

List of actions

Array<object>
object
action_id
string format: uuid
action_type
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
code
string
name
string
description
string
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
expire_interval
integer
manager
string format: json
assignee
string format: json
watcher
string format: json
data

Additional data

string format: json
subtenant_id
string format: uuid
tenant_id
string format: uuid
countSubscribed
integer
countValid
integer
countScheduled
integer
countToDo
integer
office_name
string
project_name
string
project_type
string
owned_active
boolean
parent_active
boolean
Example
{
  "action_id": "act-1",
  "action_type": "TRAINING",
  "code": "A001",
  "name": "Safety Training",
  "description": "Mandatory safety course",
  "validity_unit": "YEAR",
  "validity": 1,
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

Headers

Sezione intitolata “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

Sezione intitolata “create”
POST
/v2/action/create

Create a new action by providing the required details.

Authorizations

Sezione intitolata “Authorizations ”

Request Body required

Sezione intitolata “Request Body required ”

Action object to be created

object
action_id
required
string
action_type
required
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
code
string
name
required
string
description
string
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
expire_interval
integer
manager
string format: json
assignee
string format: json
watcher
string format: json
data
string
subtenant_id
required
string
tenant_id
required
string
Example
{
  "action_type": "TRAINING",
  "code": "A003",
  "name": "New Action",
  "description": "Description",
  "validity_unit": "MONTH",
  "validity": 6,
  "subtenant_id": "sub-3",
  "tenant_id": "ten-3"
}

Responses

Sezione intitolata “ Responses ”
201
Sezione intitolata “201 ”

Action created successfully

object
action_id
required
string
action_type
required
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
code
string
name
required
string
description
string
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
expire_interval
integer
manager
string format: json
assignee
string format: json
watcher
string format: json
data
string
subtenant_id
required
string
tenant_id
required
string
Example
{
  "action_id": "act-3",
  "action_type": "TRAINING",
  "code": "A003",
  "name": "New Action",
  "description": "Description",
  "validity_unit": "MONTH",
  "validity": 6,
  "subtenant_id": "sub-3",
  "tenant_id": "ten-3"
}

view

Sezione intitolata “view”
GET
/v2/action/view/{id}

Retrieve an action by its unique ID.

Authorizations

Sezione intitolata “Authorizations ”

Path Parameters

Sezione intitolata “Path Parameters ”
id
required
integer format: int64

ID of the action to retrieve

Responses

Sezione intitolata “ Responses ”
200
Sezione intitolata “200 ”

Action found

object
action_id
string format: uuid
action_type
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
code
string
name
string
description
string
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
expire_interval
integer
manager
string format: json
assignee
string format: json
watcher
string format: json
data

Additional data

string format: json
subtenant_id
string format: uuid
tenant_id
string format: uuid
countSubscribed
integer
countValid
integer
countScheduled
integer
countToDo
integer
office_name
string
project_name
string
project_type
string
owned_active
boolean
parent_active
boolean
Example
{
  "action_id": "act-1",
  "action_type": "TRAINING",
  "code": "A001",
  "name": "Safety Training",
  "description": "Mandatory safety course",
  "validity_unit": "YEAR",
  "validity": 1,
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}
404
Sezione intitolata “404 ”

Action not found

delete

Sezione intitolata “delete”
DELETE
/v2/action/delete/{id}

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

Authorizations

Sezione intitolata “Authorizations ”

Path Parameters

Sezione intitolata “Path Parameters ”
id
required
integer format: int64

ID of the action to delete

Query Parameters

Sezione intitolata “Query Parameters ”
force
boolean

Force the deletion of the entity and all related entities

Responses

Sezione intitolata “ Responses ”
204
Sezione intitolata “204 ”

Action deleted successfully

400
Sezione intitolata “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

Sezione intitolata “update”
PUT
/v2/action/update/{id}

Update an existing action by its unique ID.

Authorizations

Sezione intitolata “Authorizations ”

Path Parameters

Sezione intitolata “Path Parameters ”
id
required
integer format: int64

ID of the action to update

Request Body required

Sezione intitolata “Request Body required ”

Action object with updated data

object
action_id
required
string
action_type
required
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
code
string
name
required
string
description
string
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
expire_interval
integer
manager
string format: json
assignee
string format: json
watcher
string format: json
data
string
subtenant_id
required
string
tenant_id
required
string
Example
{
  "name": "Updated Training",
  "validity_unit": "YEAR",
  "validity": 2
}

Responses

Sezione intitolata “ Responses ”
200
Sezione intitolata “200 ”

Action updated successfully

object
action_id
required
string
action_type
required
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
code
string
name
required
string
description
string
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
expire_interval
integer
manager
string format: json
assignee
string format: json
watcher
string format: json
data
string
subtenant_id
required
string
tenant_id
required
string
Example
{
  "action_id": "act-1",
  "name": "Updated Training",
  "validity_unit": "YEAR",
  "validity": 2
}
404
Sezione intitolata “404 ”

Action not found