Adds records to the specified catalog

The maximum number of records that can be added at a time is 5000

POST /api/publicapi/v1/catalogs/{catalogId}/records

Adds records to the specified catalog

cURL

curl --request POST \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
[
  {
    "id": "<string>",
    "fields": {}
  }
]
'

200

{
  "insertedRowCount": 123,
  "errorRows": {}
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

catalogId · string · required

Catalog identifier. You can find it in the list of all catalogs.

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Records to add

Required array length: 1 - 5000 elements

id · string · required

Unique id of the record

Minimum string length: 1

fields · object · required

Record fields

Show child attributes

Response

200

text/plain

Operation completed successfully. The details can be found in the response.

insertedRowCount · integer<int32> · required

Number of successfully inserted rows

errorRows · object · required

List of the errors occurred

Show child attributes