CertificateAction

A CertificateAction links a certificate to a specific action, proving that the certificate satisfies that compliance requirement. It is the connection between the proof of compliance (the certificate) and the required action.

Requires an existing certificate and an existing action within the same project.

After creation, the system automatically recalculates the compliance status of matching compliance schedule entries (ActionSubscription) for the same action and the same resource as the certificate. Without this link, the certificate exists but has no effect on the compliance schedule.

The date_expire field is the expiration date specific to this link. If not provided, it is inherited from the certificate’s expiration date. The is_date_inherited field in responses indicates whether the date belongs to this link or is inherited from the certificate.

Use this API to:

Link a certificate to an action after creating the certificate
Find all certificate-action links for a certificate or an action
Check which certificate covers which action for a resource

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

AccessToken

Security scheme type: apiKey

Query parameter name: access-token

Operations

index

POST

/v2/certificate-action/index

Returns a paginated list of certificate-action links.

Most useful filters:

certificate_id: all links for a specific certificate
action_id: all certificates linked to an action
action_type: filter by requirement type
resource_id: all links for a specific resource

Authorizations

OAuth2
AccessToken

Request Body

Parameters for searching certificate-action links

object

filter

object

certificate_action_id

Unique identifier of the link.

string format: uuid

certificate_id

The linked certificate.

string format: uuid

action_id

The linked action.

string format: uuid

date_expire

Expiration date. May be inherited from the certificate if not set on this link.

string format: date

tenant_id

The project (company) this link belongs to.

string format: uuid

action_name

Name of the linked action.

string

action_code

Code of the linked action.

string

action_type

Type of the linked action.

string

Allowed values: TRAINING HEALTH PER CHECK MAINTENANCE

resource_id

The resource the certificate is issued to (from the certificate).

string format: uuid

certificate_name

Name of the linked certificate.

string

is_date_inherited

Whether date_expire is inherited from the certificate (1) or set on this link (0).

integer

date_release

Issue date of the linked certificate.

string format: date

office_name

Name of the office where the action is defined.

string

office_id

ID of the office where the action is defined.

string format: uuid

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_expire”).

string

Allowed values: certificate_action_id action_code action_name action_type resource_id certificate_name date_expire date_release office_name

Example

{
  "filter": {
    "action_type": "TRAINING",
    "certificate_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c"
  },
  "per-page": 10,
  "page": 1,
  "sort": "action_name"
}

Responses

200

List of certificate-action links

Array<object>

object

certificate_action_id

Unique identifier of the link.

string format: uuid

certificate_id

The linked certificate.

string format: uuid

action_id

The linked action.

string format: uuid

date_expire

Expiration date. May be inherited from the certificate if not set on this link.

string format: date

tenant_id

The project (company) this link belongs to.

string format: uuid

action_name

Name of the linked action.

string

action_code

Code of the linked action.

string

action_type

Type of the linked action.

string

Allowed values: TRAINING HEALTH PER CHECK MAINTENANCE

resource_id

The resource the certificate is issued to (from the certificate).

string format: uuid

certificate_name

Name of the linked certificate.

string

is_date_inherited

Whether date_expire is inherited from the certificate (1) or set on this link (0).

integer

date_release

Issue date of the linked certificate.

string format: date

office_name

Name of the office where the action is defined.

string

office_id

ID of the office where the action is defined.

string format: uuid

Example

