TRANXACT.AI Help

Platform · Integration

Data Pipelines

Outbound: extract from a TRANXACT source, apply the field mapping, stage for a destination. Inbound: read an external API through its source connection, stage what came in, check it, have somebody else approve it, then load it through the target screen itself.

Type REST11 operationsBase path /api/platform/pipelinesPublished as /api/v1/pipelines

Download specification (OpenAPI 3.1) Screen: Data Pipelines

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 › Data Pipelines 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.
Tableplatform.pipelines · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/platform/pipelinesList data pipelines

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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "source_connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "source_resource": "text",
      "destination_connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "destination_resource": "text",
      "sync_mode": "text",
      "cursor_field": "text",
      "cursor_value": "text",
      "primary_key": "text",
      "schedule_cron": "text",
      "batch_size": 10
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "source_connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_resource": "text",
  "destination_connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "destination_resource": "text",
  "sync_mode": "text",
  "cursor_field": "text",
  "cursor_value": "text",
  "primary_key": "text",
  "schedule_cron": "text",
  "batch_size": 10
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesPipeline code
nametextYesName
source_connection_iduuidNoSource connection — Inbound: the connection whose endpoint and stored credential are used. Its host must be on Allowed source hosts.
source_resourcetextNoSource resource — Outbound, extractable today: /accounting/journals, /accounting/ar-invoices, /scm/purchase-orders, /crm/prospects, /slcm/students, /ehr/appointments. Inbound: the path on the source connection, such as /crm/v3/objects/contacts.
destination_connection_iduuidNoDestination connection
destination_resourcetextNoDestination resource — Inbound: the screen the records go into, written /module/resource, such as /crm/prospects. They are created through that screen, with the approver's permissions.
sync_modetextNoSync mode
cursor_fieldtextNoCursor field — What an incremental run advances on.
primary_keytextNoPrimary key — Inbound: the source field that identifies a record, such as id or hs_object_id.
schedule_crontextNoSchedule (cron) — Inbound: fetches to staging on this schedule only once the definition is approved; each run still waits for approval.
batch_sizeintegerNoBatch size
statustextNoStatus — Active needs a destination resource, and an incremental or CDC pipeline a Key line in its mapping. Inactive: kept, never fetched (the templates are inactive).
Allowed: draft active paused error archived inactive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "source_connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_resource": "text",
  "destination_connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "destination_resource": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "source_connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_resource": "text",
  "destination_connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "destination_resource": "text",
  "sync_mode": "text",
  "cursor_field": "text",
  "cursor_value": "text",
  "primary_key": "text",
  "schedule_cron": "text",
  "batch_size": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/pipelines" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","source_connection_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","source_resource":"text","destination_connection_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","destination_resource":"text"}'
PUT/api/platform/pipelines/{id}Change a pipelines

Path parameters

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

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesPipeline code
nametextYesName
source_connection_iduuidNoSource connection — Inbound: the connection whose endpoint and stored credential are used. Its host must be on Allowed source hosts.
source_resourcetextNoSource resource — Outbound, extractable today: /accounting/journals, /accounting/ar-invoices, /scm/purchase-orders, /crm/prospects, /slcm/students, /ehr/appointments. Inbound: the path on the source connection, such as /crm/v3/objects/contacts.
destination_connection_iduuidNoDestination connection
destination_resourcetextNoDestination resource — Inbound: the screen the records go into, written /module/resource, such as /crm/prospects. They are created through that screen, with the approver's permissions.
sync_modetextNoSync mode
cursor_fieldtextNoCursor field — What an incremental run advances on.
primary_keytextNoPrimary key — Inbound: the source field that identifies a record, such as id or hs_object_id.
schedule_crontextNoSchedule (cron) — Inbound: fetches to staging on this schedule only once the definition is approved; each run still waits for approval.
batch_sizeintegerNoBatch size
statustextNoStatus — Active needs a destination resource, and an incremental or CDC pipeline a Key line in its mapping. Inactive: kept, never fetched (the templates are inactive).
Allowed: draft active paused error archived inactive

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "source_connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_resource": "text",
  "destination_connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "destination_resource": "text",
  "sync_mode": "text",
  "cursor_field": "text",
  "cursor_value": "text",
  "primary_key": "text",
  "schedule_cron": "text",
  "batch_size": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/platform/pipelines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/platform/pipelines/{id}Delete a pipelines

Path parameters

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

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/platform/pipelines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/pipelines/{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/pipelines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/platform/pipelines/{parentId}/mappingsMappings

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/pipelines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mappings" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/pipelines/{parentId}/mappingsMappings

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, 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/pipelines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mappings" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/platform/pipelines/{parentId}/mappings/{lineId}Mappings

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/pipelines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mappings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/platform/pipelines/{parentId}/mappings/{lineId}Mappings

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/pipelines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mappings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/pipelines/{id}/runRun

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

triggeredBy

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/pipelines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"triggeredBy":"value"}'

Data model

Every field of a pipelines, 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
org_unit_iduuidread onlyOrg unit id
codetextread, writePipeline code
nametextread, writeName
source_connection_iduuidread, writeSource connection — Inbound: the connection whose endpoint and stored credential are used. Its host must be on Allowed source hosts.
source_resourcetextread, writeSource resource — Outbound, extractable today: /accounting/journals, /accounting/ar-invoices, /scm/purchase-orders, /crm/prospects, /slcm/students, /ehr/appointments. Inbound: the path on the source connection, such as /crm/v3/objects/contacts.
destination_connection_iduuidread, writeDestination connection
destination_resourcetextread, writeDestination resource — Inbound: the screen the records go into, written /module/resource, such as /crm/prospects. They are created through that screen, with the approver's permissions.
sync_modetextread, writeSync mode
cursor_fieldtextread, writeCursor field — What an incremental run advances on.
cursor_valuetextread onlyCursor value
primary_keytextread, writePrimary key — Inbound: the source field that identifies a record, such as id or hs_object_id.
schedule_crontextread, writeSchedule (cron) — Inbound: fetches to staging on this schedule only once the definition is approved; each run still waits for approval.
batch_sizeintegerread, writeBatch size
statustextread, writeStatus — Active needs a destination resource, and an incremental or CDC pipeline a Key line in its mapping. Inactive: kept, never fetched (the templates are inactive).
Allowed: draft active paused error archived inactive
last_run_attimestamp with time zoneread onlyLast run at
last_run_statustextread onlyLast run status
total_records_syncedbigintread onlyTotal records synced
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
exception_overridejsonbread onlyException override
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 › Data Pipelines 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.