TRANXACT.AI Ayuda

API endpoints: Platform

The 85 Platform resources: their published and service-account paths, what may be done with each, and every field with its type.

Every Platform resource another product can reach, 85 in all. Each one is reached two ways: through the published API at /api/v1/<code> once an administrator has published it (its code is the resource name unless they chose another), or with a service account at /api/platform/<resource>. The verbs, parameters, filters and answers are the same for every resource and are in API endpoint reference: how to call TRANXACT.

Fields: * means required when creating; (read-only) means it is returned but not accepted on a create or change. org_id, created_at, updated_at, created_by and updated_by are on most records and are set by TRANXACT. The id is a uuid unless the table says otherwise. Field names are the JSON keys.

Gobernanza de la IA

RecursoEndpointsOperacionesCampos
AI Decision Reviews (ai-reviews)/api/v1/ai-reviews · /api/platform/ai-reviews · /{id}list, getid uuid (read-only), review_no text (read-only), area text (read-only), tool text (read-only), module text (read-only), resource text (read-only), record_id text (read-only), record_label text (read-only), ai_summary text (read-only), ai_output jsonb (read-only), status text (read-only), human_decision text (read-only), reason text (read-only), reviewed_by uuid (read-only), reviewed_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
AI Settings (ai-settings)/api/v1/ai-settings · /api/platform/ai-settings · /{id}list, getarea text (read-only), mode text (read-only), note text (read-only), id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Analítica

RecursoEndpointsOperacionesCampos
Dashboards (dashboards)/api/v1/dashboards · /api/platform/dashboards · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, description text, audience text, owner_id uuid, is_shared boolean, refresh_minutes integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Datasets (datasets)/api/v1/datasets · /api/platform/datasets · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, description text, domain text, source_sql* text, refresh_mode text, owner_id uuid, row_estimate bigint (read-only), last_profiled_at timestamp with time zone (read-only), is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Metrics (metrics)/api/v1/metrics · /api/platform/metrics · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, description text, dataset_id uuid, expression* text, unit text, decimals integer, higher_is_better boolean, target_value numeric, owner_id uuid, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Query Log (query-runs)/api/v1/query-runs · /api/platform/query-runs · /{id}list, getid uuid (read-only), query_id uuid (read-only), sql_text text (read-only), ran_at timestamp with time zone (read-only), ran_by uuid (read-only), duration_ms integer (read-only), row_count integer (read-only), status text (read-only), error text (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Saved Queries (queries)/api/v1/queries · /api/platform/queries · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, description text, dataset_id uuid, sql_text* text, parameters jsonb, row_limit integer, owner_id uuid, is_shared boolean, run_count integer (read-only), last_run_at timestamp with time zone (read-only), avg_duration_ms integer (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Automatización

RecursoEndpointsOperacionesCampos
Automation Levels (automation-policies)/api/v1/automation-policies · /api/platform/automation-policies · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), job_key* text, label text, level text, recipient_user_ids _uuid, recipient_roles _text, note text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Automation Results (automation-results)/api/v1/automation-results · /api/platform/automation-results · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), result_no text (read-only), job_key text (read-only), title text (read-only), summary text (read-only), items jsonb (read-only), item_count integer (read-only), link text (read-only), source text (read-only), level text (read-only), status text (read-only), outcome jsonb (read-only), error text (read-only), approval_id uuid (read-only), recipient_user_ids _uuid (read-only), recipient_roles _text (read-only), acted_at timestamp with time zone (read-only), acted_by uuid (read-only), dismissed_at timestamp with time zone (read-only), dismissed_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Document Intake (intake-sources)/api/v1/intake-sources · /api/platform/intake-sources · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, kind text, drive_source_id uuid, folder_path text, mailbox_address text, target_kind* text, poll_minutes integer, next_poll_at timestamp with time zone (read-only), claimed_by text (read-only), claimed_at timestamp with time zone (read-only), last_polled_at timestamp with time zone (read-only), last_error text (read-only), items_count integer (read-only), is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Event Delivery (event-deliveries)/api/v1/event-deliveries · /api/platform/event-deliveries · /{id}list, getid bigint (read-only), subscriber text (read-only), event_id bigint (read-only), event_type text (read-only), status text (read-only), attempts integer (read-only), next_attempt_at timestamp with time zone (read-only), last_error text (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Intake Log (intake-items)/api/v1/intake-items · /api/platform/intake-items · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), item_no text (read-only), source_id uuid (read-only), external_ref text (read-only), file_name text (read-only), mime_type text (read-only), document_id uuid (read-only), target_kind text (read-only), target_module text (read-only), target_resource text (read-only), target_id uuid (read-only), target_no text (read-only), status text (read-only), reading jsonb (read-only), message text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Reminders & Escalations (sla-actions)/api/v1/sla-actions · /api/platform/sla-actions · /{id}list, getid uuid (read-only), subject text (read-only), item_id uuid (read-only), item_ref text (read-only), kind text (read-only), target_user_id uuid (read-only), target_role text (read-only), note text (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Time Limits (sla-policies)/api/v1/sla-policies · /api/platform/sla-policies · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), subject* text, label text, due_hours numeric, remind_after_hours numeric, escalate_after_hours numeric, escalate_to text, escalate_role text, escalate_user_id uuid, reassign boolean, is_active boolean, applies_from timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Lote

