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.0.0
Operations
Section titled “Operations” POST /v2/certificate-action/index
Returns a paginated and filterable list of certificate actions.
Use POST to allow complex filters via JSON payload.
Request Body
Section titled “Request Body ”Parameters for searching certificate actions
object
object
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
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.
Example
{ "filter": { "action_type": "TRAINING" }, "per-page": 10, "page": 1, "sort": "action_name"}Responses
Section titled “ Responses ”List of certificate actions
object
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
Section titled “Headers ”Current page
Total number of pages
Number of items per page
Total number of items
create
Section titled “create” POST /v2/certificate-action/create
Create a new certificate action by providing the required details.
Request Body required
Section titled “Request Body required ”Certificate action object to be created
object
Example
{ "certificate_id": "cert-1", "action_id": "act-1", "date_expire": "2024-12-31", "tenant_id": "ten-1"}Responses
Section titled “ Responses ”Certificate action created successfully
object
Example
{ "certificate_action_id": "ca-1", "certificate_id": "cert-1", "action_id": "act-1", "date_expire": "2024-12-31", "tenant_id": "ten-1"} GET /v2/certificate-action/view/{id}
Retrieve a certificate action by its unique ID.
Path Parameters
Section titled “Path Parameters ”ID of the certificate action to retrieve
Responses
Section titled “ Responses ”Certificate action found
object
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"}Certificate action not found
delete
Section titled “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.
Path Parameters
Section titled “Path Parameters ”ID of the certificate action to delete
Query Parameters
Section titled “Query Parameters ”Force the deletion of the entity and all related entities
Responses
Section titled “ Responses ”Certificate action deleted successfully
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
Section titled “update” PUT /v2/certificate-action/update/{id}
Update an existing certificate action by its unique ID.
Path Parameters
Section titled “Path Parameters ”ID of the certificate action to update
Request Body required
Section titled “Request Body required ”Certificate action object with updated data
object
Example
{ "date_expire": "2025-12-31"}Responses
Section titled “ Responses ”Certificate action updated successfully
object
Example
{ "certificate_action_id": "ca-1", "date_expire": "2025-12-31"}Certificate action not found