REST API Fixture Image Data Export V1

This resource is used to export photo data of equipment in Quant. The input and output format is JSON.

Use the Automatic Tasks section to create and set up an export. Once created, the task list will have the ID that you pass in the request URL.

Task ID 
  • 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 Fixture Image Data Attribute Mapping , select the attributes to export and optionally modify their JSON keys
  • Attributes
Specifies whether the automated task is active and can send data through it.
Custom name of the automated task.
Custom description of the automatic task function.
formatted text
long text
Emails for Notifications

One or more email addresses to which emails with error conditions will be sent.

list of strings
Users with API Access Permission
Users with the Robot role who are authorized to run the task.
list of users
Measure Unit
Unit of measure such as cm, mm etc.
Date Format
Date entry format, eg. 31.12.19
Date and Time Format
Date entry format and time, eg. 31.12.19 23:59:59
Export Newer Items Than
Date limiting the list of exported images. When filled, only images uploaded after this date are exported.
Include Annotations
When on, the image ID including user edits is exported, otherwise the original image ID without edits is exported.
Maximum Planogram Image Width (px)
Specifies the maximum width of the planogram image to download in pixels.
natural number
Maximum Planogram Image Height (px)
Specifies the maximum height of the planogram image to download in pixels.
natural number
Fixture Image Data Attribute Mapping
A mapping containing an entry for each photo attribute to be exported.
complex type
  • Request


?debug added to the URL will also display a warning in the response. Without it, only errors are listed.
Accept: application/json
Content-type: application/json

Authorization: Bearer  <TOKEN>

TOKEN se získává pomocí /authenticate (see Login).


The content of the request can be omitted (empty text), or it can be an empty JSON object.

  • Response
A string describing the final state of the export.
  • SUCCESS = error-free export process
  • PARTIAL_SUCCESS = export completed but generated one or more warnings
  • FAILURE = one or more errors occurred during the export
It is optional, ie. is included only if the ?debug parameter is in the URL and the export generated at least one warning.
List of warning strings.
Optional - included only if the export generated at least one error.
List of error strings.

Optional - is included only if the export did not end with the status "FAILURE".

List of exported objects. Each object contains keys defined by mapping in the job settings.

  • Status Codes
200 OK
Export 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 export.

503 Service Unavailable

The task is already running. Retry launching the task after count of seconds given in response header Retry-After.

  • Execution Log

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

Execution Log 

If we select a specific record, we can display its details by clicking the Show Items button.

Show Items 

  • Request

curl -X POST --location "http://localhost:4150/v1/export/fixture-image-data/151?debug" \

    -H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \

    -H "Accept: application/json" \

    -H "Content-Type: application/json" \

    -H "Cache-Control: no-cache" \

    -d '{}'

  • Response


  "Status": "SUCCESS",

  "Total Lines": 50,

  "Ignored Pictures": 0,

  "Records": [

    {"Photo ID": "89", "Assigned Fixtures": ["6a0d7e43-c6d5-4247-98c1-2b4f3f9ddf99"], "Implemented Planogram Id": "446319"},

    {"Photo ID": "162", "Assigned Fixtures": ["83c5b2da-23af-4ad6-8a57-fcb8bc4ca12a"], "Implemented Planogram Id": ""},

    ... ]