RecursoEndpointsOperacionesCampos
Job Definitions (batch-job-definitions)/api/v1/batch-job-definitions · /api/platform/batch-job-definitions · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, module* text, category text, description text, selects text, acts text, handler text, parameters jsonb (read-only), supports_dry_run boolean, is_idempotent boolean, repeat_note text, requires_role text, max_records integer (read-only), typical_runtime_note text (read-only), is_default boolean (read-only), is_active boolean, sort_order integer, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Job Runs (batch-runs)/api/v1/batch-runs · /api/platform/batch-runs · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), job_code text (read-only), module text (read-only), dry_run boolean (read-only), status text (read-only), selected integer (read-only), succeeded integer (read-only), skipped integer (read-only), failed integer (read-only), summary text (read-only), error_detail text (read-only), duration_ms integer (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), parameters jsonb (read-only), job_name text (read-only), category text (read-only), run_by_name text (read-only), set_run_no text (read-only), set_code text (read-only), standing text (read-only)
Job Schedules (batch-schedules)/api/v1/batch-schedules · /api/platform/batch-schedules · /{id}list, get, create, change, deleteid uuid (read-only), job_id* uuid, name text, cadence text, run_at time without time zone, day_of_week integer, day_of_month integer, parameters jsonb (read-only), dry_run boolean, is_active boolean, last_run_at timestamp with time zone (read-only), next_due timestamp with time zone (read-only), org_unit_id uuid (read-only), description text, starts_at timestamp with time zone, run_once boolean (read-only), run_as uuid (read-only), origin text (read-only), origin_ref jsonb (read-only), claimed_at timestamp with time zone (read-only), claimed_by text (read-only), last_run_id uuid (read-only), last_status text (read-only), last_error text (read-only), run_count integer (read-only), time_zone text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Job Sets (batch-sets)/api/v1/batch-sets · /api/platform/batch-sets · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, module text, description text, on_failure text, is_default boolean (read-only), is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Set Runs (batch-set-runs)/api/v1/batch-set-runs · /api/platform/batch-set-runs · /{id}list, getid uuid (read-only), run_no text (read-only), set_id uuid (read-only), set_code text (read-only), dry_run boolean (read-only), steps_total integer (read-only), steps_done integer (read-only), steps_failed integer (read-only), status text (read-only), stopped_at_step integer (read-only), summary text (read-only), duration_ms integer (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), run_by uuid (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Set Steps (batch-set-steps)/api/v1/batch-set-steps · /api/platform/batch-set-steps · /{id}list, get, create, change, deleteid uuid (read-only), set_id* uuid, step_no* integer, job_id* uuid, parameters jsonb (read-only), continue_on_failure boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Flujos de negocio

RecursoEndpointsOperacionesCampos
Flow Definitions (flows)/api/v1/flows · /api/platform/flows · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, family text, description text, primary_module text, is_template boolean, copied_from uuid (read-only), is_active boolean, sort_order integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Flow Handovers (flow-edges)/api/v1/flow-edges · /api/platform/flow-edges · /{id}list, get, create, change, deleteid uuid (read-only), flow_id* uuid, from_step_id* uuid, to_step_id* uuid, kind text, label text, link_side text, link_column text, link_by text, note text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Flow Snapshots (flow-snapshots)/api/v1/flow-snapshots · /api/platform/flow-snapshots · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), flow_id uuid (read-only), taken_at timestamp with time zone (read-only), taken_by uuid (read-only), steps jsonb (read-only), edges jsonb (read-only), summary text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Flow Steps (flow-steps)/api/v1/flow-steps · /api/platform/flow-steps · /{id}list, get, create, change, deleteid uuid (read-only), flow_id* uuid, step_no* integer, code* text, name* text, module* text, resource text, kind text, description text, owner_role text, measure_table text, state_column text, open_states _text, done_states _text, is_milestone boolean, lane integer, column_no integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Scenario Runs (scenario-runs)/api/v1/scenario-runs · /api/platform/scenario-runs · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), scenario_id uuid (read-only), scenario_code text (read-only), flow_id uuid (read-only), seed_used bigint (read-only), volume integer (read-only), status text (read-only), calls integer (read-only), created integer (read-only), failed integer (read-only), skipped integer (read-only), summary text (read-only), before_edges jsonb (read-only), after_edges jsonb (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), duration_ms integer (read-only), run_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Scenario Steps (scenario-steps)/api/v1/scenario-steps · /api/platform/scenario-steps · /{id}list, get, create, change, deleteid uuid (read-only), scenario_id* uuid, step_no* integer, name* text, flow_step_code text, method text, path* text, body jsonb, depends_on integer, captures jsonb, optional boolean, note text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Test Scenarios (scenarios)/api/v1/scenarios · /api/platform/scenarios · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), flow_id* uuid, code* text, name* text, description text, volume integer, seed bigint, stop_on_failure boolean, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Custom Objects

