iotoms Docs

List importable fields

GET
/api/v1/ai/import/catalog

Returns the fields each importable record type (item, customer, vendor) accepts, with type, required flag, description and allowed values, plus the supported value transforms. Use it to build a mapping by hand.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the request: SUCCESS when it worked; errors return an error status with the reason in message.

message*string

Short human-readable message describing the outcome.

data?

The importable record types, their fields and the supported value transforms.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/ai/import/catalog'
Example Response
{  "status": "string",  "message": "string",  "data": {    "entityTypes": [      "ITEM"    ],    "transformTypes": [      "string"    ],    "fieldsByEntityType": {      "property1": [        {          "name": "string",          "type": "string",          "required": true,          "description": "string",          "enumValues": [            "string"          ]        }      ],      "property2": [        {          "name": "string",          "type": "string",          "required": true,          "description": "string",          "enumValues": [            "string"          ]        }      ]    }  }}