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:
- You can perform currency conversions on the fly.
- You can optionally ignore near duplicate warnings.
- It's the only way to upload data to the
file
field type. - It's the only way to upload data to the
image
field type. - 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
- Entries - Returns a list of all entries for a given object.
- Filter - Can be used to filter the list of entries returned by the Entries endpoint, based on certain criterias.
- GET - To get the value of specific fields for a specified list of entries.
- POST - To create new entries. Also to upload files and images.
- PUT - To update existing entries and fields of existing entries.