RecursoEndpointsOperacionesCampos
Custom Objects (custom-objects)/api/v1/custom-objects · /api/platform/custom-objects · /{id}list, getid uuid (read-only), object_key text (read-only), label text (read-only), plural_label text (read-only), description text (read-only), prefix text (read-only), next_no bigint (read-only), title_field text (read-only), has_status boolean (read-only), status_options jsonb (read-only), table_name text (read-only), record_count bigint (read-only), max_records integer (read-only), is_active boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Object Fields (custom-object-fields)/api/v1/custom-object-fields · /api/platform/custom-object-fields · /{id}list, getid uuid (read-only), object_id uuid (read-only), field_key text (read-only), label text (read-only), help text (read-only), data_type text (read-only), options jsonb (read-only), ref_target text (read-only), is_required boolean (read-only), is_unique boolean (read-only), is_searchable boolean (read-only), is_sensitive boolean (read-only), min_value numeric (read-only), max_value numeric (read-only), max_length integer (read-only), default_value text (read-only), show_in_list boolean (read-only), sort_order integer (read-only), is_active boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Retención de datos

RecursoEndpointsOperacionesCampos
Archived Records (archived-records)/api/v1/archived-records · /api/platform/archived-records · /{id}list, getid uuid (read-only), policy_id uuid (read-only), run_id uuid (read-only), target text (read-only), source_table text (read-only), source_id text (read-only), root_id uuid (read-only), depth integer (read-only), row_data jsonb (read-only), source_dated_at timestamp with time zone (read-only), archived_at timestamp with time zone (read-only), restored_at timestamp with time zone (read-only), restored_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Retention Policies (retention-policies)/api/v1/retention-policies · /api/platform/retention-policies · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, target* text, action* text, older_than_years* integer, untouched_years* integer, frequency* text, first_run_at timestamp with time zone, max_rows_per_run integer, is_active boolean, notes text, next_run_at timestamp with time zone (read-only), claimed_at timestamp with time zone (read-only), last_run_at timestamp with time zone (read-only), last_run_status text (read-only), last_run_id uuid (read-only), purge_archived_after_years integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Retention Runs (retention-runs)/api/v1/retention-runs · /api/platform/retention-runs · /{id}list, getid uuid (read-only), policy_id uuid (read-only), trigger text (read-only), preview boolean (read-only), action text (read-only), target text (read-only), cutoff_at timestamp with time zone (read-only), untouched_since timestamp with time zone (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), status text (read-only), examined integer (read-only), archived integer (read-only), purged integer (read-only), kept integer (read-only), dependents integer (read-only), kept_reasons jsonb (read-only), error text (read-only), run_by uuid (read-only), org_unit_id uuid (read-only), archive_purged integer (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Correo electrónico

RecursoEndpointsOperacionesCampos
Email Events (mail-events)/api/v1/mail-events · /api/platform/mail-events · /{code}list, getcode text (read-only), module text (read-only), label text (read-only), description text (read-only), default_recipients jsonb (read-only), default_subject text (read-only), default_body text (read-only), is_default_on boolean (read-only), sort_order integer (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Email Outbox (mail-outbox)/api/v1/mail-outbox · /api/platform/mail-outbox · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), event_code text (read-only), rule_id uuid (read-only), module text (read-only), resource text (read-only), record_id text (read-only), record_ref text (read-only), to_address text (read-only), to_name text (read-only), to_user_id uuid (read-only), from_email text (read-only), from_name text (read-only), reply_to text (read-only), subject text (read-only), body_text text (read-only), body_html text (read-only), status text (read-only), transport text (read-only), attempts integer (read-only), last_error text (read-only), external_id text (read-only), dedupe_key text (read-only), next_attempt_at timestamp with time zone (read-only), sent_at timestamp with time zone (read-only), unsubscribe_exempt text (read-only), attachments jsonb (read-only), initiated_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Email Rules (mail-rules)/api/v1/mail-rules · /api/platform/mail-rules · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), event_code* text, name* text, recipients jsonb, subject text, body text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Email Settings (mail-settings)/api/v1/mail-settings · /api/platform/mail-settings · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), is_enabled boolean, from_email text, from_name text, reply_to text, transport text, smtp_host text, smtp_port integer, smtp_security text, username text, tenant text, secret_cipher bytea (read-only), secret_last4 text (read-only), footer text, last_tested_at timestamp with time zone (read-only), last_test_ok boolean (read-only), last_test_message text (read-only), console_url text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Support Copy (mail-support-copy)/api/v1/mail-support-copy · /api/platform/mail-support-copy · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), forward_to text, is_enabled boolean, include_internal boolean, since timestamp with time zone (read-only), last_run_at timestamp with time zone (read-only), last_forwarded integer (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Eventos y Webhooks

RecursoEndpointsOperacionesCampos
Webhook Deliveries (webhook-deliveries)/api/v1/webhook-deliveries · /api/platform/webhook-deliveries · /{id}list, getid uuid (read-only), webhook_id uuid (read-only), event_type text (read-only), payload jsonb (read-only), signature text (read-only), attempt integer (read-only), status text (read-only), response_code integer (read-only), response_body text (read-only), delivered_at timestamp with time zone (read-only), org_unit_id uuid (read-only), source_event_id bigint (read-only), claimed_until timestamp with time zone (read-only)
Webhooks (webhooks)/api/v1/webhooks · /api/platform/webhooks · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, direction text, target_url text, events _text, secret_cipher bytea (read-only), signature_algo text, status text, retry_limit integer, delivery_count bigint (read-only), failure_count bigint (read-only), last_delivery_at timestamp with time zone (read-only), org_unit_id uuid (read-only), exception_override jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Extension Hooks

RecursoEndpointsOperacionesCampos
Extension Hooks (extension-hooks)/api/v1/extension-hooks · /api/platform/extension-hooks · /{id}list, getid uuid (read-only), name text (read-only), description text (read-only), point text (read-only), module_key text (read-only), resource_key text (read-only), to_status _text (read-only), condition_expr text (read-only), action_kind text (read-only), message text (read-only), message_expr text (read-only), webhook_id uuid (read-only), payload_map jsonb (read-only), mode text (read-only), is_active boolean (read-only), sort_order integer (read-only), timeout_ms integer (read-only), max_per_minute integer (read-only), run_count bigint (read-only), veto_count bigint (read-only), error_count bigint (read-only), consecutive_errors integer (read-only), last_run_at timestamp with time zone (read-only), last_error text (read-only), last_error_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Hook Runs (hook-runs)/api/v1/hook-runs · /api/platform/hook-runs · /{id}list, getid bigint (read-only), hook_id uuid (read-only), hook_name text (read-only), point text (read-only), module_key text (read-only), resource_key text (read-only), record_id text (read-only), event_key text (read-only), outcome text (read-only), mode text (read-only), message text (read-only), duration_ms numeric (read-only), detail jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Integración

RecursoEndpointsOperacionesCampos
Certificates (certificates)/api/v1/certificates · /api/platform/certificates · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, kind* text, pem* text, key_cipher bytea (read-only), has_key boolean (read-only), subject text, issuer text, serial_no text, not_before timestamp with time zone, not_after timestamp with time zone, fingerprint_sha256 text, chain_length integer, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Connections (connections)/api/v1/connections · /api/platform/connections · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, connector_id* uuid, environment text, base_url text, username text, secret_cipher bytea (read-only), secret_last4 text (read-only), config jsonb, status text, last_tested_at timestamp with time zone (read-only), last_test_ok boolean (read-only), last_test_message text (read-only), owner_id uuid, transport text, host text, port integer, direct_protocol text, server_name text, tls_min_version text, ca_certificate_id uuid, client_certificate_id uuid, pin_sha256 text, last_handshake jsonb (read-only), direct_reachable boolean (read-only), direct_checked_at timestamp with time zone (read-only), direct_probe jsonb (read-only), exception_override jsonb (read-only), credential_kind text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Connector Catalog (connectors)/api/v1/connectors · /api/platform/connectors · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, connector_type text, vendor text, category text, auth_type text, direction text, docs_url text, config_schema jsonb, is_certified boolean, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Data Pipelines (pipelines)/api/v1/pipelines · /api/platform/pipelines · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, source_connection_id uuid, source_resource text, destination_connection_id uuid, destination_resource text, sync_mode text, cursor_field text, cursor_value text (read-only), primary_key text, schedule_cron text, batch_size integer, status text, last_run_at timestamp with time zone (read-only), last_run_status text (read-only), total_records_synced bigint (read-only), exception_override jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Pipeline Runs (pipeline-runs)/api/v1/pipeline-runs · /api/platform/pipeline-runs · /{id}list, getid uuid (read-only), pipeline_id uuid (read-only), run_no text (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), duration_ms integer (read-only), status text (read-only), records_read integer (read-only), records_written integer (read-only), records_failed integer (read-only), bytes_moved bigint (read-only), cursor_from text (read-only), cursor_to text (read-only), error text (read-only), triggered_by text (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Migración de sistemas heredados

RecursoEndpointsOperacionesCampos
Archived History (migration-history)/api/v1/migration-history · /api/platform/migration-history · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), source_id uuid (read-only), source_code text (read-only), object_code text (read-only), doc_type text (read-only), legacy_no text (read-only), doc_date date (read-only), partner_name text (read-only), currency text (read-only), amount numeric (read-only), status text (read-only), payload jsonb (read-only), batch_id uuid (read-only), archived_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Field Maps (migration-fields)/api/v1/migration-fields · /api/platform/migration-fields · /{id}list, get, create, change, deleteid uuid (read-only), object_id* uuid, source_field text, target_field* text, transform text, arguments jsonb, required boolean, note text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Migration Batches (migration-batches)/api/v1/migration-batches · /api/platform/migration-batches · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), batch_no text (read-only), source_id uuid (read-only), object_id uuid (read-only), object_code text (read-only), data_class text (read-only), file_name text (read-only), row_count integer (read-only), staged integer (read-only), validated integer (read-only), rejected integer (read-only), loaded integer (read-only), archived integer (read-only), status text (read-only), summary text (read-only), kind text (read-only), as_of date (read-only), source_drive_id uuid (read-only), source_path text (read-only), source_external_id text (read-only), chunk_no integer (read-only), first_row integer (read-only), last_row integer (read-only), ingest_run_id uuid (read-only), source_code text (read-only), object_name text (read-only), target_module text (read-only), target_resource text (read-only), created_by_name text (read-only)
Migration Objects (migration-objects)/api/v1/migration-objects · /api/platform/migration-objects · /{id}list, get, create, change, deleteid uuid (read-only), source_id* uuid, code* text, name* text, source_object text, source_note text, data_class text, target_module text, target_resource text, target_path text, key_fields _text, sequence_no integer, depends_on _text, is_active boolean, notes text, skipped_at timestamp with time zone (read-only), skipped_by uuid (read-only), skip_reason text (read-only), number_policy text (read-only), parallel_since date (read-only), deltas_off boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Migration Resets (migration-resets)/api/v1/migration-resets · /api/platform/migration-resets · /{id}list, getid uuid (read-only), reset_at timestamp with time zone (read-only), reset_by uuid (read-only), scope text (read-only), batches integer (read-only), records integer (read-only), runs integer (read-only), history integer (read-only), balances integer (read-only), removed integer (read-only), refused integer (read-only), summary text (read-only), detail jsonb (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Migration Runs (migration-runs)/api/v1/migration-runs · /api/platform/migration-runs · /{id}list, getid uuid (read-only), batch_id uuid (read-only), run_no text (read-only), mode text (read-only), dry_run boolean (read-only), attempted integer (read-only), succeeded integer (read-only), failed integer (read-only), skipped integer (read-only), status text (read-only), summary text (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), duration_ms integer (read-only), run_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Opening Balances (opening-balances)/api/v1/opening-balances · /api/platform/opening-balances · /{id}list, getid uuid (read-only), batch_id uuid (read-only), as_of date (read-only), account_no text (read-only), account_name text (read-only), cost_center text (read-only), currency text (read-only), debit numeric (read-only), credit numeric (read-only), posted_journal_id uuid (read-only), posted_at timestamp with time zone (read-only), note text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Source Systems (migration-sources)/api/v1/migration-sources · /api/platform/migration-sources · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, vendor text, family text, release text, extraction text, endpoint text, username text, secret_enc bytea (read-only), secret_last4 text (read-only), notes text, is_template boolean (read-only), is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Otros recursos

RecursoEndpointsOperacionesCampos
Batch jobs (batch-jobs)/api/v1/batch-jobs · /api/platform/batch-jobs · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), code text (read-only), name text (read-only), module text (read-only), category text (read-only), description text (read-only), selects text (read-only), acts text (read-only), handler text (read-only), parameters jsonb (read-only), supports_dry_run boolean (read-only), is_idempotent boolean (read-only), repeat_note text (read-only), requires_role text (read-only), is_default boolean (read-only), is_active boolean (read-only), sort_order integer (read-only), runnable boolean (read-only), runs integer (read-only), last_run timestamp with time zone (read-only), last_status text (read-only), schedules integer (read-only), standing text (read-only)

