Skip to content
4HSE

ActionSessionSubscription

Manage action session subscriptions, which represent the participation of a resource (person, material, etc.) in a specific action session.
You can create, update, delete, and search for action session 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-session-subscription/index

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

Request Body

Section titled “Request Body ”

Parameters for searching action session subscriptions

object
filter
object
action_session_subscription_id
string format: uuid
action_session_id
string format: uuid
action_subscription_id
string format: uuid
data

Additional data

string format: json
subtenant_id
string format: uuid
tenant_id
string format: uuid
done
integer
default: -1
Allowed values: 1 0
warning
integer
Allowed values: 1 0
certificate_id
string format: uuid
date_begin
string format: date
date_expire
string format: date
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
action_code
string
action_name
string
action_type
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
action_id
string format: uuid
validity_unit
string
Allowed values: YEAR MONTH DAY
validity

Validity from action_session or action

integer
session_date_begin
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": {
    "action_session_id": "sess-1"
  },
  "per-page": 10,
  "page": 1,
  "sort": "date_begin"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

List of action session subscriptions

Array<object>
object
action_session_subscription_id
string format: uuid
action_session_id
string format: uuid
action_subscription_id
string format: uuid
data

Additional data

string format: json
subtenant_id
string format: uuid
tenant_id
string format: uuid
done
integer
default: -1
Allowed values: 1 0
warning
integer
Allowed values: 1 0
certificate_id
string format: uuid
date_begin
string format: date
date_expire
string format: date
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
action_code
string
action_name
string
action_type
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
action_id
string format: uuid
validity_unit
string
Allowed values: YEAR MONTH DAY
validity

Validity from action_session or action

integer
session_date_begin
string format: date
Example
{
  "action_session_subscription_id": "subscr-1",
  "action_session_id": "sess-1",
  "action_subscription_id": "asub-1",
  "done": 1,
  "warning": 0,
  "date_begin": "2024-01-10",
  "date_expire": "2024-01-11",
  "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-session-subscription/create

Create a new action session subscription by providing the required details.

Request Body required

Section titled “Request Body required ”

Action session subscription object to be created

object
action_session_subscription_id
string
action_session_id
string
action_subscription_id
string
data

Additional data

string format: json
subtenant_id
string
tenant_id
string
done
integer
default: -1
Allowed values: 1 0
warning
integer
Allowed values: 1 0
certificate_id

Certificate generated by the subscription, optional

string
date_begin
string format: dateTime
date_expire
string format: dateTime
Example
{
  "action_session_id": "sess-1",
  "action_subscription_id": "asub-1",
  "done": 1,
  "warning": 0,
  "date_begin": "2024-01-10",
  "date_expire": "2024-01-11",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

Responses

Section titled “ Responses ”
201
Section titled “201 ”

Action session subscription created successfully

object
action_session_subscription_id
string
action_session_id
string
action_subscription_id
string
data

Additional data

string format: json
subtenant_id
string
tenant_id
string
done
integer
default: -1
Allowed values: 1 0
warning
integer
Allowed values: 1 0
certificate_id

Certificate generated by the subscription, optional

string
date_begin
string format: dateTime
date_expire
string format: dateTime
Example
{
  "action_session_subscription_id": "subscr-1",
  "action_session_id": "sess-1",
  "action_subscription_id": "asub-1",
  "done": 1,
  "warning": 0,
  "date_begin": "2024-01-10",
  "date_expire": "2024-01-11",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

view

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

Retrieve an action session subscription by its unique ID.

Path Parameters

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

ID of the action session subscription to retrieve

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Action session subscription found

object
action_session_subscription_id
string format: uuid
action_session_id
string format: uuid
action_subscription_id
string format: uuid
data

Additional data

string format: json
subtenant_id
string format: uuid
tenant_id
string format: uuid
done
integer
default: -1
Allowed values: 1 0
warning
integer
Allowed values: 1 0
certificate_id
string format: uuid
date_begin
string format: date
date_expire
string format: date
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
action_code
string
action_name
string
action_type
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
action_id
string format: uuid
validity_unit
string
Allowed values: YEAR MONTH DAY
validity

Validity from action_session or action

integer
session_date_begin
string format: date
Example
{
  "action_session_subscription_id": "subscr-1",
  "action_session_id": "sess-1",
  "action_subscription_id": "asub-1",
  "done": 1,
  "warning": 0,
  "date_begin": "2024-01-10",
  "date_expire": "2024-01-11",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}
404
Section titled “404 ”

Action session subscription not found

delete

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

Delete an action session 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 session 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 session 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

update

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

Update an existing action session subscription by its unique ID.

Path Parameters

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

ID of the action session subscription to update

Request Body required

Section titled “Request Body required ”

Action session subscription object with updated data

object
action_session_subscription_id
string
action_session_id
string
action_subscription_id
string
data

Additional data

string format: json
subtenant_id
string
tenant_id
string
done
integer
default: -1
Allowed values: 1 0
warning
integer
Allowed values: 1 0
certificate_id

Certificate generated by the subscription, optional

string
date_begin
string format: dateTime
date_expire
string format: dateTime
Example
{
  "done": 0,
  "warning": 1
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Action session subscription updated successfully

object
action_session_subscription_id
string
action_session_id
string
action_subscription_id
string
data

Additional data

string format: json
subtenant_id
string
tenant_id
string
done
integer
default: -1
Allowed values: 1 0
warning
integer
Allowed values: 1 0
certificate_id

Certificate generated by the subscription, optional

string
date_begin
string format: dateTime
date_expire
string format: dateTime
Example
{
  "action_session_subscription_id": "subscr-1",
  "done": 0,
  "warning": 1
}
404
Section titled “404 ”

Action session subscription not found