Skip to content
4HSE

Certificate

Represents a certificate that can be linked to various resources such as people, materials, or equipment. Includes key details like issue date, expiration date, result/outcome, and additional notes. Used to track compliance and qualification status across the organization.

Version
2.0.0
OpenAPI version
3.1.0

Operations

Section titled “Operations”

index

Section titled “index”
POST
/v2/certificate/index

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

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”

Parameters for searching certificates

object
filter
object
name
string
action_type
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
resource_id
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
warning
integer
Allowed values: 0 1 
{
  "name": "Certificate of Completion",
  "action_type": "TRAINING",
  "resource_id": "123e4567-e89b-12d3-a456-426655440000",
  "warning": 0,
  "validity_unit": "YEAR",
  "validity": 1
}
per-page
integer
default: 100 >= 1
page
integer
default: 1 >= 1
sort
string
Allowed values: date_release date_expire name action_type
history
boolean
Example
{
  "filter": {
    "name": "Certificate of Completion",
    "action_type": "TRAINING",
    "resource_id": "123e4567-e89b-12d3-a456-426655440000",
    "warning": 0,
    "validity_unit": "YEAR",
    "validity": 1
  },
  "per-page": 20,
  "page": 1,
  "sort": "name"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

List of certificates

Array<object>
object
certificate_id
required
string format: uuid
date_release
required
string format: date
date_expire
string format: date
name
required
string
<= 255 characters
note
string
action_type
required
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
resource_id
required
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
data
object
warning
integer
Allowed values: 0 1
tenant_id
required
string format: uuid
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
{
  "certificate_id": "123e4567-e89b-12d3-a456-426655440000",
  "date_release": "2022-01-01",
  "date_expire": "2023-01-01",
  "name": "Certificate of Completion",
  "note": "This certificate is valid for one year.",
  "action_type": "TRAINING",
  "resource_id": "123e4567-e89b-12d3-a456-426655440000",
  "data": {
    "additional_info": "This certificate was issued by the training department."
  },
  "warning": 0,
  "tenant_id": "123e4567-e89b-12d3-a456-426655440000",
  "validity_unit": "YEAR",
  "validity": 1
}
Example
{
  "certificate_id": "123e4567-e89b-12d3-a456-426655440000",
  "date_release": "2022-01-01",
  "date_expire": "2023-01-01",
  "name": "Certificate of Completion",
  "note": "This certificate is valid for one year.",
  "action_type": "TRAINING",
  "resource_id": "123e4567-e89b-12d3-a456-426655440000",
  "data": {
    "additional_info": "This certificate was issued by the training department."
  },
  "warning": 0,
  "tenant_id": "123e4567-e89b-12d3-a456-426655440000",
  "validity_unit": "YEAR",
  "validity": 1
}

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

view

Section titled “view”
GET
/v2/certificate/view/{id}

Retrieve a certificate by its unique ID.

Authorizations

Section titled “Authorizations ”

Path Parameters

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

ID of the certificate to retrieve

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Certificate found

object
certificate_id
required
string format: uuid
date_release
required
string format: date
date_expire
string format: date
name
required
string
<= 255 characters
note
string
action_type
required
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
resource_id
required
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
data
object
warning
integer
Allowed values: 0 1
tenant_id
required
string format: uuid
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
Example
{
  "certificate_id": "123e4567-e89b-12d3-a456-426655440000",
  "date_release": "2022-01-01",
  "date_expire": "2023-01-01",
  "name": "Certificate of Completion",
  "note": "This certificate is valid for one year.",
  "action_type": "TRAINING",
  "resource_id": "123e4567-e89b-12d3-a456-426655440000",
  "data": {
    "additional_info": "This certificate was issued by the training department."
  },
  "warning": 0,
  "tenant_id": "123e4567-e89b-12d3-a456-426655440000",
  "validity_unit": "YEAR",
  "validity": 1
}
404
Section titled “404 ”

Certificate not found

create

Section titled “create”
POST
/v2/certificate/create

Create a new certificate by providing the required details.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

Certificate object to be created

object
certificate_id
required
string format: uuid
date_release
required
string format: date
date_expire
string format: date
name
required
string
<= 255 characters
note
string
action_type
required
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
resource_id
required
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
data
object
warning
integer
Allowed values: 0 1
tenant_id
required
string format: uuid
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
Example
{
  "date_release": "2023-01-01",
  "name": "Certificate of Safety",
  "action_type": "TRAINING",
  "resource_id": "123e4567-e89b-12d3-a456-426655440000",
  "tenant_id": "123e4567-e89b-12d3-a456-426655440000",
  "validity_unit": "YEAR",
  "validity": 1
}

Responses

Section titled “ Responses ”
201
Section titled “201 ”

Certificate created successfully

object
certificate_id
required
string format: uuid
date_release
required
string format: date
date_expire
string format: date
name
required
string
<= 255 characters
note
string
action_type
required
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
resource_id
required
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
data
object
warning
integer
Allowed values: 0 1
tenant_id
required
string format: uuid
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
Example
{
  "certificate_id": "223e4567-e89b-12d3-a456-426655440000",
  "date_release": "2023-01-01",
  "name": "Certificate of Safety",
  "action_type": "TRAINING",
  "resource_id": "123e4567-e89b-12d3-a456-426655440000",
  "tenant_id": "123e4567-e89b-12d3-a456-426655440000",
  "validity_unit": "YEAR",
  "validity": 1
}

update

Section titled “update”
PUT
/v2/certificate/update/{id}

Update an existing certificate by its unique ID.

Authorizations

Section titled “Authorizations ”

Path Parameters

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

ID of the certificate to update

Request Body required

Section titled “Request Body required ”

Certificate object with updated data

object
certificate_id
required
string format: uuid
date_release
required
string format: date
date_expire
string format: date
name
required
string
<= 255 characters
note
string
action_type
required
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
resource_id
required
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
data
object
warning
integer
Allowed values: 0 1
tenant_id
required
string format: uuid
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
Example
{
  "name": "Updated Certificate",
  "validity": 2
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Certificate updated successfully

object
certificate_id
required
string format: uuid
date_release
required
string format: date
date_expire
string format: date
name
required
string
<= 255 characters
note
string
action_type
required
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
resource_id
required
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
data
object
warning
integer
Allowed values: 0 1
tenant_id
required
string format: uuid
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
Example
{
  "certificate_id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "Updated Certificate",
  "validity": 2
}
404
Section titled “404 ”

Certificate not found

delete

Section titled “delete”
DELETE
/v2/certificate/delete/{id}

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

Authorizations

Section titled “Authorizations ”

Path Parameters

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

ID of the certificate to delete

Query Parameters

Section titled “Query Parameters ”
force
boolean

Force the deletion of the entity and all related entities

Responses

Section titled “ Responses ”
204
Section titled “204 ”

Certificate deleted successfully

400
Section titled “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

Webhooks

Section titled “Webhooks”

CERTIFICATE::CREATE

Section titled “CERTIFICATE::CREATE”
POST

This webhook is triggered when a new certificate is created in the system.

Request Body

Section titled “Request Body ”

Information about the newly created certificate

object
certificate_id
required
string format: uuid
date_release
required
string format: date
date_expire
string format: date
name
required
string
<= 255 characters
note
string
action_type
required
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
resource_id
required
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
data
object
warning
integer
Allowed values: 0 1
tenant_id
required
string format: uuid
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
Example
{
  "certificate_id": "123e4567-e89b-12d3-a456-426655440000",
  "date_release": "2022-01-01",
  "date_expire": "2023-01-01",
  "name": "Certificate of Completion",
  "action_type": "TRAINING",
  "resource_id": "123e4567-e89b-12d3-a456-426655440000",
  "warning": 0,
  "tenant_id": "123e4567-e89b-12d3-a456-426655440000",
  "validity_unit": "YEAR",
  "validity": 1
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Acknowledgment of the webhook event

CERTIFICATE::UPDATE

Section titled “CERTIFICATE::UPDATE”
POST

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

Request Body

Section titled “Request Body ”

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

object
entity_id
required

The unique ID of the certificate.

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": {
    "name": {
      "old": "Old Certificate Name",
      "new": "New Certificate Name"
    },
    "date_expire": {
      "old": "2023-01-01",
      "new": "2024-01-01"
    }
  }
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Acknowledgment of the webhook event

CERTIFICATE::DELETE

Section titled “CERTIFICATE::DELETE”
POST

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

Request Body

Section titled “Request Body ”

Information about the deleted certificate

object
certificate_id
required
string format: uuid
date_release
required
string format: date
date_expire
string format: date
name
required
string
<= 255 characters
note
string
action_type
required
string
Allowed values: TRAINING MAINTENANCE HEALTH CHECK PER
resource_id
required
string
Allowed values: PERSON MATERIAL_ITEM ROLE WORK_GROUP WORK_ENVIRONMENT SUBSTANCE EQUIPMENT
data
object
warning
integer
Allowed values: 0 1
tenant_id
required
string format: uuid
validity_unit
string
Allowed values: YEAR MONTH DAY
validity
integer
Example
{
  "certificate_id": "123e4567-e89b-12d3-a456-426655440000",
  "date_release": "2022-01-01",
  "date_expire": "2023-01-01",
  "name": "Certificate of Completion",
  "action_type": "TRAINING",
  "resource_id": "123e4567-e89b-12d3-a456-426655440000",
  "warning": 0,
  "tenant_id": "123e4567-e89b-12d3-a456-426655440000",
  "validity_unit": "YEAR",
  "validity": 1
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Acknowledgment of the webhook event