Pagos

RecursoEndpointsOperacionesCampos
Payment Engines (payment-providers)/api/v1/payment-providers · /api/platform/payment-providers · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, provider* text, mode text, merchant_id text, public_key text, secret_cipher bytea (read-only), secret_last4 text (read-only), webhook_secret_cipher bytea (read-only), supported_methods _text, supported_currencies _text, percentage_fee numeric, fixed_fee numeric, settlement_days integer, clearing_account_id uuid, fee_account_id uuid, cost_center_id uuid, is_default boolean, status text, last_tested_at timestamp with time zone (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Transactions (payment-transactions)/api/v1/payment-transactions · /api/platform/payment-transactions · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), transaction_no text (read-only), provider_id uuid (read-only), transaction_type text (read-only), amount numeric (read-only), currency text (read-only), fee_amount numeric (read-only), net_amount numeric (read-only), method text (read-only), card_brand text (read-only), card_last4 text (read-only), source_module text (read-only), source_ref text (read-only), ar_invoice_id uuid (read-only), customer_ref text (read-only), provider_reference text (read-only), status text (read-only), failure_code text (read-only), failure_reason text (read-only), authorized_at timestamp with time zone (read-only), captured_at timestamp with time zone (read-only), settled_at timestamp with time zone (read-only), refunded_amount numeric (read-only), parent_transaction_id uuid (read-only), journal_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Printing

