---
title: "ActionSessionDate"
url: "https://dev.4hse.com/api/actionsessiondate"
---

# 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 ”](#authentication)

### OAuth2

[Section titled “OAuth2 ”](#oauth2)

**Security scheme type:** oauth2

**Flow type:** password

**Token URL:** [https://auth.4hse.com/realms/4hse/protocol/openid-connect/token](https://auth.4hse.com/realms/4hse/protocol/openid-connect/token)

### AccessToken

[Section titled “AccessToken ”](#accesstoken)

**Security scheme type:** apiKey

**Query parameter name:** access-token

## Operations

[Section titled “Operations”](#operations)

### index

[Section titled “index”](#operation-indexActionSessionDate-post)

POST

/v2/action-session-date/index

-   

Returns a paginated list of session dates.

Most useful filters:

-   `action_session_id`: all dates for a specific session
-   `action_type` + `subtenant_id`: all dates for a type of action in an office
-   `subscriber_id` (query parameter): dates of sessions where a specific resource is enrolled

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/actionsessiondate/#oauth2)**
-   **[AccessToken](/api/actionsessiondate/#accesstoken)**

#### Query Parameters

[Section titled “Query Parameters ”](#query-parameters)

**subscriber\_id**

string format: uuid

Filter by subscriber ID. Returns only session dates where this resource is enrolled.

#### Request Body

[Section titled “Request Body ”](#request-body)

Parameters for searching session dates

Select media typeapplication/json

object

**filter**

object

**action\_session\_date\_id**

Unique identifier of the session date.

string format: uuid

**action\_session\_id**

The session this date belongs to.

string format: uuid

**subtenant\_id**

The office of this session date.

string format: uuid

**tenant\_id**

The project of this session date.

string format: uuid

**date\_begin**

Start date and time.

string format: date-time

**date\_end**

End date and time.

string format: date-time

**data**

Additional structured data.

string format: json

**action\_id**

The action this session belongs to.

string format: uuid

**action\_code**

Code of the linked action.

string

**action\_name**

Name of the linked action.

string

**action\_type**

Type of the linked action.

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

**office\_name**

Name of the office.

string

**project\_name**

Name of the project (company).

string

**manager**

Session managers (JSON).

string format: json

**assignee**

Session assignees (JSON).

string format: json

**watcher**

Session watchers (JSON).

string format: json

**per-page**

integer

default: 100 \>= 1

**page**

integer

default: 1 \>= 1

**sort**

Field to sort by. Prefix with minus for descending order (e.g. “-date\_begin”).

string

Allowed values: date\_begin date\_end action\_code action\_name action\_type

##### Example

```
{  "filter": {    "action_session_id": "b1c2d3e4-f5a6-7890-bcde-f12345678901"  },  "per-page": 10,  "page": 1,  "sort": "date_begin"}
```

#### Responses

[Section titled “ Responses ”](#responses)

##### 200

[Section titled “200 ”](#200)

List of session dates

Select media typeapplication/json

Array<object>

object

**action\_session\_date\_id**

Unique identifier of the session date.

string format: uuid

**action\_session\_id**

The session this date belongs to.

string format: uuid

**subtenant\_id**

The office of this session date.

string format: uuid

**tenant\_id**

The project of this session date.

string format: uuid

**date\_begin**

Start date and time.

string format: date-time

**date\_end**

End date and time.

string format: date-time

**data**

Additional structured data.

string format: json

**action\_id**

The action this session belongs to.

string format: uuid

**action\_code**

Code of the linked action.

string

**action\_name**

Name of the linked action.

string

**action\_type**

Type of the linked action.

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

**office\_name**

Name of the office.

string

**project\_name**

Name of the project (company).

string

**manager**

Session managers (JSON).

string format: json

**assignee**

Session assignees (JSON).

string format: json

**watcher**

Session watchers (JSON).

string format: 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 ”](#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”](#operation-createActionSessionDate-post)

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 ”](#authorizations)

-   **[OAuth2](/api/actionsessiondate/#oauth2)**
-   **[AccessToken](/api/actionsessiondate/#accesstoken)**

#### Request Body required

[Section titled “Request Body required ”](#request-body)

Session date to create

Select media typeapplication/json

object

**action\_session\_date\_id**

Unique identifier of the session date. Auto-generated if not provided on creation.

string format: uuid

**action\_session\_id**

required

The session this date belongs to. Pass the `action_session_id` obtained from the ActionSession API.

string format: uuid

**date\_begin**

required

Start date and time of this day.

string format: date-time

**date\_end**

required

End date and time of this day.

string format: date-time

**data**

Additional structured data in JSON format.

string format: json

**subtenant\_id**

required

The office (work location). Pass the `office_id`.

string format: uuid

**tenant\_id**

required

The project (company). Pass the `project_id`.

string format: uuid

##### 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 ”](#responses)

##### 201

[Section titled “201 ”](#201)

Session date created successfully

Select media typeapplication/json

object

**action\_session\_date\_id**

Unique identifier of the session date. Auto-generated if not provided on creation.

string format: uuid

**action\_session\_id**

required

The session this date belongs to. Pass the `action_session_id` obtained from the ActionSession API.

string format: uuid

**date\_begin**

required

Start date and time of this day.

string format: date-time

**date\_end**

required

End date and time of this day.

string format: date-time

**data**

Additional structured data in JSON format.

string format: json

**subtenant\_id**

required

The office (work location). Pass the `office_id`.

string format: uuid

**tenant\_id**

required

The project (company). Pass the `project_id`.

string format: uuid

##### 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"}
```

### view

[Section titled “view”](#operation-viewActionSessionDate-get)

GET

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

-   

Retrieves a single session date by its ID.

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/actionsessiondate/#oauth2)**
-   **[AccessToken](/api/actionsessiondate/#accesstoken)**

#### Path Parameters

[Section titled “Path Parameters ”](#path-parameters)

**id**

required

string format: uuid

The action\_session\_date\_id to retrieve.

#### Responses

[Section titled “ Responses ”](#responses)

##### 200

[Section titled “200 ”](#200)

Session date found

Select media typeapplication/json

object

**action\_session\_date\_id**

Unique identifier of the session date.

string format: uuid

**action\_session\_id**

The session this date belongs to.

string format: uuid

**subtenant\_id**

The office of this session date.

string format: uuid

**tenant\_id**

The project of this session date.

string format: uuid

**date\_begin**

Start date and time.

string format: date-time

**date\_end**

End date and time.

string format: date-time

**data**

Additional structured data.

string format: json

**action\_id**

The action this session belongs to.

string format: uuid

**action\_code**

Code of the linked action.

string

**action\_name**

Name of the linked action.

string

**action\_type**

Type of the linked action.

string

Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER

**office\_name**

Name of the office.

string

**project\_name**

Name of the project (company).

string

**manager**

Session managers (JSON).

string format: json

**assignee**

Session assignees (JSON).

string format: json

**watcher**

Session watchers (JSON).

string format: json

##### 404

[Section titled “404 ”](#404)

Session date not found

### update

[Section titled “update”](#operation-updateActionSessionDate-put)

PUT

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

-   

Updates an existing session date.

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/actionsessiondate/#oauth2)**
-   **[AccessToken](/api/actionsessiondate/#accesstoken)**

#### Path Parameters

[Section titled “Path Parameters ”](#path-parameters)

**id**

required

string format: uuid

The action\_session\_date\_id to update.

#### Request Body required

[Section titled “Request Body required ”](#request-body)

Fields to update

Select media typeapplication/json

object

**action\_session\_date\_id**

Unique identifier of the session date. Auto-generated if not provided on creation.

string format: uuid

**action\_session\_id**

required

The session this date belongs to. Pass the `action_session_id` obtained from the ActionSession API.

string format: uuid

**date\_begin**

required

Start date and time of this day.

string format: date-time

**date\_end**

required

End date and time of this day.

string format: date-time

**data**

Additional structured data in JSON format.

string format: json

**subtenant\_id**

required

The office (work location). Pass the `office_id`.

string format: uuid

**tenant\_id**

required

The project (company). Pass the `project_id`.

string format: uuid

##### Example

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

#### Responses

[Section titled “ Responses ”](#responses)

##### 200

[Section titled “200 ”](#200)

Session date updated successfully

Select media typeapplication/json

object

**action\_session\_date\_id**

Unique identifier of the session date. Auto-generated if not provided on creation.

string format: uuid

**action\_session\_id**

required

The session this date belongs to. Pass the `action_session_id` obtained from the ActionSession API.

string format: uuid

**date\_begin**

required

Start date and time of this day.

string format: date-time

**date\_end**

required

End date and time of this day.

string format: date-time

**data**

Additional structured data in JSON format.

string format: json

**subtenant\_id**

required

The office (work location). Pass the `office_id`.

string format: uuid

**tenant\_id**

required

The project (company). Pass the `project_id`.

string format: uuid

##### 404

[Section titled “404 ”](#404)

Session date not found

### delete

[Section titled “delete”](#operation-deleteActionSessionDate-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 ”](#authorizations)

-   **[OAuth2](/api/actionsessiondate/#oauth2)**
-   **[AccessToken](/api/actionsessiondate/#accesstoken)**

#### Path Parameters

[Section titled “Path Parameters ”](#path-parameters)

**id**

required

string format: uuid

The action\_session\_date\_id to delete.

#### Query Parameters

[Section titled “Query Parameters ”](#query-parameters)

**force**

boolean

If true, deletes the date. If false, returns a preview of affected entities.

#### Responses

[Section titled “ Responses ”](#responses)

##### 204

[Section titled “204 ”](#204)

Session date deleted successfully

##### 400

[Section titled “400 ”](#400)

Preview of affected entities (returned when force=false)

This site is protected by reCAPTCHA and the Google [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms) apply.