Skip to content
4HSE

ActionSubscription

Manage action subscriptions, which represent the assignment of actions (such as training, maintenance, or health checks) to resources (people, materials, etc.).
You can create, update, delete, and search for action subscriptions with advanced filtering and pagination.

Version
2.0.0
OpenAPI version
3.0.0

Operations

Section titled “Operations”

index

Section titled “index”
POST
/v2/action-subscription/index

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

Request Body

Section titled “Request Body ”

Parameters for searching action subscriptions

object
filter
object
action_subscription_id
string format: uuid
action_id
string format: uuid
action_type
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
action_code
string
action_name
string
subscriber_id
string format: uuid
subscriber_type
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
subscriber_code
string
subscriber_name
string
certificate_date_release
string format: date
certificate_date_expire
string format: date
date_latest_session
string format: date
status
string
Allowed values: NEW VALID EXPIRED
office_name
string
project_name
string
project_type
string
subtenant_id
string format: uuid
tenant_id
string format: uuid
per-page
integer
default: 100 >= 1
page
integer
default: 1 >= 1
sort
string
Allowed values: action_type action_code action_name subscriber_type subscriber_code subscriber_name certificate_date_expire date_latest_session status office_name project_name
history
boolean
Example
{
  "filter": {
    "action_type": "TRAINING",
    "subscriber_type": "PERSON"
  },
  "per-page": 20,
  "page": 1,
  "sort": "action_name"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

List of action subscriptions

Array<object>
object
action_subscription_id
string format: uuid
action_id
string format: uuid
action_type
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
action_code
string
action_name
string
subscriber_id
string format: uuid
subscriber_type
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
subscriber_code
string
subscriber_name
string
last_certificate_id
string format: uuid
certificate_date_release
string format: date
certificate_date_expire
string format: date
last_action_session_subscription_id
string format: uuid
date_latest_session
string format: date
status
string
Allowed values: NEW VALID EXPIRED
office_name
string
project_name
string
project_type
string
subtenant_id
string format: uuid
tenant_id
string format: uuid
owned_active
boolean
parent_active
boolean
manager
string format: json
assignee
string format: json
watcher
string format: json
Example
{
  "action_subscription_id": "asub-1",
  "action_id": "act-1",
  "action_type": "TRAINING",
  "action_code": "A001",
  "action_name": "Safety Training",
  "subscriber_id": "pers-1",
  "subscriber_type": "PERSON",
  "subscriber_name": "John Doe",
  "status": "NEW",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

Headers

Section titled “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

Section titled “create”
POST
/v2/action-subscription/create

Create a new action subscription by providing the required details.

Request Body required

Section titled “Request Body required ”

Action subscription object to be created

object
action_subscription_id
required
string
action_id
required
string
subscriber_id
required
string
subscriber_type
required
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
data
object
subtenant_id
required
string
tenant_id
required
string
Example
{
  "action_id": "act-1",
  "subscriber_id": "pers-1",
  "subscriber_type": "PERSON",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

Responses

Section titled “ Responses ”
201
Section titled “201 ”

Action subscription created successfully

object
action_subscription_id
required
string
action_id
required
string
subscriber_id
required
string
subscriber_type
required
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
data
object
subtenant_id
required
string
tenant_id
required
string
Example
{
  "action_subscription_id": "asub-1",
  "action_id": "act-1",
  "subscriber_id": "pers-1",
  "subscriber_type": "PERSON",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

view

Section titled “view”
GET
/v2/action-subscription/view/{id}

Retrieve an action subscription by its unique ID.

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

ID of the action subscription to retrieve

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Action subscription found

object
action_subscription_id
string format: uuid
action_id
string format: uuid
action_type
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
action_code
string
action_name
string
subscriber_id
string format: uuid
subscriber_type
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
subscriber_code
string
subscriber_name
string
last_certificate_id
string format: uuid
certificate_date_release
string format: date
certificate_date_expire
string format: date
last_action_session_subscription_id
string format: uuid
date_latest_session
string format: date
status
string
Allowed values: NEW VALID EXPIRED
office_name
string
project_name
string
project_type
string
subtenant_id
string format: uuid
tenant_id
string format: uuid
owned_active
boolean
parent_active
boolean
manager
string format: json
assignee
string format: json
watcher
string format: json
Example
{
  "action_subscription_id": "asub-1",
  "action_id": "act-1",
  "action_type": "TRAINING",
  "action_code": "A001",
  "action_name": "Safety Training",
  "subscriber_id": "pers-1",
  "subscriber_type": "PERSON",
  "subscriber_name": "John Doe",
  "status": "NEW",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}
404
Section titled “404 ”

Action subscription not found

update

Section titled “update”
PUT
/v2/action-subscription/update/{id}

Update an existing action subscription by its unique ID.

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

ID of the action subscription to update

Request Body required

Section titled “Request Body required ”

Action subscription object with updated data

object
action_subscription_id
required
string
action_id
required
string
subscriber_id
required
string
subscriber_type
required
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
data
object
subtenant_id
required
string
tenant_id
required
string
Example
{
  "subscriber_name": "Jane Doe",
  "status": "VALID"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Action subscription updated successfully

object
action_subscription_id
required
string
action_id
required
string
subscriber_id
required
string
subscriber_type
required
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
data
object
subtenant_id
required
string
tenant_id
required
string
Example
{
  "action_subscription_id": "asub-1",
  "subscriber_name": "Jane Doe",
  "status": "VALID"
}
404
Section titled “404 ”

Action subscription not found

delete

Section titled “delete”
DELETE
/v2/action-subscription/delete/{id}

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

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

ID of the action subscription to delete

Query Parameters

Section titled “Query Parameters ”
force
boolean

Force the deletion of the entity and all related entities

Responses

Section titled “ Responses ”
204
Section titled “204 ”

Action subscription deleted successfully

400
Section titled “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