Cells APIs

Cells APIs works using Key-Value Pairs. The APIs are great for bulk operations and support up to 10,000 key-value object per request. There are several advantages to using the Cells APIs:

  1. You can perform currency conversions on the fly.
  2. You can optionally ignore near duplicate warnings.
  3. It's the only way to upload data to the file field type.
  4. It's the only way to upload data to the image field type.
  5. Because it uses EntryId and FieldIds instead of apiName, it's much faster than the Rows APIs.

Schema

The schema for the Cells APIs is as follows:

[
    {
      "entryId": "integer",
      "rowId": "integer",
      "fieldId": "integer",
      "isNoData": "boolean",
      "value": "string | integer | object",
      "requestedCurrencyCode": "string",
      "modified": "date-time",
      "modifiedBy": "integer",
    }
  ]

When requesting information from the Cells APIs you'll typically use a structure like this, only provide currencyCode for fields that are of type number with currency values:

[
  {
    "entryId": 0, (required)
    "fieldId": 0, (required)
    "currencyCode": "string" (optional)
  }
]

Endpoints

  1. Entries - Returns a list of all entries for a given object.
  2. Filter - Can be used to filter the list of entries returned by the Entries endpoint, based on certain criterias.
  3. GET - To get the value of specific fields for a specified list of entries.
  4. POST - To create new entries. Also to upload files and images.
  5. PUT - To update existing entries and fields of existing entries.