Import Report

Each import report has a unique id and is created for each import or update and contains information about the status of the process, the validation report, a quality assessment report and which objects were identified in the sent payload.

You can check at any time the status of your successfully started import by calling the Import Status endpoint with the message id from the response.

The header flag X-DETAILED-REPORT can be used to receive the full detailed report.

check import status

curl --location --request GET 'https://proxy.opendatagermany.io/api/ts/v1/kg/things/imports/IMPORT_PROCESS_ID' \
--header 'X-DETAILED-REPORT: true' \
--header 'x-api-key: $API_KEY'

The most important fields of the import report are explained next:

Attribute	Values	Description
running	[ true	false ]	Is the process still running
verified	[ true	false ]	Was the import data already passing the verification step .
valid	[ true	false ]	Was the import data valid - if false, the import process will stop at that stage
stored	[ true	false ]	Was the data successfully stored in the KG platform
verificationReport	JSON Object	A detailed verification report that describes for each entity if the data was valid or if there were errors
qatResponse	JSON Object	The results of the quality assessment
affectedEntities	JSON Object	A list of internal IDs that were assigned to the entities in the import data

Especially the information about the affectedEntities is important since it contains the list of object identifiers which were either created by the system or found in the data together with the corresponding domain specification Uri.
Those identifiers are required to read, update or delete your data in the future.

Report for the running example

Below is an example import report for the insert of our LocalBusiness running example

Import Report for LocalBusiness example

{
    "id": "$IMPORT_REPORT_ID",
    "customer": "$PUBLISHER_UUID",
    "dataSource": "$DATASOURCE_UUID",
    "importStartTime": "2023-01-20T13:20:20.098",
    "processingDurationMs": 659,
    "verified": true,
    "valid": true,
    "stored": true,
    "running": false,
    "existingObjects": false,
    "importSize": 960,
    "operation": "CREATE",
    "numberOfStatements": 21,
    "qatResponse": {
        "score": 0.4,
        "details": {
            "3_1": "0",
            "4_3": "1",
            "6_1": "1",
            "11_2": "0",
            "13_2": "0"
        },
        "entityScores": [
            {
                "nodeId": "http://onlim.com/graph/e61c25eac9196ac984dd1c05d08b5bdc",
                "score": 0.4,
                "details": {
                    "3_1": "0",
                    "4_3": "1",
                    "6_1": "1",
                    "11_2": "0",
                    "13_2": "0"
                }
            },
            {
                "nodeId": "http://onlim.com/graph/prov",
                "score": 0.4,
                "details": {
                    "3_1": "0",
                    "4_3": "1",
                    "6_1": "1",
                    "11_2": "0",
                    "13_2": "0"
                }
            }
        ]
    },
    "verificationReport": {
        "isValid": true,
        "statusCode": 200,
        "reports": [
            {
                "nodeId": "http://example.com//entity/LB1",
                "usedDs": "https://semantify.it/ds/uGBhB9lBI",
                "verificationReport": {
                    "verificationResult": "Valid"
                }
            }
        ],
        "meta": {
            "numEntities": 1,
            "numVerifiedEntities": 1,
            "numNonVerifiedEntities": 0,
            "numValidEntities": 1,
            "numValidWithWarningEntities": 0,
            "numInvalidEntities": 0,
            "numTotalErrors": 0
        }
    },
    "affectedEntities": [
        {
            "id": "http://example.com/entity/LB1",
            "dsUri": "https://semantify.it/ds/uGBhB9lBI"
        },
        {
            "id": "http://onlim.com/entity/04ccf1a2-8ce7-4f63-9d44-c26fd9a61b49",
            "dsUri": "https://semantify.it/ds/NP8df6sKy"
        }
    ]
}

We see that the import was verifying the data (verified:true, valid:true) with the details of the verification report. The data was successfully stored (stored:true), there were no existing objects in the payload (existingObjects:false)and the processes was completed ( running: false).
In addition, the details of affectedEntities list that there was the external identifier http://example.com/entity/LB1 for the DS https://semantify.it/ds/uGBhB9lBI.