RecursoEndpointsOperacionesCampos
All Print Queues (print-jobs)/api/v1/print-jobs · /api/platform/print-jobs · /{id}list, getid uuid (read-only), org_unit_id uuid (read-only), user_id uuid (read-only), title text (read-only), doc_kind text (read-only), module text (read-only), resource text (read-only), record_id text (read-only), source text (read-only), printer_code text (read-only), copies integer (read-only), status text (read-only), pdf bytea (read-only), pdf_bytes integer (read-only), pages integer (read-only), error text (read-only), released_by uuid (read-only), released_at timestamp with time zone (read-only), printed_at timestamp with time zone (read-only), pdf_purged_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Printers (printers)/api/v1/printers · /api/platform/printers · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, kind text, location text, is_default boolean, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Queue Settings (queue-settings)/api/v1/queue-settings · /api/platform/queue-settings · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), print_keep_days integer, held_keep_days integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Process & Structure

RecursoEndpointsOperacionesCampos
Approval Document Types (approval-doc-types)/api/v1/approval-doc-types · /api/platform/approval-doc-types · /{id}list, get, create, change, deleteid uuid (read-only), doc_type* text, label* text, engine text (read-only), table_name text, id_column text, number_column text, amount_column text, currency_column text, party_column text, org_unit_column text, grant_module text, grant_resource text, status_column text, on_approved_status text, on_rejected_status text, when_no_rule text, allow_self_approval boolean, is_builtin boolean (read-only), is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Approval Requests (approval-requests)/api/v1/approval-requests · /api/platform/approval-requests · /{id}list, get, create, change, deleteid uuid (read-only), doc_type text (read-only), doc_label text (read-only), doc_id uuid (read-only), doc_no text (read-only), summary text (read-only), amount numeric (read-only), currency text (read-only), route_name text (read-only), status text (read-only), requested_by uuid (read-only), requested_by_name text (read-only), requested_at timestamp with time zone (read-only), decided_at timestamp with time zone (read-only), outcome_note text (read-only), chain text (read-only)
Approval Routes (approval-routes)/api/v1/approval-routes · /api/platform/approval-routes · /{id}list, get, create, change, deleteid uuid (read-only), doc_type* text, code* text, name* text, priority integer, min_amount numeric, max_amount numeric, scope_org_unit_id uuid, conditions jsonb, condition_expr text, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Approval Rule Catalogue (approval-rule-catalog)/api/v1/approval-rule-catalog · /api/platform/approval-rule-catalog · /{id}list, get, create, change, deleteid uuid (read-only), engine text (read-only), doc_type text (read-only), code text (read-only), name text (read-only), priority integer (read-only), amount_threshold numeric (read-only), approver text (read-only), is_active boolean (read-only), kept_in text (read-only), step_count integer (read-only), edit_path text (read-only)
Approval Steps (approval-route-steps)/api/v1/approval-route-steps · /api/platform/approval-route-steps · /{id}list, get, create, change, deleteid uuid (read-only), route_id* uuid, level_no* integer, name text, approver_kind* text, approver_user_id uuid, approver_role text, manager_levels integer, fallback_kind text, fallback_user_id uuid, fallback_role text, amount_threshold numeric, due_in_hours integer, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Extendable Picklists (picklists)/api/v1/picklists · /api/platform/picklists · /{id}list, get, create, change, deleteid uuid (read-only), list_key text (read-only), list_name text (read-only), table_name text (read-only), column_name text (read-only), builtin_count integer (read-only), added_count integer (read-only), builtin_values _text (read-only), converted boolean (read-only)
Status Transitions (status-transitions)/api/v1/status-transitions · /api/platform/status-transitions · /{id}list, get, create, change, deleteid uuid (read-only), doc_type* text, from_code text, to_code* text, verb* text, label* text, allowed_roles _text, required_fields _text, guard_expr text, require_note boolean, is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Statuses (status-states)/api/v1/status-states · /api/platform/status-states · /{id}list, get, create, change, deleteid uuid (read-only), doc_type* text, code* text, label* text, category text, sort_order integer, is_builtin boolean (read-only), is_active boolean, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Unit Type Rules (org-unit-type-rules)/api/v1/org-unit-type-rules · /api/platform/org-unit-type-rules · /{id}list, get, create, change, deleteid uuid (read-only), child_type* text, parent_type* text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Unit Types (org-unit-types)/api/v1/org-unit-types · /api/platform/org-unit-types · /{id}list, get, create, change, deleteid uuid (read-only), code* text, label* text, is_builtin boolean (read-only), is_active boolean, sort_order integer, description text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

