Custom Table

These endpoints let you manage custom tables in the system. It allows you to retrieve, create, update, and delete custom table records.

Get Custom Tables

get

Return the custom tables.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
id	:	Equal operator Support multiple values with each value separated by the ; delimiter
tableName	:	Like operator
displayName	:	Like operator
menuLocation	:	Like operator
historicalType	:	Like operator
parentEntity	:	Like operator
parentEntityIsNull	:	Equal operator Boolean
parentReferenceField	:	Like operator

Example: {"summary":"Search a custom table by ID","value":"id:a31aa166-70be-4303-81e4-5ada93b5213a"}

Responses

200

Successful operation

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/core/v1/custom-tables

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/custom-tables?page=0&size=10&query=id%3Aa31aa166-70be-4303-81e4-5ada93b5213a" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
      "tableName": "employee_certifications",
      "displayName": "Employee Certifications",
      "menuLocation": "EMPLOYEE.CERTIFICATIONS",
      "historicalType": "NONE",
      "parentEntity": "Employee",
      "parentReferenceField": "employeeId",
      "columns": [
        {
          "id": "b42bb37-fed4-4d76-9838-221ec23647d1",
          "columnName": "certification_name",
          "fieldName": "certificationName",
          "displayName": "Certification Name",
          "fieldOrder": 1,
          "dataType": "STRING",
          "isRequired": true,
          "isReference": false,
          "tooltip": ""
        },
        {
          "id": "c53cc38-fed4-4d76-9838-221ec23647d2",
          "columnName": "issue_date",
          "fieldName": "issueDate",
          "displayName": "Issue Date",
          "fieldOrder": 2,
          "dataType": "DATE",
          "isRequired": true,
          "isReference": false,
          "columnMetadata": {
            "dateFormat": "yyyy-MM-dd"
          },
          "tooltip": "Please enter the issue date of the certification"
        }
      ]
    },
    {
      "id": "f4eaf74f-3e63-414f-b7be-54c46902407f",
      "tableName": "training_records",
      "displayName": "Training Records",
      "menuLocation": "EMPLOYEE.TRAININGS",
      "historicalType": "NONE",
      "parentEntity": "employee",
      "parentReferenceField": "employeeId",
      "columns": [
        {
          "id": "d64dd39-fed4-4d76-9838-221ec23647d3",
          "columnName": "training_name",
          "fieldName": "trainingName",
          "displayName": "Training Name",
          "fieldOrder": 1,
          "dataType": "STRING",
          "isRequired": true,
          "isReference": false
        }
      ]
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 2,
  "numberOfElements": 2,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Custom Table by Id

get

Return the custom table by Id.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tableIdstringRequiredExample: d45ee37-92c4-4d76-9838-221ec2364701

Responses

200

Successful operation

application/json

idstringOptional

Unique identifier of the custom table

tableNamestringOptional

Technical name of the custom table

displayNamestringOptional

Display name of the custom table

menuLocationstringOptional

Location of the table in menu hierarchy

historicalTypestringOptional

Type of historical tracking for the table

parentEntitystringOptional

Parent entity reference

parentReferenceFieldstringOptional

Field used for parent entity reference

400

Bad Request

404

Custom table not found

get

/core/v1/custom-tables/{tableId}

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/custom-tables/d45ee37-92c4-4d76-9838-221ec2364701" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
  "tableName": "employee_certifications",
  "displayName": "Employee Certifications",
  "menuLocation": "EMPLOYEE.CERTIFICATIONS",
  "historicalType": "NONE",
  "parentEntity": "Employee",
  "parentReferenceField": "employeeId",
  "columns": [
    {
      "id": "b42bb37-fed4-4d76-9838-221ec23647d1",
      "columnName": "certification_name",
      "fieldName": "certificationName",
      "displayName": "Certification Name",
      "fieldOrder": 1,
      "dataType": "STRING",
      "isRequired": true,
      "isReference": false,
      "tooltip": ""
    },
    {
      "id": "c53cc38-fed4-4d76-9838-221ec23647d2",
      "columnName": "issue_date",
      "fieldName": "issueDate",
      "displayName": "Issue Date",
      "fieldOrder": 2,
      "dataType": "DATE",
      "isRequired": true,
      "isReference": false,
      "columnMetadata": {
        "dateFormat": "yyyy-MM-dd"
      },
      "tooltip": "Please enter the issue date of the certification"
    }
  ]
}