ActionSessionDate

Represents the specific dates on which a preventive action session is scheduled to take place. Used to define when the corresponding ActionSession will be carried out, ensuring proper planning and tracking of safety-related activities.

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

Flow type: refreshToken

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/action-session-date/index

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

Authorizations

• Oauth2
• AccessToken

Request Body

Parameters for searching action session dates

object

filter

object

action_session_date_id

string format: uuid

action_session_id

string format: uuid

subtenant_id

string format: uuid

tenant_id

string format: uuid

date_begin

string format: date

date_end

string format: date

data

Additional data

string format: json

action_id

string format: uuid

manager

string format: json

assignee

string format: json

watcher

string format: json

action_code

string

action_name

string

action_type

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

office_name

string

project_name

string

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": {
    "date_begin": "2024-01-01",
    "date_end": "2024-12-31"
  },
  "per-page": 10,
  "page": 1,
  "sort": "date_begin"
}

Responses

200

List of action session dates

Array<object>

object

action_session_date_id

string format: uuid

action_session_id

string format: uuid

subtenant_id

string format: uuid

tenant_id

string format: uuid

date_begin

string format: date

date_end

string format: date

data

Additional data

string format: json

action_id

string format: uuid

manager

string format: json

assignee

string format: json

watcher

string format: json

action_code

string

action_name

string

action_type

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

office_name

string

project_name

string

Example

{
  "action_session_date_id": "date-1",
  "action_session_id": "sess-1",
  "date_begin": "2024-01-10T09:00:00Z",
  "date_end": "2024-01-10T17:00:00Z",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

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/action-session-date/create

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

Authorizations

• Oauth2
• AccessToken

Request Body ^required

Action session date object to be created

object

action_session_date_id

string

action_session_id

string

date_begin

string format: dateTime

date_end

string format: dateTime

data

Additional data

string format: json

subtenant_id

string

tenant_id

string

Example

{
  "action_session_id": "sess-1",
  "date_begin": "2024-03-01T09:00:00Z",
  "date_end": "2024-03-01T17:00:00Z",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

Responses

201

Action session date created successfully

object

action_session_date_id

string

action_session_id

string

date_begin

string format: dateTime

date_end

string format: dateTime

data

Additional data

string format: json

subtenant_id

string

tenant_id

string

Example

{
  "action_session_date_id": "date-3",
  "action_session_id": "sess-1",
  "date_begin": "2024-03-01T09:00:00Z",
  "date_end": "2024-03-01T17:00:00Z",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

view

GET

/v2/action-session-date/view/{id}

Retrieve an action session date by its unique ID.

Authorizations

• Oauth2
• AccessToken

Path Parameters

id

required

string format: uuid

ID of the action session date to retrieve

Responses

200

Action session date found

object

action_session_date_id

string format: uuid

action_session_id

string format: uuid

subtenant_id

string format: uuid

tenant_id

string format: uuid

date_begin

string format: date

date_end

string format: date

data

Additional data

string format: json

action_id

string format: uuid

manager

string format: json

assignee

string format: json

watcher

string format: json

action_code

string

action_name

string

action_type

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

office_name

string

project_name

string

Example

{
  "action_session_date_id": "date-1",
  "action_session_id": "sess-1",
  "date_begin": "2024-01-10T09:00:00Z",
  "date_end": "2024-01-10T17:00:00Z",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

404

Action session date not found

delete

DELETE

/v2/action-session-date/delete/{id}

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

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Action session date 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/action-session-date/update/{id}

Update an existing action session date by its unique ID.

Authorizations

• Oauth2
• AccessToken

Path Parameters

id

required

string format: uuid

ID of the action session date to update

Request Body ^required

Action session date object with updated data

object

action_session_date_id

string

action_session_id

string

date_begin

string format: dateTime

date_end

string format: dateTime

data

Additional data

string format: json

subtenant_id

string

tenant_id

string

Example

{
  "date_begin": "2024-04-01T09:00:00Z",
  "date_end": "2024-04-01T17:00:00Z"
}

Responses

200

Action session date updated successfully

object

action_session_date_id

string

action_session_id

string

date_begin

string format: dateTime

date_end

string format: dateTime

data

Additional data

string format: json

subtenant_id

string

tenant_id

string

Example

{
  "action_session_date_id": "date-1",
  "action_session_id": "sess-1",
  "date_begin": "2024-04-01T09:00:00Z",
  "date_end": "2024-04-01T17:00:00Z",
  "subtenant_id": "sub-1",
  "tenant_id": "ten-1"
}

404

Action session date not found