TRANXACT.AI Help

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.

Type REST10 operationsBase path /api/platform/custom-objectsPublished as /api/v1/custom-objects

Download specification (OpenAPI 3.1) Screen: Custom Objects

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableext.co_objects · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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):

design

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 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):

grants

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 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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, delete

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 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

NameTypeDescription
idstring (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, withLines

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 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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
object_keytextread onlyKey — Lower case letters, digits and underscores, e.g. site_visit. It cannot be changed later.
labeltextread onlyName (singular) — What one record is called, e.g. Site visit.
plural_labeltextread onlyName (plural) — Shown on the list and the tab, e.g. Site visits.
descriptiontextread onlyWhat it is for — Shown at the top of the object's screen.
prefixtextread onlyNumber prefix — Records are numbered PREFIX-000001: 2 to 6 capital letters or digits.
next_nobigintread onlyNext no
title_fieldtextread onlyTitle field (a field key) — The field that names a record on a list or a link. Leave empty for the record number.
has_statusbooleanread onlyRecords have a status — Adds a Status field limited to the statuses below, and the status hooks apply.
status_optionsjsonbread onlyStatuses — Comma-separated, the first is the status of a new record, e.g. open, review, closed.
table_nametextread onlyTable name
record_countbigintread onlyRecord count
max_recordsintegerread onlyMax records
is_activebooleanread onlyOn — Switch off to hide the object from everybody and keep its records.
created_byuuidread onlyCreated by
created_attimestamp with time zoneread onlyCreated at
updated_byuuidread onlyUpdated by
updated_attimestamp with time zoneread onlyUpdated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › Custom Objects for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.