logo
POST/data/create

Create

This endpoint allows you to create records. When creating a single record, the entities array is omitted. For bulk record creation, only the entities array is provided.

The response includes the resulting entity data. Any modifications made by service logic to the fields will be reflected in the response.

Single Create

Request

POST
/data/create
{
  "tableName": "tableName",
  "fields": {
    "field1Name": "value",
    "field2Name": "value",
    "field3Name": "value"
  },
  "parameters": {
    "parameter1Name": "value",
    "parameter2Name": "value",
    "parameter3Name": "value"
  }
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": {
    "field1Name": "value",
    "field2Name": "value",
    "field3Name": "value",
    "_ui_info_": {
        "canDelete": true,
        "canUpdate": true,
        "canAssign": true,
        "tableName": "tableName"
    },
    "_parameters_": {}
  }
}

Bulk Create

Request

POST
/data/create
{
  "entities": [
    {
      "tableName": "string",
      "fields": {
        "field1Name": "value",
        "field2Name": "value",
        "field3Name": "value"
      },
      "parameters": {
        "parameter1Name": "value",
        "parameter2Name": "value",
        "parameter3Name": "value"
      }
    }
  ]
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": [
      {
          "field1Name": "value",
          "field2Name": "value",
          "field3Name": "value",
      }
  ]
}
PATCH/data/update

Update

This endpoint allows you to update records. When updating a single record, the entities array is omitted. For bulk record updates, only the entities array is provided.

The response includes the resulting entity data. Any modifications made by service logic to the fields will be reflected in the response.

Single Update

Request

POST
/data/update
{
  "tableName": "tableName",
  "fields": {
    "field1Name": "value",
    "field2Name": "value",
    "field3Name": "value"
  },
  "parameters": {
    "parameter1Name": "value",
    "parameter2Name": "value",
    "parameter3Name": "value"
  }
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": {
    "field1Name": "value",
    "field2Name": "value",
    "field3Name": "value",
    "_ui_info_": {
        "canDelete": true,
        "canUpdate": true,
        "canAssign": true,
        "tableName": "tableName"
    },
    "_parameters_": {}
  }
}

Bulk Update

Request

POST
/data/update
{
  "entities": [
    {
      "tableName": "string",
      "fields": {
        "field1Name": "value",
        "field2Name": "value",
        "field3Name": "value"
      },
      "parameters": {
        "parameter1Name": "value",
        "parameter2Name": "value",
        "parameter3Name": "value"
      }
    }
  ]
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": [
      {
          "field1Name": "value",
          "field2Name": "value",
          "field3Name": "value",
      }
  ]
}
DELETE/data/delete

Delete

This endpoint allows you to delete records. When deleting a single record, the entities array is omitted. For bulk record deletes, only the entities array is provided.

The only field required for deletion is the primary key, i.e., (TableName)Id.

The response includes the resulting entity data. Any modifications made by service logic to the fields will be reflected in the response.

Single Delete

Request

DELETE
/data/delete
{
  "tableName": "tableName",
  "fields": {
    "field1Name": "value",
    "field2Name": "value",
    "field3Name": "value"
  },
  "parameters": {
    "parameter1Name": "value",
    "parameter2Name": "value",
    "parameter3Name": "value"
  }
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": {
    "field1Name": "value",
    "field2Name": "value",
    "field3Name": "value",
    "_ui_info_": {
        "canDelete": true,
        "canUpdate": true,
        "canAssign": true,
        "tableName": "tableName"
    },
    "_parameters_": {}
  }
}

Bulk Delete

Request

DELETE
/data/delete
{
  "entities": [
    {
      "tableName": "string",
      "fields": {
        "field1Name": "value",
        "field2Name": "value",
        "field3Name": "value"
      },
      "parameters": {
        "parameter1Name": "value",
        "parameter2Name": "value",
        "parameter3Name": "value"
      }
    }
  ]
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": [
      {
          "field1Name": "value",
          "field2Name": "value",
          "field3Name": "value",
      }
  ]
}
POST/data/upsert

Upsert

This endpoint allows you to upsert records. When upserting a single record, the entities array is omitted. For bulk record upserting, only the entities array is provided.

Upserting checks if a record already exists. If it does, the record is updated; if it doesn't, a new record is created.

The response includes the resulting entity data. Any modifications made by service logic to the fields will be reflected in the response.

Single Upsert

Request

POST
/data/upsert
{
  "tableName": "tableName",
  "fields": {
    "field1Name": "value",
    "field2Name": "value",
    "field3Name": "value"
  },
  "parameters": {
    "parameter1Name": "value",
    "parameter2Name": "value",
    "parameter3Name": "value"
  }
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": {
    "field1Name": "value",
    "field2Name": "value",
    "field3Name": "value",
    "_ui_info_": {
        "canDelete": true,
        "canUpdate": true,
        "canAssign": true,
        "tableName": "tableName"
    },
    "_parameters_": {}
  }
}

Bulk Upsert

Request

