TRANXACT.AI Help

Platform · Services and actions

Forms

The forms service of Platform: 17 operation(s).

Type REST17 operationsBase path /api/platform/forms

Download specification (OpenAPI 3.1)

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 › Forms 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.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/platform/forms/page-sizesPage sizes

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/forms/page-sizes" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/forms/printablePrintable

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/forms/printable" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/forms/fields/{module}/{resource}Fields

Path parameters

NameTypeDescription
modulestring (uuid)The record's module, as a list returns it.
resourcestring (uuid)The record's resource, as a list returns it.

Response

200 with the data as JSON.

Sample request

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/forms/letterhead" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/platform/forms/letterheadLetterhead

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/forms/letterhead" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/forms/templatesTemplates

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/forms/templates" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/forms/templates/{id}Templates

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/forms/templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/forms/templatesTemplates

Request body

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

code*, name, module, resource, pageSize, orientation, wordSystem, description, elements; orientation one of portrait|landscape; wordSystem one of western|indian

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/forms/templates" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"value","name":"value","module":"value","resource":"value","pageSize":"value","orientation":"value"}'
PUT/api/platform/forms/templates/{id}Templates

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

pageSize, code, name, description, orientation, wordSystem, locale, elements; orientation one of portrait|landscape; wordSystem one of western|indian

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/forms/templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"pageSize":"value","code":"value","name":"value","description":"value","orientation":"value","wordSystem":"value"}'
POST/api/platform/forms/templates/{id}/copyTemplates copy

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

code, name

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/forms/templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"value","name":"value"}'
POST/api/platform/forms/templates/{id}/defaultTemplates default

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 POST "https://demo.tranxact.ai/api/platform/forms/templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/default" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/forms/templates/{id}/reset-defaultTemplates reset default

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

discard

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/forms/templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reset-default" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"discard":"value"}'
GET/api/platform/forms/standardStandard

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/forms/standard" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/platform/forms/templates/{id}Templates

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/forms/templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/forms/templates/{id}/checkTemplates check

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/forms/templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/check" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/forms/templates/{id}/previewTemplates preview

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

elements, pageSize, orientation, recordId

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/forms/templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"elements":"value","pageSize":"value","orientation":"value","recordId":"value"}'
GET/api/platform/forms/runsRuns

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/forms/runs" \
  -H "Authorization: Bearer $TOKEN"

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