API publicada

RecursoEndpointsOperacionesCampos
Allowed Software (api-allowlist)/api/v1/api-allowlist · /api/platform/api-allowlist · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), client_id* uuid, kind* text, value* text, note text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
API Call Log (api-calls)/api/v1/api-calls · /api/platform/api-calls · /{id}list, getid bigint (read-only), org_unit_id uuid (read-only), client_id uuid (read-only), exposure_id uuid (read-only), at timestamp with time zone (read-only), protocol text (read-only), method text (read-only), path text (read-only), tool_name text (read-only), module_key text (read-only), resource_key text (read-only), status integer (read-only), outcome text (read-only), refusal text (read-only), row_count integer (read-only), duration_ms integer (read-only), remote_ip text (read-only), origin text (read-only), user_agent text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
API Clients (api-clients)/api/v1/api-clients · /api/platform/api-clients · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, description text, key_prefix text, key_cipher bytea (read-only), key_last4 text (read-only), scopes _text, rate_limit_per_minute integer, allowed_ips _text, status text, expires_at timestamp with time zone, last_used_at timestamp with time zone (read-only), call_count bigint (read-only), org_unit_id uuid (read-only), protocol text, run_as uuid, software_name text, contact_email text, homepage_url text, require_allowlist boolean, mcp_instructions text, key_sha256 text (read-only), key_issued_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
API Grants (api-grants)/api/v1/api-grants · /api/platform/api-grants · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), client_id* uuid, exposure_id* uuid, can_read boolean, can_create boolean, can_update boolean, can_delete boolean, expires_at timestamp with time zone, granted_by uuid (read-only), granted_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Exposures (api-exposures)/api/v1/api-exposures · /api/platform/api-exposures · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, description text, module_key* text, resource_key* text, allow_read boolean, allow_create boolean, allow_update boolean, allow_delete boolean, column_mode text, columns _text, row_filter jsonb, max_rows integer, mcp_enabled boolean, mcp_hint text, status text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
RecursoEndpointsOperacionesCampos
Identity Providers (raw) (identity-providers)/api/v1/identity-providers · /api/platform/identity-providers · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, protocol text, vendor text, issuer text, metadata_url text, client_id text, client_secret_cipher bytea (read-only), scopes _text, attribute_map jsonb, default_role_id uuid, auto_provision boolean, is_enabled boolean, org_unit_id uuid (read-only), sso_url text (read-only), slo_url text (read-only), acs_url text (read-only), sp_entity_id text (read-only), authorize_url text (read-only), token_url text (read-only), userinfo_url text (read-only), jwks_url text (read-only), redirect_uri text (read-only), certificate text (read-only), sign_request boolean (read-only), ldap_url text (read-only), ldap_base_dn text (read-only), ldap_bind_dn text (read-only), ldap_user_filter text (read-only), settings jsonb (read-only), button_label text (read-only), sort_order integer (read-only), is_default boolean (read-only), require_verified_domain boolean (read-only), name_id_format text (read-only), idp_initiated boolean (read-only), want_encrypted boolean (read-only), sp_private_key_cipher bytea (read-only), sp_certificate text (read-only), role_map jsonb (read-only), slo_enabled boolean (read-only), clock_skew_seconds integer (read-only), mfa_mode text (read-only), mfa_claims _text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
RecursoEndpointsOperacionesCampos
HR Document Types (document-types)/api/v1/document-types · /api/platform/document-types · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, category text, is_mandatory boolean, requires_signature boolean, expires boolean, valid_months integer, retention_years integer, applies_to text, country text, description text, is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Legal Holds (legal-holds)/api/v1/legal-holds · /api/platform/legal-holds · /{id}list, get, create, change, deleteid uuid (read-only), hold_no text (read-only), matter_name* text, reason* text, description text, custodian_user_id uuid, custodian_name text, employee_ids _uuid, applicant_ids _uuid, document_type_ids _uuid, date_from date, date_to date, tables _text, subject_ids _uuid, status text (read-only), placed_by uuid, placed_at timestamp with time zone (read-only), released_by uuid (read-only), released_at timestamp with time zone (read-only), release_note text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Records Exports (records-exports)/api/v1/records-exports · /api/platform/records-exports · /{id}list, getid uuid (read-only), job_no text (read-only), scope text (read-only), employee_id uuid (read-only), applicant_id uuid (read-only), hold_id uuid (read-only), include_files boolean (read-only), note text (read-only), status text (read-only), subject_label text (read-only), file_name text (read-only), byte_size bigint (read-only), sha256 text (read-only), file bytea (read-only), counts jsonb (read-only), error text (read-only), requested_by uuid (read-only), requested_at timestamp with time zone (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), heartbeat_at timestamp with time zone (read-only), downloads integer (read-only), last_downloaded_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Report Data Sources

