ActionSessionDate
An ActionSessionDate represents a specific day of a session. A session can span multiple days — each day is an ActionSessionDate.
For example, a 3-day training course will have one ActionSession with 3 ActionSessionDate entries.
Use this API to:
- Define the dates when a session takes place (after creating the session)
- Find the dates for a session (filter by
action_session_id) - Modify the schedule of a planned session
- Version
- 2.0.0
- OpenAPI version
- 3.0.0
Authentication
Section titled “ Authentication ”OAuth2
Section titled “OAuth2 ”Security scheme type: oauth2
Flow type: password
Token URL: https://auth.4hse.com/realms/4hse/protocol/openid-connect/token
AccessToken
Section titled “AccessToken ”Security scheme type: apiKey
Query parameter name: access-token
Operations
Section titled “Operations” POST /v2/action-session-date/index
Returns a paginated list of session dates.
Most useful filters:
action_session_id: all dates for a specific sessionaction_type+subtenant_id: all dates for a type of action in an officesubscriber_id(query parameter): dates of sessions where a specific resource is enrolled
Authorizations
Section titled “Authorizations ”Query Parameters
Section titled “Query Parameters ”Filter by subscriber ID. Returns only session dates where this resource is enrolled.
Request Body
Section titled “Request Body ”Parameters for searching session dates
object
object
Unique identifier of the session date.
The session this date belongs to.
The office of this session date.
The project of this session date.
Start date and time.
End date and time.
Additional structured data.
The action this session belongs to.
Code of the linked action.
Name of the linked action.
Type of the linked action.
Name of the office.
Name of the project (company).
Session managers (JSON).
Session assignees (JSON).
Session watchers (JSON).
Field to sort by. Prefix with minus for descending order (e.g. “-date_begin”).
Example
{ "filter": { "action_session_id": "b1c2d3e4-f5a6-7890-bcde-f12345678901" }, "per-page": 10, "page": 1, "sort": "date_begin"}Responses
Section titled “ Responses ”List of session dates
object
Unique identifier of the session date.
The session this date belongs to.
The office of this session date.
The project of this session date.
Start date and time.
End date and time.
Additional structured data.
The action this session belongs to.
Code of the linked action.
Name of the linked action.
Type of the linked action.
Name of the office.
Name of the project (company).
Session managers (JSON).
Session assignees (JSON).
Session watchers (JSON).
Example
[ { "action_session_date_id": "c2d3e4f5-a6b7-8901-cdef-123456789012", "action_session_id": "b1c2d3e4-f5a6-7890-bcde-f12345678901", "date_begin": "2024-03-15T09:00:00", "date_end": "2024-03-15T17:00:00", "subtenant_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01", "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f", "action_code": "FST-01", "action_name": "Fire Safety Training Medium Risk", "action_type": "TRAINING", "office_name": "Rome North Site", "project_name": "Acme Construction Ltd" }]Headers
Section titled “Headers ”Current page
Total number of pages
Number of items per page
Total number of items
create
Section titled “create” POST /v2/action-session-date/create
Creates a new date for a session.
Requires action_session_id, date_begin, date_end, subtenant_id (office_id), and tenant_id (project_id).
The action_session_date_id is auto-generated if not provided.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”Session date to create
object
Unique identifier of the session date. Auto-generated if not provided on creation.
The session this date belongs to. Pass the action_session_id obtained from the ActionSession API.
Start date and time of this day.
End date and time of this day.
Additional structured data in JSON format.
The office (work location). Pass the office_id.
The project (company). Pass the project_id.
Example
{ "action_session_id": "b1c2d3e4-f5a6-7890-bcde-f12345678901", "date_begin": "2024-03-15T09:00:00", "date_end": "2024-03-15T17:00:00", "subtenant_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01"}Responses
Section titled “ Responses ”Session date created successfully
object
Unique identifier of the session date. Auto-generated if not provided on creation.
The session this date belongs to. Pass the action_session_id obtained from the ActionSession API.
Start date and time of this day.
End date and time of this day.
Additional structured data in JSON format.
The office (work location). Pass the office_id.
The project (company). Pass the project_id.
Example
{ "action_session_date_id": "c2d3e4f5-a6b7-8901-cdef-123456789012", "action_session_id": "b1c2d3e4-f5a6-7890-bcde-f12345678901", "date_begin": "2024-03-15T09:00:00", "date_end": "2024-03-15T17:00:00", "subtenant_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01"} GET /v2/action-session-date/view/{id}
Retrieves a single session date by its ID.
Authorizations
Section titled “Authorizations ”Path Parameters
Section titled “Path Parameters ”The action_session_date_id to retrieve.
Responses
Section titled “ Responses ”Session date found
object
Unique identifier of the session date.
The session this date belongs to.
The office of this session date.
The project of this session date.
Start date and time.
End date and time.
Additional structured data.
The action this session belongs to.
Code of the linked action.
Name of the linked action.
Type of the linked action.
Name of the office.
Name of the project (company).
Session managers (JSON).
Session assignees (JSON).
Session watchers (JSON).
Session date not found
update
Section titled “update” PUT /v2/action-session-date/update/{id}
Updates an existing session date.
Authorizations
Section titled “Authorizations ”Path Parameters
Section titled “Path Parameters ”The action_session_date_id to update.
Request Body required
Section titled “Request Body required ”Fields to update
object
Unique identifier of the session date. Auto-generated if not provided on creation.
The session this date belongs to. Pass the action_session_id obtained from the ActionSession API.
Start date and time of this day.
End date and time of this day.
Additional structured data in JSON format.
The office (work location). Pass the office_id.
The project (company). Pass the project_id.
Example
{ "date_begin": "2024-04-01T09:00:00", "date_end": "2024-04-01T17:00:00"}Responses
Section titled “ Responses ”Session date updated successfully
object
Unique identifier of the session date. Auto-generated if not provided on creation.
The session this date belongs to. Pass the action_session_id obtained from the ActionSession API.
Start date and time of this day.
End date and time of this day.
Additional structured data in JSON format.
The office (work location). Pass the office_id.
The project (company). Pass the project_id.
Session date not found
delete
Section titled “delete” DELETE /v2/action-session-date/delete/{id}
Deletes a session date.
If force=false (default), the response lists related entities.
If force=true, the date is deleted.
Authorizations
Section titled “Authorizations ”Path Parameters
Section titled “Path Parameters ”The action_session_date_id to delete.
Query Parameters
Section titled “Query Parameters ”If true, deletes the date. If false, returns a preview of affected entities.
Responses
Section titled “ Responses ”Session date deleted successfully
Preview of affected entities (returned when force=false)