[
  {
    "certificate_action_id": "a8b9c0d1-e2f3-4a5b-6c7d-8e9f0a1b2c3d",
    "certificate_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
    "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
    "date_expire": "2029-01-15",
    "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01",
    "action_name": "Fire Safety Training Medium Risk",
    "action_code": "FST-01",
    "action_type": "TRAINING",
    "resource_id": "e3a1f5d2-8c4b-4e7a-9f6d-2b1c3d4e5f6a",
    "certificate_name": "Fire Safety Training Certificate",
    "date_release": "2024-01-15",
    "is_date_inherited": 0,
    "office_name": "Rome North Site",
    "office_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
]

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/certificate-action/create

Creates a new certificate-action link.

Requires certificate_id, action_id, and tenant_id (project_id). The certificate_action_id is auto-generated if not provided.

After creation, the system automatically updates the compliance status of matching schedule entries. This is the step that actually transitions a subscription from NEW or EXPIRED to VALID.

The date_expire field is optional: if not provided, the expiration is inherited from the certificate.

Authorizations

OAuth2
AccessToken

Request Body^required

Certificate-action link to create

object

certificate_action_id

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

string format: uuid

certificate_id

required

The certificate being linked. Pass the certificate_id obtained from the Certificate API.

string format: uuid

action_id

required

The action the certificate is linked to. Pass the action_id obtained from the Action API.

string format: uuid

date_expire

Expiration date specific to this link. If not provided, inherited from the certificate’s expiration date.

string format: date

tenant_id

required

The project (company) this link belongs to. Pass the project_id.

string format: uuid

Example

{
  "certificate_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
  "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01"
}

Responses

201

Certificate-action link created successfully

object

certificate_action_id

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

string format: uuid

certificate_id

required

The certificate being linked. Pass the certificate_id obtained from the Certificate API.

string format: uuid

action_id

required

The action the certificate is linked to. Pass the action_id obtained from the Action API.

string format: uuid

date_expire

Expiration date specific to this link. If not provided, inherited from the certificate’s expiration date.

string format: date

tenant_id

required

The project (company) this link belongs to. Pass the project_id.

string format: uuid

Example

{
  "certificate_action_id": "a8b9c0d1-e2f3-4a5b-6c7d-8e9f0a1b2c3d",
  "certificate_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
  "date_expire": "2029-01-15",
  "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01"
}

view

GET

/v2/certificate-action/view/{id}

Retrieves a single certificate-action link by its ID.

Authorizations

OAuth2
AccessToken

Path Parameters

required

string format: uuid

The certificate_action_id to retrieve.

Responses

200

Certificate-action link found

object

certificate_action_id

Unique identifier of the link.

string format: uuid

certificate_id

The linked certificate.

string format: uuid

action_id

The linked action.

string format: uuid

date_expire

Expiration date. May be inherited from the certificate if not set on this link.

string format: date

tenant_id

The project (company) this link belongs to.

string format: uuid

action_name

Name of the linked action.

string

action_code

Code of the linked action.

string

action_type

Type of the linked action.

string

Allowed values: TRAINING HEALTH PER CHECK MAINTENANCE

resource_id

The resource the certificate is issued to (from the certificate).

string format: uuid

certificate_name

Name of the linked certificate.

string

is_date_inherited

Whether date_expire is inherited from the certificate (1) or set on this link (0).

integer

date_release

Issue date of the linked certificate.

string format: date

office_name

Name of the office where the action is defined.

string

office_id

ID of the office where the action is defined.

string format: uuid

Example

{
  "certificate_action_id": "a8b9c0d1-e2f3-4a5b-6c7d-8e9f0a1b2c3d",
  "certificate_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
  "date_expire": "2029-01-15",
  "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01",
  "action_name": "Fire Safety Training Medium Risk",
  "action_code": "FST-01",
  "action_type": "TRAINING",
  "resource_id": "e3a1f5d2-8c4b-4e7a-9f6d-2b1c3d4e5f6a",
  "certificate_name": "Fire Safety Training Certificate",
  "date_release": "2024-01-15",
  "is_date_inherited": 0,
  "office_name": "Rome North Site",
  "office_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

404

Certificate-action link not found

update

PUT

/v2/certificate-action/update/{id}

Updates an existing certificate-action link.

Typical use case: changing the date_expire specific to this link.

Authorizations

OAuth2
AccessToken

Path Parameters

required

string format: uuid

The certificate_action_id to update.

Request Body^required

Fields to update

object

certificate_action_id

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

string format: uuid

certificate_id

required

The certificate being linked. Pass the certificate_id obtained from the Certificate API.

string format: uuid

action_id

required

The action the certificate is linked to. Pass the action_id obtained from the Action API.

string format: uuid

date_expire

Expiration date specific to this link. If not provided, inherited from the certificate’s expiration date.

string format: date

tenant_id

required

The project (company) this link belongs to. Pass the project_id.

string format: uuid

Example

{
  "date_expire": "2030-01-15"
}

Responses

200

Certificate-action link updated successfully

object

certificate_action_id

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

string format: uuid

certificate_id

required

The certificate being linked. Pass the certificate_id obtained from the Certificate API.

string format: uuid

action_id

required

The action the certificate is linked to. Pass the action_id obtained from the Action API.

string format: uuid

date_expire

Expiration date specific to this link. If not provided, inherited from the certificate’s expiration date.

string format: date

tenant_id

required

The project (company) this link belongs to. Pass the project_id.

string format: uuid

Example

{
  "certificate_action_id": "a8b9c0d1-e2f3-4a5b-6c7d-8e9f0a1b2c3d",
  "date_expire": "2030-01-15"
}

404

Certificate-action link not found

delete

DELETE

/v2/certificate-action/delete/{id}

Deletes a certificate-action link.

After deletion, the system automatically recalculates the compliance status of matching schedule entries. This may cause a subscription to revert to EXPIRED or NEW.

If force=false (default), the response lists related entities. If force=true, the link is deleted.

Authorizations

OAuth2
AccessToken

Path Parameters

required

string format: uuid

The certificate_action_id to delete.

Query Parameters

force

boolean

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

Responses

204

Certificate-action link deleted successfully

400

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

Webhooks

CERTIFICATE_ACTION::CREATE

POST

Triggered when a new certificate-action link is created.

Request Body

The newly created certificate-action link

object

certificate_action_id

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

string format: uuid

certificate_id

required

The certificate being linked. Pass the certificate_id obtained from the Certificate API.

string format: uuid

action_id

required

The action the certificate is linked to. Pass the action_id obtained from the Action API.

string format: uuid

date_expire

Expiration date specific to this link. If not provided, inherited from the certificate’s expiration date.

string format: date

tenant_id

required

The project (company) this link belongs to. Pass the project_id.

string format: uuid

Example

{
  "certificate_action_id": "a8b9c0d1-e2f3-4a5b-6c7d-8e9f0a1b2c3d",
  "certificate_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
  "date_expire": "2029-01-15",
  "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01"
}

Responses

200

Acknowledgment of the webhook event

CERTIFICATE_ACTION::UPDATE

POST

Triggered when a certificate-action link is updated. Provides old/new values for changed fields.

Request Body

Updated certificate-action with old and new values for changed fields

object

entity_id

required

The certificate_action_id of the updated link.

string format: uuid

updated_fields

required

Each key is an updated field name, with its old and new values.

object

key

additional properties

object

old

new

Example

{
  "entity_id": "a8b9c0d1-e2f3-4a5b-6c7d-8e9f0a1b2c3d",
  "updated_fields": {
    "date_expire": {
      "old": "2029-01-15",
      "new": "2030-01-15"
    }
  }
}

Responses

200

Acknowledgment of the webhook event

CERTIFICATE_ACTION::DELETE

POST

Triggered when a certificate-action link is deleted.

Request Body

The deleted certificate-action link

object

certificate_action_id

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

string format: uuid

certificate_id

required

The certificate being linked. Pass the certificate_id obtained from the Certificate API.

string format: uuid

action_id

required

The action the certificate is linked to. Pass the action_id obtained from the Action API.

string format: uuid

date_expire

Expiration date specific to this link. If not provided, inherited from the certificate’s expiration date.

string format: date

tenant_id

required

The project (company) this link belongs to. Pass the project_id.

string format: uuid

Example

{
  "certificate_action_id": "a8b9c0d1-e2f3-4a5b-6c7d-8e9f0a1b2c3d",
  "certificate_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  "action_id": "c4d5e6f7-a8b9-0c1d-2e3f-4a5b6c7d8e9f",
  "tenant_id": "b5a7d602-3fc9-4e2a-9d1a-6e5b4c8f7a01"
}

Responses

200

Acknowledgment of the webhook event

CertificateAction

Authentication

OAuth2

AccessToken

Operations

index

Authorizations

Request Body

Example

Responses

200

Example

Headers

create

Authorizations

Request Body required

Example

Responses

201

Example

view

Authorizations

Path Parameters

Responses

200

Example

404

update

Authorizations

Path Parameters

Request Body required

Example

Responses

200

Example

404

delete

Authorizations

Path Parameters

Query Parameters

Responses

204

400

Webhooks

CERTIFICATE_ACTION::CREATE

Request Body

Example

Responses

200

CERTIFICATE_ACTION::UPDATE

Request Body

Example

Responses

200

CERTIFICATE_ACTION::DELETE

Request Body

Example

Responses

200

Request Body^required

Request Body^required