CertificateAction

Manage certificate actions, which represent the association between certificates and actions (such as training, maintenance, or health checks).
You can create, update, delete, and search for certificate actions with advanced filtering and pagination.

Version: 2.0.0
OpenAPI version: 3.1.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 and filterable list of certificate actions.
Use POST to allow complex filters via JSON payload.

Authorizations

OAuth2
AccessToken

Request Body

Parameters for searching certificate actions

object

filter

object

certificate_action_id

string

certificate_id

string

action_id

string

date_expire

string format: date

tenant_id

string

action_name

string

action_code

string

action_type

string

Allowed values: TRAINING HEALTH PER CHECK MAINTENANCE

resource_id

string format: uuid

certificate_name

string

is_date_inherited

integer

date_release

string format: date

office_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": {
    "action_type": "TRAINING"
  },
  "per-page": 10,
  "page": 1,
  "sort": "action_name"
}

Responses

200

List of certificate actions

Array<object>

object

certificate_action_id

string

certificate_id

string

action_id

string

date_expire

string format: date

tenant_id

string

action_name

string

action_code

string

action_type

string

Allowed values: TRAINING HEALTH PER CHECK MAINTENANCE

resource_id

string format: uuid

certificate_name

string

is_date_inherited

integer

date_release

string format: date

office_name

string

Example

{
  "certificate_action_id": "ca-1",
  "certificate_id": "cert-1",
  "action_id": "act-1",
  "date_expire": "2024-12-31",
  "tenant_id": "ten-1",
  "action_name": "Safety Training",
  "action_code": "A001",
  "action_type": "TRAINING",
  "resource_id": "res-1",
  "certificate_name": "Certificate of Completion",
  "is_date_inherited": 0,
  "date_release": "2024-01-01",
  "office_name": "Main Office"
}

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

Create a new certificate action by providing the required details.

Authorizations

OAuth2
AccessToken

Request Body^required

Certificate action object to be created

object

certificate_action_id

string

certificate_id

string

action_id

string

date_expire

string format: date-time

tenant_id

string

Example

{
  "certificate_id": "cert-1",
  "action_id": "act-1",
  "date_expire": "2024-12-31",
  "tenant_id": "ten-1"
}

Responses

201

Certificate action created successfully

object

certificate_action_id

string

certificate_id

string

action_id

string

date_expire

string format: date-time

tenant_id

string

Example

{
  "certificate_action_id": "ca-1",
  "certificate_id": "cert-1",
  "action_id": "act-1",
  "date_expire": "2024-12-31",
  "tenant_id": "ten-1"
}

view

GET

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

Retrieve a certificate action by its unique ID.

Authorizations

OAuth2
AccessToken

Path Parameters

required

string format: uuid

ID of the certificate action to retrieve

Responses

200

Certificate action found

object

certificate_action_id

string

certificate_id

string

action_id

string

date_expire

string format: date

tenant_id

string

action_name

string

action_code

string

action_type

string

Allowed values: TRAINING HEALTH PER CHECK MAINTENANCE

resource_id

string format: uuid

certificate_name

string

is_date_inherited

integer

date_release

string format: date

office_name

string

Example

{
  "certificate_action_id": "ca-1",
  "certificate_id": "cert-1",
  "action_id": "act-1",
  "date_expire": "2024-12-31",
  "tenant_id": "ten-1",
  "action_name": "Safety Training",
  "action_code": "A001",
  "action_type": "TRAINING",
  "resource_id": "res-1",
  "certificate_name": "Certificate of Completion",
  "is_date_inherited": 0,
  "date_release": "2024-01-01",
  "office_name": "Main Office"
}

404

Certificate action not found

delete

DELETE

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

Delete a certificate action by its unique ID.
If force=true, all related entities will also be deleted.

Authorizations

OAuth2
AccessToken

Path Parameters

required

string format: uuid

ID of the certificate action to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Certificate action 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/certificate-action/update/{id}

Update an existing certificate action by its unique ID.

Authorizations

OAuth2
AccessToken

Path Parameters

required

string format: uuid

ID of the certificate action to update

Request Body^required

Certificate action object with updated data

object

certificate_action_id

string

certificate_id

string

action_id

string

date_expire

string format: date-time

tenant_id

string

Example

{
  "date_expire": "2025-12-31"
}

Responses

200

Certificate action updated successfully

object

certificate_action_id

string

certificate_id

string

action_id

string

date_expire

string format: date-time

tenant_id

string

Example

{
  "certificate_action_id": "ca-1",
  "date_expire": "2025-12-31"
}

404

Certificate action not found

Webhooks

CERTIFICATE_ACTION::CREATE

POST

This webhook is triggered when a new certificate-action is created in the system. It provides the details of the newly created certificate-action.

Request Body

Information about the newly created certificate-action

object

certificate_action_id

string

certificate_id

string

action_id

string

date_expire

string format: date-time

tenant_id

string

Example

{
  "certificate_action_id": "ca-1",
  "certificate_id": "cert-1",
  "action_id": "act-1",
  "date_expire": "2024-12-31",
  "tenant_id": "ten-1"
}

Responses

200

Acknowledgment of the webhook event

CERTIFICATE_ACTION::UPDATE

POST

This webhook is triggered when a certificate-action is updated in the system. It provides the unique ID of the certificate-action and an object containing the old and new values for each updated field.

Request Body

Information about the updated certificate-action, with old and new values for the changed properties.

object

entity_id

required

The unique ID of the updated certificate-action.

string format: uuid

updated_fields

required

An object where each key is the name of an updated field, and its value contains the old and new values.

object

key

additional properties

Provides the old and new value for a property. The type of the values depends on the specific property.

object

old

new

Example

{
  "entity_id": "d9a77e06-9b47-4829-b28a-c7561deac771",
  "updated_fields": {
    "date_expire": {
      "old": "2024-12-31",
      "new": "2025-12-31"
    }
  }
}

Responses

200

Acknowledgment of the webhook event

CERTIFICATE_ACTION::DELETE

POST

This webhook is triggered when a certificate-action is deleted from the system. It provides the deleted certificate-action.

Request Body

Information about the deleted certificate-action

object

certificate_action_id

string

certificate_id

string

action_id

string

date_expire

string format: date-time

tenant_id

string

Example

{
  "certificate_action_id": "ca-1",
  "certificate_id": "cert-1",
  "action_id": "act-1",
  "date_expire": "2024-12-31",
  "tenant_id": "ten-1"
}

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

delete

Authorizations

Path Parameters

Query Parameters

Responses

204

400

update

Authorizations

Path Parameters

Request Body required

Example

Responses

200

Example

404

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