/
Deleting Data Import Logs via API

Deleting Data Import Logs via API

Owned by Jennifer Eustis
Sep 13, 2024

To delete Data Import logs the following endpoint can be used:

Method

URL

ContentType

Description

DELETE

/change-manager/jobExecutions

application/json

Marks for deletion specified ids of DI logs

 

Body of the request should contain a list of log IDs that should be deleted (see example below):

{
    "ids": ["c4908351-f963-4575-9aa5-38e56f83e94e", "9ba1fde2-114e-4e63-937f-2e9c4c431787"]
}

 

Example of the request:

curl --location --request DELETE 'https://okapi-bugfest-mg.int.aws.folio.org/change-manager/jobExecutions' \
--header 'x-okapi-tenant: fs09000000' \
--header 'x-okapi-token: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJmb2xpbyIsInR5cGUiOiJsZWdhY3ktYWNjZXNzIiwidXNlcl9pZCI6IjllYjY3MzAxLTZmNmUtNDY4Zi05YjFhLTYxMzRkYzM5YTY4NCIsImlhdCI6MTY1OTUxMzA3NywidGVuYW50IjoiZnMwOTAwMDAwMCJ9.NJ4o4CQ0TgI6StbWsmvp8iOlHCb_xLLH1H8wse24chM' \
--header 'content-type: application/json' \
--data-raw '{
    "ids": ["c4908351-f963-4575-9aa5-38e56f83e94a", "9ba1fde2-114e-4e63-937f-2e9c4c431787"]
}'

** The user performing this operation should have "change-manager.jobexecutions.delete" permission assigned

 

Successful response would have 200 status and information about logs marked for deletion

{
    "jobExecutionDetails": [
        {
            "jobExecutionId": "c4908351-f963-4575-9aa5-38e56f83e94e",
            "isDeleted": true
        },
        {
            "jobExecutionId": "9ba1fde2-114e-4e63-937f-2e9c4c431787",
            "isDeleted": true
        }
    ]
}

 

Please note that DI logs are not deleted from the DB instantaneously, instead they are marked as "DELETED". Hard deletion of DI logs happens periodically - every 24h by default, but this frequency can be configured by setting "periodic.job.execution.permanent.delete.interval.ms" for mod-source-record-manager to a different value in milliseconds.