RecursoEndpointsOperacionesCampos
Report Data Sources (report-sources)/api/v1/report-sources · /api/platform/report-sources · /{id}list, getid uuid (read-only), cube_key text (read-only), label text (read-only), description text (read-only), entity text (read-only), include_columns _text (read-only), is_active boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Datos sintéticos

RecursoEndpointsOperacionesCampos
Generation Runs (generation-runs)/api/v1/generation-runs · /api/platform/generation-runs · /{id}list, getid uuid (read-only), run_no text (read-only), generator_id uuid (read-only), requested integer (read-only), produced integer (read-only), rejected integer (read-only), fidelity jsonb (read-only), privacy jsonb (read-only), too_close integer (read-only), seed text (read-only), parameters jsonb (read-only), status text (read-only), withheld_reason text (read-only), error_detail text (read-only), duration_ms integer (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), run_by uuid (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Synthetic Data Generators (generators)/api/v1/generators · /api/platform/generators · /{id}list, get, create, change, deleteid uuid (read-only), code* text, name* text, purpose* text, module* text, engine_kind text, vendor text, base_url text, auth_type text, config jsonb (read-only), secret_cipher bytea (read-only), secret_last4 text (read-only), source_table text, source_columns _text, min_distance numeric, status text (read-only), fitted_at timestamp with time zone (read-only), fitted_rows integer (read-only), profile jsonb (read-only), last_error text (read-only), is_active boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)

