Import Data

Overview

The Import API allows you to import multiple records in a single request. The number of records you can import at once depends on the total data size, with a maximum payload limit of 100MB per request.

This API is designed for efficient batch data synchronization, making it suitable for scenarios where you need to upload or update a moderate amount of data programmatically. By leveraging this API, you can streamline your data integration processes, reduce manual intervention, and ensure that your application data remains up-to-date. It is recommended to structure your data and field mappings carefully to maximize import efficiency and maintain data integrity. If your data volume exceeds the 100MB limit, consider splitting your data into multiple requests or batches.

Request

Import Data

POST /{Category}/{Entity}/import

Below is an example of a JSON request for importing application data:

Import Data Request

{
  "list": [
    {
      "filter": {
        "entityId": "BNF12345"
      },
      "data": {
        "email": "johndoe@google.com",
        "phone": "555-1234-4567",
        "phone2": "555-5678-2345",
        "data": {
          "customField1": "name",
          "customField2": 1234
        }
      }
    },
    {
      "filter": {
        "entityId": "BNF12346"
      },
      "data": {
        "email": "johndoe@google.com",
        "phone": "555-1234-4567",
        "phone2": "555-5678-2345",
        "data": {
          "customField1": "name",
          "customField2": 1234
        }
      }
    }
  ],
  "actionUser": "test@mct.com",
  "actionDescription": "test api",
  "actionSource": "postman client"
}

Note

The Filter field is required in the request body. Filter is used to specify the criteria for selecting the target data records to be imported or updated, typically including fields such as entityId or other unique identifiers. If the Filter field is not properly filled in, the system may not be able to accurately locate the target data, and in extreme cases, it may result in unintended replacement or update of a large amount of data, causing data confusion or loss. Therefore, it is essential to provide a clear and unique Filter condition for each data entry to ensure the accuracy and security of data synchronization. When performing batch imports, it is recommended to double-check the Filter field for each entry to avoid unexpected consequences due to omissions or errors. If a filter is provided but no data is found, a new record will be inserted.

Response

By returning a file object in the response, the Data Sync API ensures that users receive detailed, actionable information about their data synchronization requests.

Import Data Response

{
  "isSuccess": true,
  "data": {
    "actionId": "68701be727415f6189bb9f07"
  },
  "result": {
    "insertedCount": 0,
    "matchedCount": 0,
    "modifiedCount": 0,
    "deletedCount": 0,
    "upsertedCount": 2,
    "upsertedIds": {
      "0": "68701be7c157326e3c6debc9",
      "1": "68701be7c157326e3c6debca"
    },
    "insertedIds": {}
  }
}

Field Name	Type	Description
ActionId	String	Unique identifier for the performed action