Skip to content
4HSE Developers DEV

ActionSubscription

An ActionSubscription is a compliance schedule entry: it records that a resource (person, equipment, work environment, substance, role, work group, office, PPE, or supplier) is subscribed to a preventive action and must fulfill that requirement.

Use this API to:

  • Check the compliance schedule for an office (filter by subtenant_id with the office_id)
  • Verify compliance: filter by status: EXPIRED or EXPIRING to find non-conformities
  • Find all requirements for a person (filter by subscriber_id with the person_id)
  • Subscribe a person or resource to a preventive action

The status is automatically calculated based on linked certificates:

  • NEW: no certificate exists for this subscription
  • VALID: a valid (not yet expired) certificate exists
  • EXPIRING: the certificate is about to expire (within the days defined by expire_interval on the action)
  • EXPIRED: the certificate has expired

The status is automatically updated when a CertificateAction is created or modified that links a certificate to the action of this subscription.

ActionSubscription supports historicization: when a subscription or any of its parent entities (action, office, person) is historicized, the subscription is automatically excluded from normal queries. The parent_active field in responses reflects this state. Use the history: true parameter in the index to include inactive subscriptions.

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”

index

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

Returns a paginated list of the compliance schedule.

Most useful filters:

  • subtenant_id (office_id) + status (EXPIRED or EXPIRING): find non-conformities in an office
  • subscriber_id (person_id) + action_type: find all requirements for a person by type
  • action_id: find all resources subscribed to a specific action
  • action_type + subtenant_id: compliance schedule for a specific type in an office (e.g. all training at a construction site)

The response includes action details, subscribed resource details, and the most recent certificate, providing a complete compliance view without additional calls.

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”

Parameters for searching the compliance schedule

object
filter
object
action_subscription_id

Unique identifier of the subscription.

string format: uuid
action_id

The preventive action this resource is subscribed to.

string format: uuid
action_type

Type of the linked action.

string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
action_code

Code of the linked action.

string
action_name

Name of the linked action.

string
subscriber_id

The ID of the subscribed resource.

string format: uuid
subscriber_type

The type of subscribed resource.

string
Allowed values: PERSON ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT OFFICE PPE UNIT
subscriber_code

Code of the subscribed resource.

string
subscriber_name

Name of the subscribed resource.

string
last_certificate_id

ID of the most recent certificate linked to this subscription.

string format: uuid
certificate_date_release

Issue date of the most recent certificate.

string format: date
certificate_date_expire

Expiration date of the most recent certificate.

string format: date
last_action_session_subscription_id

ID of the most recent session subscription.

string format: uuid
date_latest_session

Date of the most recent scheduled session.

string format: date
status

Compliance status of the subscription (automatically calculated):

  • NEW: no certificate exists
  • VALID: a valid (not expired) certificate exists
  • EXPIRING: the certificate is about to expire (within expire_interval days)
  • EXPIRED: the certificate has expired
string
Allowed values: NEW VALID EXPIRED EXPIRING
office_name

Name of the office.

string
project_name

Name of the project (company).

string
project_type

Type of the parent project.

string
Allowed values: safety template
subtenant_id

The office (work location) of this subscription.

string format: uuid
tenant_id

The project (company) of this subscription.

string format: uuid
owned_active

Whether this subscription is currently active in its validity period.

boolean
nullable
parent_active

Whether the parent entities (action, office) are currently active.

boolean
nullable
project_status

Status of the parent project.

string
Allowed values: active suspended pending_delete deleted
subscription_status

Status of the project subscription (billing).

string
Allowed values: active trial refused expiring
certificate_action_approvals_count

Number of certificate-action approvals for this subscription.

integer
manager

Action managers (JSON).

string format: json
assignee

Action assignees (JSON).

string format: json
watcher

Action 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. “-certificate_date_expire”).

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

If true, includes historicized (no longer active) entries in the results. By default only current entries are returned.

