• Settings

Before using the API, you must edit the following attributes in the Settings tab:

• Check the Enabled attribute to enable the task.
• In the Users with API Access Permission, select one or more users with the Robot role who will have permission to run the task.
• In the Basic Entity for Import, select the entity you want to import.
• In the Matching Atribute, select the atribute to be used to link the existing values to the new ones.
• In the Attribute Mapping, select the attributes to import and optionally modify their JSON keys.
• We also recommend filling in the Emails for Notifications field, where you can enter one or more email addresses to which error notifications will be sent.

• Attributes

Settings

• Request

/v1/import/basic-entities/{task_id}

Parameter	Value
URL	?debug added to the URL will also display a warning in the response. Without it, only errors are listed.
Header	Accept: application/json
Header	Content-type: application/json
Header	Authorization: Bearer  <TOKEN> TOKEN is obtained via /authenticate (see Login).
Method	POST

The content of the request is an array of JSON objects containing the keys defined in the Attribute Mapping setting. 

It is important that the request complies with JSON standards. Defined, for example, here. Please send numerical attribute values without quotation marks, see example.

• Response

Key	Value
Status	A string describing the final state of the import. SUCCESS = error-free import process PARTIAL_SUCCESS = import completed but generated one or more warnings FAILURE = one or more errors occurred during the import
Warnings	Optional - included only if the ?debug parameter is in the URL and the import generated at least one warning. List of warning strings.
Errors	Optional - included only if the import generated at least one error. List of error strings.
Total Lines	Optional - is included only if the import did not end with the status "FAILURE" Number of records on input.
Duplicated	Optional - is included only if the import did not end with the status "FAILURE" The number of records that were skipped because this item was already imported in the same request.
Empty IDs	Optional - is included only if the import did not end with the status "FAILURE" The number of records that were skipped because no matching request ID was found for them.
Ignored	By default, if the import cannot find a live item with specified ID, it searches the deleted items list instead. If a deleted item is found, it is restored. Enabling this option means that deleted items are ignored instead of being restored.

 

• Status Codes

Status	Value
200 OK	Import successful with "SUCCESS" or "PARTIAL_SUCCESS" status. The response may contain warnings or minor errors.
400 Bad Request	Incorrect task settings or incorrect request.
401 Unauthorized	The authorization token is invalid, or the user who is logged on with the token does not have permission to run this task.
404 Not Found	No task was found with the ID specified in the URL.
500 Internal Server Error	A critical server-side error occurred during the import.
503 Service Unavailable	The task is already running. Retry launching the task after count of seconds given in response header Retry-After.

• Latest Logs

In Quant, in addition to task settings, you can also view records of individual imports, including statistics, errors, and warnings.

We can view the details of a specific record by selecting it and clicking the Download Files button.

Download Files

• Request

 curl -X POST --location "https://[YOUR_COMPANY].iquant.eu/v1/import/basic-entities/959977?debug" \

    -H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Cache-Control: no-cache" \
-d "[ {"id":"CAT001","name":"Number 1","prodAt":  ["External ID attribute 1","External ID attribute 2"]},
 {"id":"CAT002","name":"Number 2","prodAt":  "External ID attribute 1"},
{"id":"CAT003","name":"Number 3","prodAt": ["External ID attribute 1","External ID attribute 4","External ID attribute 5"]
"}]"

• Response

{
  "Status": "SUCCESS", 
  "Total Lines": 4,
  "Duplicated": 0,
  "Empty Ids": 1,
  "Ignored": 0
}