Endpoint Types

Data Group Endpoints

You can access data groups using a data group endpoint. When you create a data group endpoint, you can access the data group in which you are creating the endpoint. However, you can also access all other data groups on your portal. You can use the GET, POST, PATCH, and DELETE methods to create a data group endpoint.

If you use the GET method, you can choose between "Read a single record" and "Read multiple records."

Read a Single Record

Example

GET /api/app/{app-guid}/{entity-name}/{id}

Read Multiple Records

Example

GET /api/app/{app-guid}/{entity-name}

Create a data record

Example

POST /api/app/{app-guid}/{entity-name}

Edit Record

Example

PATCH /api/app/{app-guid}/{entity-name}/{id}

Delete Record

Example

DELETE /api/app/{app-guid}/{entity-name}/{id}

Process Endpoint

You can use process endpoints to trigger processes. You can pass parameters to the process using the process endpoint.

Example

POST /api/app/{app-guid}/{action-name}

Groovy Endpoint

Groovy endpoints allow you to run Groovy scripts.

Example

POST /api/app/{app-guid}/{script-action-name}