boolean
Example
{
  "filter": {
    "subtenant_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "action_type": "TRAINING",
    "status": "EXPIRED"
  },
  "per-page": 20,
  "page": 1,
  "sort": "certificate_date_expire"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

List of compliance schedule entries

Array<object>
object
action_subscription_id

Unique identifier of the subscription.

string format: uuid
action_id

The preventive action this resource is subscribed to.

string format: uuid
action_type

Type of the linked action.

string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
action_code

Code of the linked action.

string
action_name

Name of the linked action.

string
subscriber_id

The ID of the subscribed resource.

string format: uuid
subscriber_type

The type of subscribed resource.

string
Allowed values: PERSON ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT OFFICE PPE UNIT
subscriber_code

Code of the subscribed resource.

string
subscriber_name

Name of the subscribed resource.

string
last_certificate_id

ID of the most recent certificate linked to this subscription.

string format: uuid
certificate_date_release

Issue date of the most recent certificate.

string format: date
certificate_date_expire

Expiration date of the most recent certificate.

string format: date
last_action_session_subscription_id

ID of the most recent session subscription.

string format: uuid
date_latest_session

Date of the most recent scheduled session.

string format: date
status

Compliance status of the subscription (automatically calculated):

  • NEW: no certificate exists
  • VALID: a valid (not expired) certificate exists
  • EXPIRING: the certificate is about to expire (within expire_interval days)
  • EXPIRED: the certificate has expired
string
Allowed values: NEW VALID EXPIRED EXPIRING
office_name

Name of the office.

string
project_name

Name of the project (company).

string
project_type

Type of the parent project.

string
Allowed values: safety template
subtenant_id

The office (work location) of this subscription.

string format: uuid
tenant_id

The project (company) of this subscription.

string format: uuid
owned_active

Whether this subscription is currently active in its validity period.

boolean
nullable
parent_active

Whether the parent entities (action, office) are currently active.

boolean
nullable
project_status

Status of the parent project.

string
Allowed values: active suspended pending_delete deleted
subscription_status

Status of the project subscription (billing).

string
Allowed values: active trial refused expiring
certificate_action_approvals_count

Number of certificate-action approvals for this subscription.

integer
manager

Action managers (JSON).

string format: json
assignee

Action assignees (JSON).

string format: json
watcher

Action watchers (JSON).

string format: json
Example
[
  {
    "action_subscription_id": "d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a",
    "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
    "action_type": "TRAINING",
    "action_code": "FST-01",
    "action_name": "Fire Safety Training Medium Risk",
    "subscriber_id": "e3a1f5d2-8c4b-4e7a-9f6d-2b1c3d4e5f6a",
    "subscriber_type": "PERSON",
    "subscriber_code": "JS001",
    "subscriber_name": "Smith John",
    "status": "EXPIRED",
    "last_certificate_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
    "certificate_date_release": "2020-01-15",
    "certificate_date_expire": "2025-01-15",
    "subtenant_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01",
    "office_name": "Rome North Site",
    "project_name": "Acme Construction Ltd",
    "project_type": "safety",
    "owned_active": true,
    "parent_active": true
  }
]

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

Creates a new compliance schedule entry.

Requires action_id, subscriber_id, subscriber_type, subtenant_id (office_id), and tenant_id (project_id). The action_subscription_id is auto-generated if not provided.

The subscriber_type must be compatible with the action’s action_type:

  • For TRAINING, HEALTH, PER actions: subscriber_type must be PERSON
  • For MAINTENANCE actions: subscriber_type can be EQUIPMENT, WORK_ENVIRONMENT, PPE, OFFICE
  • For CHECK actions: any subscriber_type is allowed

A new subscription starts with status NEW. The status will change to VALID only when a CertificateAction is created that links a certificate to the action of this subscription for the same resource.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

Compliance schedule entry to create

object
action_subscription_id

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

string format: uuid
action_id
required

The preventive action this resource is subscribed to. Pass the action_id obtained from the Action API. If unknown, search via the Action index filtering by subtenant_id and name or action_type.

string format: uuid
subscriber_id
required

The ID of the subscribed resource. What to pass depends on subscriber_type:

  • PERSON: pass the person_id
  • EQUIPMENT: pass the office_equipment_id
  • WORK_ENVIRONMENT: pass the office_work_environment_id
  • SUBSTANCE: pass the office_substance_id
  • ROLE: pass the office_role_id
  • WORK_GROUP: pass the work_group_id
  • OFFICE: pass the office_id
  • PPE: pass the material_item_id
  • UNIT: pass the unit_id (supplier)
string format: uuid
subscriber_type
required

The type of subscribed resource. Must be compatible with the action’s action_type:

  • For TRAINING, HEALTH, PER actions: must be PERSON
  • For MAINTENANCE actions: can be EQUIPMENT, WORK_ENVIRONMENT, PPE, OFFICE
  • For CHECK actions: any type is allowed
string
Allowed values: PERSON ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT OFFICE PPE UNIT
data

Additional structured data in JSON format.

object
subtenant_id
required

The office (work location) of this subscription. Pass the office_id.

string format: uuid
tenant_id
required

The project (company) of this subscription. Pass the project_id.

string format: uuid
Example
{
  "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
  "subscriber_id": "e3a1f5d2-8c4b-4e7a-9f6d-2b1c3d4e5f6a",
  "subscriber_type": "PERSON",
  "subtenant_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01"
}

Responses

Section titled “ Responses ”
201
Section titled “201 ”

Compliance schedule entry created successfully

object
action_subscription_id

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

string format: uuid
action_id
required

The preventive action this resource is subscribed to. Pass the action_id obtained from the Action API. If unknown, search via the Action index filtering by subtenant_id and name or action_type.

string format: uuid
subscriber_id
required

The ID of the subscribed resource. What to pass depends on subscriber_type:

  • PERSON: pass the person_id
  • EQUIPMENT: pass the office_equipment_id
  • WORK_ENVIRONMENT: pass the office_work_environment_id
  • SUBSTANCE: pass the office_substance_id
  • ROLE: pass the office_role_id
  • WORK_GROUP: pass the work_group_id
  • OFFICE: pass the office_id
  • PPE: pass the material_item_id
  • UNIT: pass the unit_id (supplier)
string format: uuid
subscriber_type
required

The type of subscribed resource. Must be compatible with the action’s action_type:

  • For TRAINING, HEALTH, PER actions: must be PERSON
  • For MAINTENANCE actions: can be EQUIPMENT, WORK_ENVIRONMENT, PPE, OFFICE
  • For CHECK actions: any type is allowed
string
Allowed values: PERSON ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT OFFICE PPE UNIT
data

Additional structured data in JSON format.

object
subtenant_id
required

The office (work location) of this subscription. Pass the office_id.

string format: uuid
tenant_id
required

The project (company) of this subscription. Pass the project_id.

string format: uuid
Example
{
  "action_subscription_id": "d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a",
  "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
  "subscriber_id": "e3a1f5d2-8c4b-4e7a-9f6d-2b1c3d4e5f6a",
  "subscriber_type": "PERSON",
  "subtenant_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01"
}

view

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

Retrieves a single compliance schedule entry by its ID.

Authorizations

Section titled “Authorizations ”

Path Parameters

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

The action_subscription_id to retrieve.

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Compliance schedule entry found

object
action_subscription_id

Unique identifier of the subscription.

string format: uuid
action_id

The preventive action this resource is subscribed to.

string format: uuid
action_type

Type of the linked action.

string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
action_code

Code of the linked action.

string
action_name

Name of the linked action.

string
subscriber_id

The ID of the subscribed resource.

string format: uuid
subscriber_type

The type of subscribed resource.

string
Allowed values: PERSON ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT OFFICE PPE UNIT
subscriber_code

Code of the subscribed resource.

string
subscriber_name

Name of the subscribed resource.

string
last_certificate_id

ID of the most recent certificate linked to this subscription.

string format: uuid
certificate_date_release

Issue date of the most recent certificate.

string format: date
certificate_date_expire

Expiration date of the most recent certificate.

string format: date
last_action_session_subscription_id

ID of the most recent session subscription.

string format: uuid
date_latest_session

Date of the most recent scheduled session.

string format: date
status

Compliance status of the subscription (automatically calculated):

  • NEW: no certificate exists
  • VALID: a valid (not expired) certificate exists
  • EXPIRING: the certificate is about to expire (within expire_interval days)
  • EXPIRED: the certificate has expired
string
Allowed values: NEW VALID EXPIRED EXPIRING
office_name

Name of the office.

string
project_name

Name of the project (company).

string
project_type

Type of the parent project.

string
Allowed values: safety template
subtenant_id

The office (work location) of this subscription.

string format: uuid
tenant_id

The project (company) of this subscription.

string format: uuid
owned_active

Whether this subscription is currently active in its validity period.

boolean
nullable
parent_active

Whether the parent entities (action, office) are currently active.

boolean
nullable
project_status

Status of the parent project.

string
Allowed values: active suspended pending_delete deleted
subscription_status

Status of the project subscription (billing).

string
Allowed values: active trial refused expiring
certificate_action_approvals_count

Number of certificate-action approvals for this subscription.

integer
manager

Action managers (JSON).

string format: json
assignee

Action assignees (JSON).

string format: json
watcher

Action watchers (JSON).

string format: json
Example
{
  "action_subscription_id": "d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a",
  "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
  "action_type": "TRAINING",
  "action_code": "FST-01",
  "action_name": "Fire Safety Training Medium Risk",
  "subscriber_id": "e3a1f5d2-8c4b-4e7a-9f6d-2b1c3d4e5f6a",
  "subscriber_type": "PERSON",
  "subscriber_code": "JS001",
  "subscriber_name": "Smith John",
  "status": "EXPIRED",
  "last_certificate_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  "certificate_date_release": "2020-01-15",
  "certificate_date_expire": "2025-01-15",
  "subtenant_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01",
  "office_name": "Rome North Site",
  "project_name": "Acme Construction Ltd",
  "owned_active": true,
  "parent_active": true
}
404
Section titled “404 ”

Compliance schedule entry not found

update

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

Updates an existing compliance schedule entry.

Authorizations

Section titled “Authorizations ”

Path Parameters

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

The action_subscription_id to update.

Request Body required

Section titled “Request Body required ”

Fields to update

object
action_subscription_id

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

string format: uuid
action_id
required

The preventive action this resource is subscribed to. Pass the action_id obtained from the Action API. If unknown, search via the Action index filtering by subtenant_id and name or action_type.

string format: uuid
subscriber_id
required

The ID of the subscribed resource. What to pass depends on subscriber_type:

  • PERSON: pass the person_id
  • EQUIPMENT: pass the office_equipment_id
  • WORK_ENVIRONMENT: pass the office_work_environment_id
  • SUBSTANCE: pass the office_substance_id
  • ROLE: pass the office_role_id
  • WORK_GROUP: pass the work_group_id
  • OFFICE: pass the office_id
  • PPE: pass the material_item_id
  • UNIT: pass the unit_id (supplier)
string format: uuid
subscriber_type
required

The type of subscribed resource. Must be compatible with the action’s action_type:

  • For TRAINING, HEALTH, PER actions: must be PERSON
  • For MAINTENANCE actions: can be EQUIPMENT, WORK_ENVIRONMENT, PPE, OFFICE
  • For CHECK actions: any type is allowed
string
Allowed values: PERSON ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT OFFICE PPE UNIT
data

Additional structured data in JSON format.

object
subtenant_id
required

The office (work location) of this subscription. Pass the office_id.

string format: uuid
tenant_id
required

The project (company) of this subscription. Pass the project_id.

string format: uuid
Example
{
  "data": {
    "note": "Needs urgent renewal"
  }
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Compliance schedule entry updated successfully

object
action_subscription_id

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

string format: uuid
action_id
required

The preventive action this resource is subscribed to. Pass the action_id obtained from the Action API. If unknown, search via the Action index filtering by subtenant_id and name or action_type.

string format: uuid
subscriber_id
required

The ID of the subscribed resource. What to pass depends on subscriber_type:

  • PERSON: pass the person_id
  • EQUIPMENT: pass the office_equipment_id
  • WORK_ENVIRONMENT: pass the office_work_environment_id
  • SUBSTANCE: pass the office_substance_id
  • ROLE: pass the office_role_id
  • WORK_GROUP: pass the work_group_id
  • OFFICE: pass the office_id
  • PPE: pass the material_item_id
  • UNIT: pass the unit_id (supplier)
string format: uuid
subscriber_type
required

The type of subscribed resource. Must be compatible with the action’s action_type:

  • For TRAINING, HEALTH, PER actions: must be PERSON
  • For MAINTENANCE actions: can be EQUIPMENT, WORK_ENVIRONMENT, PPE, OFFICE
  • For CHECK actions: any type is allowed
string
Allowed values: PERSON ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT OFFICE PPE UNIT
data

Additional structured data in JSON format.

object
subtenant_id
required

The office (work location) of this subscription. Pass the office_id.

string format: uuid
tenant_id
required

The project (company) of this subscription. Pass the project_id.

string format: uuid
Example
{
  "action_subscription_id": "d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a",
  "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
  "subscriber_id": "e3a1f5d2-8c4b-4e7a-9f6d-2b1c3d4e5f6a",
  "subscriber_type": "PERSON"
}
404
Section titled “404 ”

Compliance schedule entry not found

delete

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

Deletes a compliance schedule entry.

If force=false (default), the response lists child entities. If force=true, the entry and all related entities are deleted.

Authorizations

Section titled “Authorizations ”

Path Parameters

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

The action_subscription_id to delete.

Query Parameters

Section titled “Query Parameters ”
force
boolean

If true, deletes the entry and all child entities. If false, returns a preview of affected entities.

Responses

Section titled “ Responses ”
204
Section titled “204 ”

Compliance schedule entry deleted successfully

400
Section titled “400 ”

Preview of entities that would be deleted (returned when force=false)

Webhooks

Section titled “Webhooks”

ACTION_SUBSCRIPTION::CREATE

Section titled “ACTION_SUBSCRIPTION::CREATE”
POST

Triggered when a new compliance schedule entry is created.

Request Body

Section titled “Request Body ”

The newly created subscription

object
action_subscription_id

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

string format: uuid
action_id
required

The preventive action this resource is subscribed to. Pass the action_id obtained from the Action API. If unknown, search via the Action index filtering by subtenant_id and name or action_type.

string format: uuid
subscriber_id
required

The ID of the subscribed resource. What to pass depends on subscriber_type:

  • PERSON: pass the person_id
  • EQUIPMENT: pass the office_equipment_id
  • WORK_ENVIRONMENT: pass the office_work_environment_id
  • SUBSTANCE: pass the office_substance_id
  • ROLE: pass the office_role_id
  • WORK_GROUP: pass the work_group_id
  • OFFICE: pass the office_id
  • PPE: pass the material_item_id
  • UNIT: pass the unit_id (supplier)
string format: uuid
subscriber_type
required

The type of subscribed resource. Must be compatible with the action’s action_type:

  • For TRAINING, HEALTH, PER actions: must be PERSON
  • For MAINTENANCE actions: can be EQUIPMENT, WORK_ENVIRONMENT, PPE, OFFICE
  • For CHECK actions: any type is allowed
string
Allowed values: PERSON ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT OFFICE PPE UNIT
data

Additional structured data in JSON format.

object
subtenant_id
required

The office (work location) of this subscription. Pass the office_id.

string format: uuid
tenant_id
required

The project (company) of this subscription. Pass the project_id.

string format: uuid
Example
{
  "action_subscription_id": "d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a",
  "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
  "subscriber_id": "e3a1f5d2-8c4b-4e7a-9f6d-2b1c3d4e5f6a",
  "subscriber_type": "PERSON",
  "subtenant_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Acknowledgment of the webhook event

ACTION_SUBSCRIPTION::DELETE

Section titled “ACTION_SUBSCRIPTION::DELETE”
POST

Triggered when a compliance schedule entry is deleted.

Request Body

Section titled “Request Body ”

The deleted subscription

object
action_subscription_id

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

string format: uuid
action_id
required

The preventive action this resource is subscribed to. Pass the action_id obtained from the Action API. If unknown, search via the Action index filtering by subtenant_id and name or action_type.

string format: uuid
subscriber_id
required

The ID of the subscribed resource. What to pass depends on subscriber_type:

  • PERSON: pass the person_id
  • EQUIPMENT: pass the office_equipment_id
  • WORK_ENVIRONMENT: pass the office_work_environment_id
  • SUBSTANCE: pass the office_substance_id
  • ROLE: pass the office_role_id
  • WORK_GROUP: pass the work_group_id
  • OFFICE: pass the office_id
  • PPE: pass the material_item_id
  • UNIT: pass the unit_id (supplier)
string format: uuid
subscriber_type
required

The type of subscribed resource. Must be compatible with the action’s action_type:

  • For TRAINING, HEALTH, PER actions: must be PERSON
  • For MAINTENANCE actions: can be EQUIPMENT, WORK_ENVIRONMENT, PPE, OFFICE
  • For CHECK actions: any type is allowed
string
Allowed values: PERSON ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT OFFICE PPE UNIT
data

Additional structured data in JSON format.

object
subtenant_id
required

The office (work location) of this subscription. Pass the office_id.

string format: uuid
tenant_id
required

The project (company) of this subscription. Pass the project_id.

string format: uuid
Example
{
  "action_subscription_id": "d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a",
  "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
  "subscriber_id": "e3a1f5d2-8c4b-4e7a-9f6d-2b1c3d4e5f6a",
  "subscriber_type": "PERSON",
  "subtenant_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Acknowledgment of the webhook event