Increment or decrement an integer or float field of a Tulip Table Record.
A decrement is simply a negative increment.
The tableId must exist.
The recordId must be associated with the tableId.
The field name must match the column name of the table.
The respective column type in the table must be incrementable.
The value type must be incrementable (so an integer or float).
If the field type is an integer, then the value can be either an integer or a float,
but if it is a float, it will be rounded off (e.g. 2.7 rounds up to 3). If the field
type is a float, then the value type can also be either an integer or a float.
The record's _updatedAt field will be updated to the current time.
If the value to be incremented has not been set yet, then it will be treated like
an increment on a 0 value.
Requires the tables:write API key scope.
When incrementing a Tulip number field (not integer field), you may specify the increment value as either a JSON
number or a string. If specifying the number as a string, it must be of format "[-]xx[.yyy]". This corresponds
to the JSON number format, except that the exponent component is not allowed (in other words, you cannot use
scientific notation). If you specify the value a string, it may contain trailing zeros, which will be preserved
in the operation. If you specify the value as a JSON number, the operation will not preserve trailing zeros,
including any that may have been in the value before this increment operation.
Access to the Tulip API requires the use of HTTP Basic Authentication using the credentials of an active Tulip API Token. All requests require the Authorization HTTP header with the Basic scheme to provide API credentials unless otherwise noted.
API tokens can be configured with a set of scopes which determine what parts of the API that specific token has access to. Security best practices dictate that API credentials be given the minimum set of capabilities required to fulfill their intended purpose. For example, an API token created for use in an integration that is only designed to use the Tables API should probably only be given the tables:read and tables:write scopes. In this way you can minimize risk in the event that API credentials are compromised. API endpoints will document what API token scopes are required to access that endpoint in their descriptions. If a request is made to an endpoint with an API token which does not have the required scopes, the response will be an authorization error.
The format that Tulip should use in the response when formatting Tulip numbers. If omitted or set to
float, Tulip will format numbers as JSON numbers. If set to decimal, Tulip will format numbers as strings
representing the decimal representation of the number, like "1.20". Tulip will only output trailing zeros
when using decimal formatting.
This header only affects the response format. The value written is determined solely by the request body (see body description).
Note that this header only affects Tulip numbers. Other types, including Tulip integers, are unaffected.
The id of a Tulip Table.
The id of a Tulip Table record.
Field to increment or decrement
The field (column) to increment or decrement.
The amount to increment or decrement by.
The field was incremented or decremented successfuly.
A single record stored in a Tulip Table. The record object will include the names and values of all columns of the Table that are not hidden, in addition to the record's sequence number, created timestamp, and last updated timestamp.
A monotonically increasing unique identifier for this record.
The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.
The request was made unauthorized. HTTP Basic Authorization using a Tulip API Key is required for use of the API.
The provided authentication info was rejected. The response will provide additional details.
The requested database entry was not found.
The request was syntactically sound, but could not be processed due to a logical problem.
The server encountered an unexpected error.