Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
lookupManagement

Create a lookup table.

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.

post/v1/lookupTables

Request body

descriptionstring required

The description of the lookup table.

primaryKeysstring[] required

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.

ttlinteger

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.

sizeLimitActionstring

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.

namestring required

The name of the lookup table.

parentFolderIdstring required

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

Example request

{
  "description": "This is a sample lookup table description.",
  "fields": [
    {
      "fieldName": "FieldName1",
      "fieldType": "boolean"
    }
  ],
  "primaryKeys": [
    "FieldName1"
  ],
  "ttl": 100,
  "sizeLimitAction": "DeleteOldData",
  "name": "SampleLookupTable",
  "parentFolderId": "0000000001C41EE4"
}

Response

Lookup table created successfully.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

descriptionstring required

The description of the lookup table.

primaryKeysstring[] required

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.

ttlinteger

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.

sizeLimitActionstring

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.

namestring required

The name of the lookup table.

parentFolderIdstring required

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

idstring required

Identifier of the lookup table as a content item.

contentPathstring

Address/path of the parent folder of this lookup table in content library. For example, a lookup table existing in the personal/lookupTable folder for user johndoe would be: /Library/Users/johndoe@acme.com/lookupTable

sizeinteger

The current size of the lookup table in bytes

Example response

{
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000006743FE8",
  "description": "This is a sample lookup table description.",
  "fields": [
    {
      "fieldName": "FieldName1",
      "fieldType": "boolean"
    }
  ],
  "primaryKeys": [
    "FieldName1"
  ],
  "ttl": 100,
  "sizeLimitAction": "DeleteOldData",
  "name": "SampleLookupTable",
  "parentFolderId": "0000000001C41EE4",
  "id": "0000000001C41EE4",
  "contentPath": "/Library/Users/johndoe@acme.com/lookupTable",
  "size": 100
}