TRANXACT.AI Help

Platform · Records & Legal Hold

Records Exports

Everything about one employee, one applicant or one legal matter — or the whole company — as one ZIP: every record as JSON and CSV (and XML and Excel for a person or a matter), its audit history, its attachments from the document store, a manifest with a SHA-256 of every file and a PDF summary. Built in the background; every request and every download is audited. Passwords, keys and tokens are never exported.

Type REST9 operationsBase path /api/platform/records-exportsPublished as /api/v1/records-exports

Download specification (OpenAPI 3.1) Screen: Records Exports

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 › Records Exports 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.
Tablegov.export_jobs · 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

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

GET/api/platform/records-exportsList records exports

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",
      "job_no": "JOB-000001",
      "scope": "text",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "applicant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "hold_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "include_files": true,
      "note": "text",
      "status": "draft",
      "subject_label": "text",
      "file_name": "Example",
      "byte_size": "1250.00",
      "sha256": "text",
      "file": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_no": "JOB-000001",
  "scope": "text",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "applicant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hold_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "include_files": true,
  "note": "text",
  "status": "draft",
  "subject_label": "text",
  "file_name": "Example",
  "byte_size": "1250.00",
  "sha256": "text",
  "file": "text"
}

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

Sample request

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

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/records-exports" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/platform/records-exports/{id}Put records exports

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

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

Request body

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

hold_id, hold, hold_no, legal_hold, employee_id, employee, employee_no, scope, applicant_id, include_files, note

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/records-exports/start" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"hold_id":"value","hold":"value","hold_no":"value","legal_hold":"value","employee_id":"value","employee":"value"}'
POST/api/platform/records-exports/{id}/downloadDownload

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

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/records-exports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/file" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/records-exports/{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/records-exports/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 records exports, 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
job_notextread onlyJob no
scopetextread onlyScope
employee_iduuidread onlyEmployee id
applicant_iduuidread onlyApplicant id
hold_iduuidread onlyHold id
include_filesbooleanread onlyInclude files
notetextread onlyNote
statustextread onlyStatus
subject_labeltextread onlySubject label
file_nametextread onlyFile name
byte_sizebigintread onlyByte size
sha256textread onlySha256
filebytearead onlyFile
countsjsonbread onlyCounts
errortextread onlyError
requested_byuuidread onlyRequested by
requested_attimestamp with time zoneread onlyRequested at
started_attimestamp with time zoneread onlyStarted at
finished_attimestamp with time zoneread onlyFinished at
heartbeat_attimestamp with time zoneread onlyHeartbeat at
downloadsintegerread onlyDownloads
last_downloaded_attimestamp with time zoneread onlyLast downloaded at
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
created_byuuidread onlyCreated by
updated_byuuidread onlyUpdated by
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 › Records Exports 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.