Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
table

Create a table

post/v1/org/{orgId}/table

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

namestring required

name of table

labelstring

human readable label for the table

effectiveDatedboolean required

whether or not the table is time tracked with effective dates (allows time travel or not). If false, then the values set in the table will be the same across all dates.

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE'

base sensitivity of this table and entities in it -- should be either ORG or HIGH

Example request

{
  "name": "budget-data",
  "label": "Budget Data",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ]
}

Response

table created

idstring required

globally unique id

orgIdstring

parent org id

namestring required

name of table

labelstring required

human readable label for the table

labelColumnIdstring

if set, use this column id as the label when referencing rows

effectiveDatedboolean required

whether or not the table is time tracked with effective dates (allows time travel or not). If false, then the values set in the table will be the same across all dates.

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE' required

base sensitivity of this table and entities in it -- should be either ORG or HIGH

rowCountinteger required

number of rows in the table

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "name": "budget-data",
  "label": "Budget Data",
  "labelColumnId": "588f7ee98f138b19220041a7",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}