Platform · Custom Objects
Custom Objects
Tables this company defines for itself: name the object, add its fields, and it gets a screen, search, import, audit and its own grants (Custom Objects tab). Nothing here changes a standard screen. Limits: 50 objects, 80 fields and a million records each. Switch an object off to hide it and keep its records; delete it only on purpose.
/api/platform/custom-objectsPublished as /api/v1/custom-objectsOverview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Platform › Custom Objects on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | ext.co_objects · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/custom-objectsList custom objects
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_key": "text",
"label": "text",
"plural_label": "text",
"description": "text",
"prefix": "text",
"next_no": "1250.00",
"title_field": "Example",
"has_status": true,
"status_options": {},
"table_name": "Example",
"record_count": "12.0000",
"max_records": 10,
"is_active": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/custom-objects?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/custom-objects/{id}Read one custom object
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"object_key": "text",
"label": "text",
"plural_label": "text",
"description": "text",
"prefix": "text",
"next_no": "1250.00",
"title_field": "Example",
"has_status": true,
"status_options": {},
"table_name": "Example",
"record_count": "12.0000",
"max_records": 10,
"is_active": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/custom-objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/custom-objects/importImport
Request body
The keys this action reads (* = required; "one of" lists the only values):
designResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/custom-objects/import" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"design":"value"}'POST/api/platform/custom-objectsPost custom objects
Request body
The keys this action reads (* = required; "one of" lists the only values):
grantsResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/custom-objects" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"grants":"value"}'PUT/api/platform/custom-objects/{id}Put custom objects
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/custom-objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/platform/custom-objects/{id}Delete custom objects
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/custom-objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/custom-objects/{id}/exportExport
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/custom-objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/export" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/custom-objects/{id}/grantGrant
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
role*, add, change, display, deleteResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/custom-objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/grant" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"role":"value","add":"value","change":"value","display":"value","delete":"value"}'GET/api/platform/custom-objects/choices/objectsChoices objects
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/custom-objects/choices/objects" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/custom-objects/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/custom-objects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a custom object, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
object_key | text | read only | Key — Lower case letters, digits and underscores, e.g. site_visit. It cannot be changed later. |
label | text | read only | Name (singular) — What one record is called, e.g. Site visit. |
plural_label | text | read only | Name (plural) — Shown on the list and the tab, e.g. Site visits. |
description | text | read only | What it is for — Shown at the top of the object's screen. |
prefix | text | read only | Number prefix — Records are numbered PREFIX-000001: 2 to 6 capital letters or digits. |
next_no | bigint | read only | Next no |
title_field | text | read only | Title field (a field key) — The field that names a record on a list or a link. Leave empty for the record number. |
has_status | boolean | read only | Records have a status — Adds a Status field limited to the statuses below, and the status hooks apply. |
status_options | jsonb | read only | Statuses — Comma-separated, the first is the status of a new record, e.g. open, review, closed. |
table_name | text | read only | Table name |
record_count | bigint | read only | Record count |
max_records | integer | read only | Max records |
is_active | boolean | read only | On — Switch off to hide the object from everybody and keep its records. |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
updated_by | uuid | read only | Updated by |
updated_at | timestamp with time zone | read only | Updated at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › Custom Objects for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.