POST
/data/upsert
{
  "entities": [
    {
      "tableName": "string",
      "fields": {
        "field1Name": "value",
        "field2Name": "value",
        "field3Name": "value"
      },
      "parameters": {
        "parameter1Name": "value",
        "parameter2Name": "value",
        "parameter3Name": "value"
      }
    }
  ]
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": [
      {
          "field1Name": "value",
          "field2Name": "value",
          "field3Name": "value",
      }
  ]
}
POST/data/bulk

Bulk

The bulk endpoint allows you to create, update, delete, or upsert multiple records in a single transaction.

The response includes the resulting entity data. Any modifications made by service logic to the fields will be reflected in the response.

Request

POST
/data/bulk
{
  "Creates": [
    {
      "tableName": "string",
      "fields": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "parameters": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "Updates": [
    {
      "tableName": "string",
      "fields": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "parameters": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "Deletes": [
    {
      "tableName": "string",
      "fields": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "parameters": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "Upserts": [
    {
      "tableName": "string",
      "fields": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "parameters": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ]
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": [
      {
          "field1Name": "value",
          "field2Name": "value",
          "field3Name": "value",
      }
  ]
}
POST/data/read

Read

This endpoint enables querying of records.

For single record queries, only the id property needs to be provided.

Request

POST
/data/read
{
  "tableName": "string",
  "fields": [
    "string"
  ],
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "orderBy": [
    {
      "field": "string",
      "order": "string"
    }
  ],
  "maxResults": 0,
  "page": 0,
  "distinct": true,
  "denormalize": true,
  "filters": [
    {
      "logicalOperator": "string",
      "filters": [
        "string"
      ],
      "field": "string",
      "operator": "string",
      "value": "string"
    }
  ],
  "joins": [
    {
      "type": "string",
      "fields": [
        "string"
      ],
      "alias": "string",
      "fromTable": "string",
      "fromField": "string",
      "toTable": "string",
      "toField": "string",
      "filters": [
        {
          "logicalOperator": "string",
          "filters": [
            "string"
          ],
          "field": "string",
          "operator": "string",
          "value": "string"
        }
      ]
    }
  ],
  "except": [
    {
      "fromField": "string",
      "query": "string"
    }
  ],
  "parameters": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": {
      "pages": 1,
      "currentPage": 1,
      "totalResults": 5,
      "maxResults": 999999,
      "tableName": "tableName",
      "orderBy": [],
      "distinct": true,
      "denormalize": false,
      "results": [
          {
              "field1Name": "value",
              "field2Name": "value",
              "field3Name": "value",
              "_ui_info_": {
                  "canDelete": true,
                  "canUpdate": true,
                  "canAssign": true,
                  "tableName": "tableName"
              },
              "_parameters_": {}
          }
      ]
  }
}
POST/data/action

Action

This endpoint executes an action, and the response could be either a JSON object or a file download.

Request

POST
/data/action
{
  "name": "string",
  "parameters": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": {
      "outputData1": "string"
      "outputData2": "string"
      "outputData3": "string"
  }
}
POST/data/file

File

This endpoint executes an action and allows a file to be uploaded to the API. It accepts an action name and parameters in the request body.

The response could be either a JSON object or a file download.

Request

POST
/data/file
{
  "parameter1": "string",
  "parameter2": "string",
  "parameter3": "string"
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": {
      "outputData1": "string"
      "outputData2": "string"
      "outputData3": "string"
  }
}
POST/data/permissions

Permissions

This endpoint allows provides permission related information.

The method property can be set to has_permissions.

The permissionsNames property contains an array of permissions to check against the user. The response will include all of the permissions from the request that the user has.

has_permissions

Request

POST
/data/permissions
{
  "method": "has_permissions",
  "parameters": {
      "permissionNames": [
          "permissionName"
      ]
  }
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": [
      "permissionName"
  ]
}
POST/data/metadata

Metadata

This endpoint provides entity metadata information.

The method property can be either table_metadata or table_list.

  • table_metadata returns the metadata for a specified table.
  • table_list returns a list of all tables.

table_metadata

Request

POST
/data/permissions
{
  "method": "table_metadata",
  "parameters": {
    "tableName": "tableName"
  }
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": {
      "tableName": "Widget",
      "displayName": "Widget",
      "primaryKey": "WidgetId",
      "fields": [
          {
              "name": "Name",
              "displayName": "Name",
              "type": "String",
              "characterLimit": null,
              "order": 99999,
              "lookupName": null,
              "lookupTable": "",
              "lookupTableNameField": "",
              "lookupTableDescriptionField": "",
              "dateFormat": null,
              "isNullable": false,
              "isRequired": false,
              "isRecommended": false,
              "isReadOnly": false,
              "option": ""
          }
      ]
  }
}

table_list

Request

POST
/data/permissions
{
  "method": "table_list",
  "parameters": {}
}

Response

{
  "succeeded": true,
  "friendlyMessage": null,
  "logMessage": null,
  "data": [
      {
          "tableName": "tableName",
          "displayName": "tableDisplayName",
          "tag": "string"
      }
  ]
}

Was this page helpful?