Automatización del flujo de trabajo

RecursoEndpointsOperacionesCampos
Workflow Approvals (approvals)/api/v1/approvals · /api/platform/approvals · /{id}list, get, create, change, deleteid uuid (read-only), run_id uuid (read-only), approval_no text (read-only), subject* text, detail text, requested_by uuid (read-only), assigned_to uuid, due_at timestamp with time zone, status text (read-only), decided_at timestamp with time zone (read-only), decided_by uuid (read-only), comment text, org_unit_id uuid (read-only), approver_role text (read-only), approver_employee_id uuid (read-only), level_no integer (read-only), automation_result_id uuid (read-only), reminded_at timestamp with time zone (read-only), escalated_at timestamp with time zone (read-only), escalated_to uuid (read-only), approver_user_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Workflow Runs (workflow-runs)/api/v1/workflow-runs · /api/platform/workflow-runs · /{id}list, getid uuid (read-only), workflow_id uuid (read-only), run_no text (read-only), triggered_by text (read-only), trigger_ref text (read-only), input jsonb (read-only), context jsonb (read-only), status text (read-only), started_at timestamp with time zone (read-only), finished_at timestamp with time zone (read-only), duration_ms integer (read-only), steps_run integer (read-only), error text (read-only), user_id uuid (read-only), org_unit_id uuid (read-only), resume_at timestamp with time zone (read-only), resume_after_line integer (read-only), waiting_on text (read-only), depth integer (read-only), claimed_by text (read-only), claimed_at timestamp with time zone (read-only), source_event_id bigint (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)
Workflows (workflows)/api/v1/workflows · /api/platform/workflows · /{id}list, get, create, change, deleteid uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, description text, category text, trigger_type text, trigger_event text, trigger_module text, schedule_cron text, condition jsonb, status text, run_count integer (read-only), success_count integer (read-only), failure_count integer (read-only), last_run_at timestamp with time zone (read-only), owner_id uuid, max_retries integer, timeout_seconds integer, next_due_at timestamp with time zone (read-only), schedule_zone text (read-only), schedule_claimed_by text (read-only), schedule_claimed_at timestamp with time zone (read-only), schedule_error text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only)