POST /v1/lookupTables

Create a new lookup table by providing a schema and specifying its configuration. Providing parentFolderId is mandatory. Use the getItemByPath endpoint to get content id of a path. Please check Content management API and Folder management API for all available options.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
ttl Integer No

A time to live for each entry in the lookup table (in minutes). 365 days is the maximum time to live for each entry that you can specify. Setting it to 0 means that the records will not expire automatically.

Default value: 0

name String Yes

The name of the lookup table.

description String Yes

The description of the lookup table.

fields[] Array Yes

The list of fields in the lookup table.

fields[].fieldType String Yes

The data type of the field. Supported types:

  • boolean
  • int
  • long
  • double
  • string
fields[].fieldName String Yes

The name of the field.

primaryKeys[] Array Yes

The names of the fields that make up the primary key for the lookup table. These will be a subset of the fields that the table will contain.

parentFolderId String Yes

The parent-folder-path identifier of the lookup table in the Library.

sizeLimitAction String No

The action that needs to be taken when the size limit is reached for the table. The possible values can be StopIncomingMessages or DeleteOldData. DeleteOldData will start deleting old data once size limit is reached whereas StopIncomingMessages will discard all the updates made to the lookup table once size limit is reached.

Default value: "StopIncomingMessages"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.