TRANXACT.AI Help

Platform · Custom Objects

Object Fields

The fields of each custom object. A field has a type, optional limits, and may be required, unique, searchable or sensitive (kept out of reports, search and anything an AI assistant is shown). A field is retired by default: it disappears from the screens and its values stay; Purge drops the column and its values. A field's key and type cannot be changed.

Type REST7 operationsBase path /api/platform/custom-object-fieldsPublished as /api/v1/custom-object-fields

Download specification (OpenAPI 3.1) Screen: Object Fields

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 › Object Fields 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_fields · 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

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/platform/custom-object-fieldsList object fields

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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "field_key": "text",
      "label": "text",
      "help": "text",
      "data_type": "text",
      "options": {},
      "ref_target": "text",
      "is_required": true,
      "is_unique": true,
      "is_searchable": true,
      "is_sensitive": true,
      "min_value": "1250.00",
      "max_value": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/platform/custom-object-fields?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/custom-object-fields/{id}Read one custom object field

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "object_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "field_key": "text",
  "label": "text",
  "help": "text",
  "data_type": "text",
  "options": {},
  "ref_target": "text",
  "is_required": true,
  "is_unique": true,
  "is_searchable": true,
  "is_sensitive": true,
  "min_value": "1250.00",
  "max_value": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/platform/custom-object-fields/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/custom-object-fieldsPost object fields

Request body

The keys this action reads (* = required; "one of" lists the only values):

objectId, object_id

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-object-fields" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"objectId":"value","object_id":"value"}'
PUT/api/platform/custom-object-fields/{id}Put object fields

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-object-fields/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/platform/custom-object-fields/{id}Delete object fields

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-object-fields/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/custom-object-fields/choices/{kind}Choices

Path parameters

NameTypeDescription
kindstring (uuid)The record's kind, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/custom-object-fields/choices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/custom-object-fields/{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-object-fields/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 field, 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_iduuidread onlyObject — The object this field belongs to.
field_keytextread onlyKey — Lower case letters, digits and underscores, up to 40. It becomes the column name and cannot be changed.
labeltextread onlyLabel — What people see on the form and list.
helptextread onlyHelp text — Shown beside the field on the form.
data_typetextread onlyType — Fixed once the field exists.
Allowed: text textarea number integer money percent date datetime boolean select multiselect reference
optionsjsonbread onlyChoices — Comma-separated values people may pick.
ref_targettextread onlyPoints at — A standard screen as module/screen, e.g. crm/accounts, or another object as co:object_key.
is_requiredbooleanread onlyRequired — A record cannot be saved without it.
is_uniquebooleanread onlyUnique — No two records may hold the same value (blank is allowed).
is_searchablebooleanread onlySearchable — The search box looks in this field.
is_sensitivebooleanread onlySensitive — Kept out of reports, search and anything an AI assistant or agent is shown.
min_valuenumericread onlySmallest value — Numbers below it are refused.
max_valuenumericread onlyLargest value — Numbers above it are refused.
max_lengthintegerread onlyLongest text — Characters allowed; 4,000 for text and 20,000 for long text if empty.
default_valuetextread onlyDefault value — Filled in on a new record when nobody typed anything.
show_in_listbooleanread onlyShow on the list — A column of the list by default.
sort_orderintegerread onlyOrder — Lower numbers come first on the form.
is_activebooleanread onlyOn — Off retires the field: hidden everywhere, values kept.
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 › Object Fields 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.