@celigo/api-specs 0.2.162 → 0.2.164
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/ai-agent.yml +20 -11
- package/dist/asynchelper.yml +19 -10
- package/dist/audit.yml +5 -5
- package/dist/export.yml +63 -26
- package/dist/guardrail.yml +8 -7
- package/dist/iclient.yml +3 -2
- package/dist/import.yml +79 -37
- package/dist/script.yml +15 -2
- package/dist/tool.yml +121 -47
- package/dist/tradingpartnerconnector.yml +3 -1
- package/package.json +1 -1
- package/schemas.json +1305 -1316
package/dist/tool.yml
CHANGED
|
@@ -2426,8 +2426,11 @@ paths:
|
|
|
2426
2426
|
input, and its `response` stage holds the saved records. Remove `mockOutput` from the export
|
|
2427
2427
|
to call the source again. `POST /v1/tools/{_id}/invoke` neither reads nor writes it. Imports
|
|
2428
2428
|
never send; each returns its saved `mockResponse`, or a placeholder response when none is
|
|
2429
|
-
saved (see `mockResponse` on imports). A
|
|
2430
|
-
|
|
2429
|
+
saved (see `mockResponse` on imports). A test run is keyed by the request's `triggeredAt`:
|
|
2430
|
+
one sent with a `triggeredAt` that an earlier test run of the tool already used is refused
|
|
2431
|
+
with 400 `test_run_not_allowed` ("Cannot run the test tool when it is already in the running
|
|
2432
|
+
state."), even after that run has finished. Runs with different `triggeredAt` values run at
|
|
2433
|
+
the same time, each returning its own result.
|
|
2431
2434
|
|
|
2432
2435
|
Test runs are a separate, short-lived history from normal runs — capture
|
|
2433
2436
|
any follow-up step or log details soon after the run completes.
|
|
@@ -2463,6 +2466,13 @@ paths:
|
|
|
2463
2466
|
the tool's saved `input.mockInput` — when this key is
|
|
2464
2467
|
absent, the input step receives an empty record.
|
|
2465
2468
|
additionalProperties: true
|
|
2469
|
+
triggeredAt:
|
|
2470
|
+
type: string
|
|
2471
|
+
format: date-time
|
|
2472
|
+
description: |-
|
|
2473
|
+
Identifies the test run; send the current time. A value an earlier
|
|
2474
|
+
test run of the tool already used is refused with 400
|
|
2475
|
+
`test_run_not_allowed`.
|
|
2466
2476
|
additionalProperties: true
|
|
2467
2477
|
x-celigo-ai-guidance:
|
|
2468
2478
|
- 'Always wrap the test input as {"input": {...}} — a bare input object is ignored and the input step receives an empty record, which fails with tool_input_schema_validation_failed when the tool''s input schema has required fields.'
|
|
@@ -2554,7 +2564,8 @@ paths:
|
|
|
2554
2564
|
description: |-
|
|
2555
2565
|
The run was refused before any step ran. A Tool with no steps fails with
|
|
2556
2566
|
`tool_empty_router`, and one whose branches don't all merge back with
|
|
2557
|
-
`tool_dangling_branch`; re-running the same document fails the same way.
|
|
2567
|
+
`tool_dangling_branch`; re-running the same document fails the same way. A
|
|
2568
|
+
`triggeredAt` an earlier test run already used fails with `test_run_not_allowed`.
|
|
2558
2569
|
content:
|
|
2559
2570
|
application/json:
|
|
2560
2571
|
schema:
|
|
@@ -3576,7 +3587,8 @@ components:
|
|
|
3576
3587
|
fields. There is no separate `date` enum value.
|
|
3577
3588
|
|
|
3578
3589
|
**Complex Types (require additional configuration)**
|
|
3579
|
-
- `object`: Creates a nested object
|
|
3590
|
+
- `object`: Creates a nested object from child mappings in the 'mappings' array, or
|
|
3591
|
+
copies a whole object with `extract` (one or the other, not both)
|
|
3580
3592
|
|
|
3581
3593
|
**Array Types**
|
|
3582
3594
|
- `stringarray`: Array of strings
|
|
@@ -3624,7 +3636,7 @@ components:
|
|
|
3624
3636
|
string: Text values; converts other types to their string representation.
|
|
3625
3637
|
number: Numeric values; attempts conversion from strings.
|
|
3626
3638
|
boolean: True/false values; converts truthy/falsy values.
|
|
3627
|
-
object: Nested object
|
|
3639
|
+
object: Nested object built from child `mappings`, or copied whole with `extract` (not both).
|
|
3628
3640
|
stringarray: Array of string values.
|
|
3629
3641
|
numberarray: Array of numeric values.
|
|
3630
3642
|
booleanarray: Array of boolean values.
|
|
@@ -3702,7 +3714,10 @@ components:
|
|
|
3702
3714
|
- JSON path patterns ALWAYS execute from the TOP-LEVEL root of the input record
|
|
3703
3715
|
- The system maintains this context even in deeply nested mappings
|
|
3704
3716
|
- For object mappings without child mappings, extract should return a complete object
|
|
3705
|
-
-
|
|
3717
|
+
- An `object` row takes `extract` (to copy a whole object) or child `mappings`, not
|
|
3718
|
+
both: a row with both fails with 422 (`"extract" should not be present if
|
|
3719
|
+
"mappings" field is present`). A `buildArrayHelper` entry is different: there
|
|
3720
|
+
`extract` and `mappings` work together.
|
|
3706
3721
|
- The root is the record as it arrives: an object record roots at `$.field`; a
|
|
3707
3722
|
grouped record (an array of rows — grouped exports, file key columns, NetSuite
|
|
3708
3723
|
grouped saved searches) roots at the array, so its rows are addressed as
|
|
@@ -4656,7 +4671,8 @@ components:
|
|
|
4656
4671
|
fields. There is no separate `date` enum value.
|
|
4657
4672
|
|
|
4658
4673
|
**Complex Types (require additional configuration)**
|
|
4659
|
-
- `object`: Creates a nested object
|
|
4674
|
+
- `object`: Creates a nested object from child mappings in the 'mappings' array, or
|
|
4675
|
+
copies a whole object with `extract` (one or the other, not both)
|
|
4660
4676
|
|
|
4661
4677
|
**Array Types**
|
|
4662
4678
|
- `stringarray`: Array of strings
|
|
@@ -4704,7 +4720,7 @@ components:
|
|
|
4704
4720
|
string: Text values; converts other types to their string representation.
|
|
4705
4721
|
number: Numeric values; attempts conversion from strings.
|
|
4706
4722
|
boolean: True/false values; converts truthy/falsy values.
|
|
4707
|
-
object: Nested object
|
|
4723
|
+
object: Nested object built from child `mappings`, or copied whole with `extract` (not both).
|
|
4708
4724
|
stringarray: Array of string values.
|
|
4709
4725
|
numberarray: Array of numeric values.
|
|
4710
4726
|
booleanarray: Array of boolean values.
|
|
@@ -4782,7 +4798,10 @@ components:
|
|
|
4782
4798
|
- JSON path patterns ALWAYS execute from the TOP-LEVEL root of the input record
|
|
4783
4799
|
- The system maintains this context even in deeply nested mappings
|
|
4784
4800
|
- For object mappings without child mappings, extract should return a complete object
|
|
4785
|
-
-
|
|
4801
|
+
- An `object` row takes `extract` (to copy a whole object) or child `mappings`, not
|
|
4802
|
+
both: a row with both fails with 422 (`"extract" should not be present if
|
|
4803
|
+
"mappings" field is present`). A `buildArrayHelper` entry is different: there
|
|
4804
|
+
`extract` and `mappings` work together.
|
|
4786
4805
|
- The root is the record as it arrives: an object record roots at `$.field`; a
|
|
4787
4806
|
grouped record (an array of rows — grouped exports, file key columns, NetSuite
|
|
4788
4807
|
grouped saved searches) roots at the array, so its rows are addressed as
|
|
@@ -6197,10 +6216,11 @@ components:
|
|
|
6197
6216
|
ALWAYS reference the `record` root regardless of
|
|
6198
6217
|
`inputContext` — only JSONPath anchoring flips.
|
|
6199
6218
|
- |-
|
|
6200
|
-
In `envelope` mode
|
|
6201
|
-
|
|
6202
|
-
|
|
6203
|
-
|
|
6219
|
+
In `envelope` mode the output is still a bare record: a
|
|
6220
|
+
`modify` transform returns the record with its mapped
|
|
6221
|
+
fields merged in (no `record` wrapper, no `job` or
|
|
6222
|
+
`settings` keys), and a `create` transform returns only
|
|
6223
|
+
the mapped fields.
|
|
6204
6224
|
- |-
|
|
6205
6225
|
Emit `inputContext` explicitly on new v2 transforms:
|
|
6206
6226
|
unset is read as `record`, but stating it makes the
|
|
@@ -13767,6 +13787,12 @@ components:
|
|
|
13767
13787
|
Avoid bare ``{{{jsonSerialize record}}}`` with no wrapper — leave the field undefined instead.
|
|
13768
13788
|
Also avoid wrapping a single post-mapped scalar field in ``jsonSerialize`` (e.g.
|
|
13769
13789
|
``{{{jsonSerialize record.<scalar>}}}``) — that pattern is brittle.
|
|
13790
|
+
- |-
|
|
13791
|
+
In a JSON body, write a string value with double braces inside the quotes
|
|
13792
|
+
(``"{{record.name}}"``): double braces JSON-escape the value at run time, with no HTML
|
|
13793
|
+
escaping. Triple braces insert the raw text, so a value holding a double quote,
|
|
13794
|
+
backslash, newline or tab fails that record with 422 ``invalid_json`` before anything
|
|
13795
|
+
is sent.
|
|
13770
13796
|
- |-
|
|
13771
13797
|
Every request context carries two data roots: ``data`` — the list of records in
|
|
13772
13798
|
the request, always present (Pattern B) — and ONE shape-specific root that follows
|
|
@@ -13896,10 +13922,12 @@ components:
|
|
|
13896
13922
|
is almost certainly the "leave body undefined" case (the
|
|
13897
13923
|
destination just wants the mapped record as JSON) or Pattern C
|
|
13898
13924
|
(use ``{{sku}}`` / ``{{quantity}}`` directly without
|
|
13899
|
-
``jsonSerialize`` inside a per-message envelope).
|
|
13900
|
-
|
|
13901
|
-
|
|
13902
|
-
|
|
13925
|
+
``jsonSerialize`` inside a per-message envelope). To embed a
|
|
13926
|
+
scalar in a JSON string literal, use double braces inside the
|
|
13927
|
+
quotes (``"{{record.<field>}}"``) WITHOUT ``jsonSerialize``;
|
|
13928
|
+
triple braces there fail on a quote, backslash, newline or tab
|
|
13929
|
+
in the value. The anti-pattern is specifically the
|
|
13930
|
+
``jsonSerialize`` wrap.
|
|
13903
13931
|
- |-
|
|
13904
13932
|
## Multipart/form-data uploads are a different body contract
|
|
13905
13933
|
|
|
@@ -16701,8 +16729,10 @@ components:
|
|
|
16701
16729
|
`extract` to pick the column when the query returns multiple.
|
|
16702
16730
|
Inject values from the incoming record with Handlebars and the
|
|
16703
16731
|
`record.` prefix — double braces for strings, which the platform
|
|
16704
|
-
quotes
|
|
16705
|
-
`SELECT id FROM users WHERE email = {{record.email}}`.
|
|
16732
|
+
quotes, escaping their apostrophes, and triple braces for numbers:
|
|
16733
|
+
`SELECT id FROM users WHERE email = {{record.email}}`. On Snowflake
|
|
16734
|
+
the quoting leaves backslashes, which Snowflake reads as escape
|
|
16735
|
+
sequences (see `query`).
|
|
16706
16736
|
extract:
|
|
16707
16737
|
type: string
|
|
16708
16738
|
description: |
|
|
@@ -16750,10 +16780,11 @@ components:
|
|
|
16750
16780
|
description: |-
|
|
16751
16781
|
SQL statements to execute; required when queryType is `["per_record"]`, `["per_page"]`, or `["first_page"]`, and typically contains a single statement.
|
|
16752
16782
|
Each element is a complete SQL statement as a plain string — never a single bare string and never an array of objects (objects cause a Cast error).
|
|
16753
|
-
Inject values from the incoming record with Handlebars using the `record.` prefix: double braces for strings and dates (`{{record.name}}`; the platform quotes and escapes
|
|
16783
|
+
Inject values from the incoming record with Handlebars using the `record.` prefix: double braces for strings and dates (`{{record.name}}`; the platform quotes the value and escapes its apostrophes) and triple braces for numbers (`{{{record.quantity}}}`).
|
|
16754
16784
|
Rendering is strict: a reference the render model cannot resolve (a bare `{{name}}` without prefix, or `record.*` when the arriving record is a grouped array) fails the step with `cannot_evaluate_handlebars` — it does not render an empty value.
|
|
16755
16785
|
`record` and `rows` are aliases chosen by the arriving data's shape: an object record binds `record` (`rows` undefined); a grouped array-record (e.g. upstream `groupByFields`) binds `rows` (`record` undefined) — address grouped rows as `{{rows.0.field}}` or iterate `{{#each rows}}`.
|
|
16756
|
-
Double braces (`{{record.field}}`) output
|
|
16786
|
+
Double braces (`{{record.field}}`) output a string value wrapped in single quotes with embedded quotes doubled, while triple braces output it raw; block helpers such as `{{#each}}` and `{{#if}}` use double braces as normal. In Snowflake queries a JSON number or boolean renders bare under double braces too (observed in export queries).
|
|
16787
|
+
On Snowflake, the quoting leaves backslashes, which Snowflake reads as escape sequences: a double-brace value holding a backslash arrives changed, and `PARSE_JSON({{jsonSerialize …}})` fails on a double quote or line break in the data (observed in export queries). Pass such values in a dollar-quoted constant with triple braces (`$${{{record.field}}}$$`), which Snowflake reads as is, but only when the value can't contain `$$`: a `$$` in it ends the constant, and the rest is read as SQL.
|
|
16757
16788
|
x-celigo-ai-guidance:
|
|
16758
16789
|
- |-
|
|
16759
16790
|
Use Handlebars to inject values from incoming records.
|
|
@@ -16781,14 +16812,18 @@ components:
|
|
|
16781
16812
|
- **Double-brace `{{record.field}}` vs. triple-brace `{{{record.field}}}`
|
|
16782
16813
|
is a QUOTING CHOICE, not a syntax rule.** In RDBMS context the
|
|
16783
16814
|
platform's Handlebars renderer treats double-brace specially: it
|
|
16784
|
-
|
|
16785
|
-
|
|
16786
|
-
|
|
16815
|
+
wraps a string value as a SQL string literal (single-quoted, with
|
|
16816
|
+
its apostrophes escaped), and in Snowflake export queries a number
|
|
16817
|
+
or boolean rendered bare, whether a JSON value or a numeric
|
|
16818
|
+
helper's result (`{{add 2 3}}`). Triple-brace emits the raw value
|
|
16819
|
+
with no quoting. In the same queries the wrapping was also seen on
|
|
16820
|
+
string helper output (`dateFormat`, `jsonSerialize`) and on
|
|
16821
|
+
`{{this}}` inside `{{#each}}`.
|
|
16787
16822
|
|
|
16788
16823
|
- `{{record.name}}` → `'Alice'` (auto-single-quoted, embedded `'` doubled to `''`)
|
|
16789
|
-
- `{{{record.name}}}` → `Alice` (raw
|
|
16790
|
-
- `{{record.qty}}` → `'5'`
|
|
16791
|
-
- `{{{record.qty}}}` → `5` (numeric literal — what you usually want for INT columns)
|
|
16824
|
+
- `{{{record.name}}}` → `Alice` (raw — never wrap it in single quotes of your own: the first apostrophe in the data ends the literal)
|
|
16825
|
+
- `{{record.qty}}` → `'5'` when `qty` arrives as the string `"5"`; a JSON number rendered bare in Snowflake export queries
|
|
16826
|
+
- `{{{record.qty}}}` → `5` (numeric literal either way — what you usually want for INT columns)
|
|
16792
16827
|
|
|
16793
16828
|
Pick by what the SQL needs at that slot:
|
|
16794
16829
|
|
|
@@ -16798,8 +16833,21 @@ components:
|
|
|
16798
16833
|
| Numeric column value (INT, DECIMAL, ...) | `{{{record.field}}}` |
|
|
16799
16834
|
| Stored procedure raw arg (already typed) | `{{{record.field}}}` |
|
|
16800
16835
|
| Identifier (table/column name) | `{{{record.field}}}` |
|
|
16801
|
-
| JSON literal (`PARSE_JSON
|
|
16802
|
-
|
|
16836
|
+
| JSON literal, Snowflake (`PARSE_JSON`) | `PARSE_JSON($${{{jsonSerialize record.subobject}}}$$)` (a dollar-quoted constant, read as is; only for data that can't contain `$$`, which ends it) |
|
|
16837
|
+
| JSON literal, PostgreSQL (`JSONB`) | `{{jsonSerialize record.subobject}}` (renders the JSON as a quoted string; not yet verified on PostgreSQL) |
|
|
16838
|
+
|
|
16839
|
+
- **Snowflake reads backslashes as escapes.** The double-brace
|
|
16840
|
+
quoting doubles embedded apostrophes but leaves backslashes, and
|
|
16841
|
+
Snowflake interprets backslash sequences inside a single-quoted
|
|
16842
|
+
literal: a value holding `C:\temp` arrives with a tab in it, with
|
|
16843
|
+
no error, and `PARSE_JSON({{jsonSerialize …}})` fails with
|
|
16844
|
+
`Error parsing JSON` whenever a string in the object holds a double
|
|
16845
|
+
quote or a line break, because `jsonSerialize` escapes those with
|
|
16846
|
+
backslashes (observed in export queries). For values that can hold
|
|
16847
|
+
these characters, use a dollar-quoted constant with triple braces
|
|
16848
|
+
(`$${{{record.field}}}$$`), which Snowflake reads as is, but only
|
|
16849
|
+
when the value can't contain `$$`: a `$$` in it ends the constant,
|
|
16850
|
+
and the rest is read as SQL.
|
|
16803
16851
|
- **Block helpers** (`{{#each}}`, `{{#if}}`, `{{/each}}`,
|
|
16804
16852
|
`{{#unless}}`) use double braces as normal — they emit no value.
|
|
16805
16853
|
- **Nested fields**: `{{record.properties.email}}` (auto-quoted)
|
|
@@ -16813,7 +16861,7 @@ components:
|
|
|
16813
16861
|
- UPSERT (MySQL): `["INSERT INTO users (id, name) VALUES ({{{record.id}}}, {{record.name}}) ON DUPLICATE KEY UPDATE name = {{record.name}}"]`
|
|
16814
16862
|
- MERGE (Snowflake): `["MERGE INTO target USING (SELECT {{record.email}} AS email) AS src ON target.email = src.email WHEN MATCHED THEN UPDATE SET name = {{record.name}}"]`
|
|
16815
16863
|
- Stored procedure (raw args): `["call netsuite.transformation_data_import({{record.record_type}}, 20)"]`
|
|
16816
|
-
- JSON literal column (Snowflake VARIANT): `["INSERT INTO events (payload) SELECT PARSE_JSON({{jsonSerialize record.financialEvents}})"]`
|
|
16864
|
+
- JSON literal column (Snowflake VARIANT; the data must not contain `$$`): `["INSERT INTO events (payload) SELECT PARSE_JSON($${{{jsonSerialize record.financialEvents}}}$$)"]`
|
|
16817
16865
|
- Per-page batch (different Handlebars context — see `queryType: per_page` below): `["{{#each batch_of_records}}UPDATE staging SET done=1 WHERE id={{{this.record.id}}};{{/each}}"]`
|
|
16818
16866
|
examples:
|
|
16819
16867
|
- - INSERT INTO orders (id, total) VALUES ({{{record.id}}}, {{{record.total}}})
|
|
@@ -21194,7 +21242,7 @@ components:
|
|
|
21194
21242
|
description: Property names the model must include in the structured output.
|
|
21195
21243
|
items:
|
|
21196
21244
|
type: string
|
|
21197
|
-
|
|
21245
|
+
additionalProperties:
|
|
21198
21246
|
type: boolean
|
|
21199
21247
|
description: When true, the structured output may include properties beyond those defined in `properties`.
|
|
21200
21248
|
schema:
|
|
@@ -22585,7 +22633,7 @@ components:
|
|
|
22585
22633
|
description: Property names the stored JSON Schema marks as required.
|
|
22586
22634
|
items:
|
|
22587
22635
|
type: string
|
|
22588
|
-
|
|
22636
|
+
additionalProperties:
|
|
22589
22637
|
type: boolean
|
|
22590
22638
|
description: Whether the stored JSON Schema allows properties beyond those in `properties`.
|
|
22591
22639
|
schema:
|
|
@@ -24156,13 +24204,14 @@ components:
|
|
|
24156
24204
|
type: string
|
|
24157
24205
|
description: |
|
|
24158
24206
|
Source expression. Accepts:
|
|
24159
|
-
-
|
|
24207
|
+
- A dot path from the record root (e.g. `email`, `address.city`), read from the
|
|
24208
|
+
incoming record. A path that matches no field writes nothing.
|
|
24160
24209
|
- Handlebars template (contains `{{`) for concatenation /
|
|
24161
24210
|
formatting / conditional logic (e.g.
|
|
24162
24211
|
`{{record.firstName}} {{record.lastName}}`).
|
|
24163
|
-
- A literal string (any value not starting with `$.` and not
|
|
24164
|
-
containing `{{`) — treated as a hardcoded value.
|
|
24165
24212
|
|
|
24213
|
+
A `$.` JSONPath (the Mapper 2.0 `mappings` syntax) reads nothing here, and a bare
|
|
24214
|
+
string is read as a field path, not a constant: set constants in `hardCodedValue`.
|
|
24166
24215
|
Omit when using `hardCodedValue`.
|
|
24167
24216
|
examples:
|
|
24168
24217
|
- address.city
|
|
@@ -24173,9 +24222,9 @@ components:
|
|
|
24173
24222
|
description: Static value written to `generate` instead of extracting from the source record.
|
|
24174
24223
|
x-celigo-ai-guidance:
|
|
24175
24224
|
- |-
|
|
24176
|
-
Static value written verbatim.
|
|
24177
|
-
|
|
24178
|
-
|
|
24225
|
+
Static value written verbatim. Use it for every constant: a bare
|
|
24226
|
+
string in ``extract`` is read as a field path. Mutually exclusive
|
|
24227
|
+
with ``extract``.
|
|
24179
24228
|
dataType:
|
|
24180
24229
|
type: string
|
|
24181
24230
|
enum:
|
|
@@ -24938,7 +24987,10 @@ components:
|
|
|
24938
24987
|
type: string
|
|
24939
24988
|
format: objectId
|
|
24940
24989
|
x-celigo-refModel: connectors
|
|
24941
|
-
description:
|
|
24990
|
+
description: |-
|
|
24991
|
+
Connector this import was created from, set when the import is part of an installed
|
|
24992
|
+
integration app. The app's install sets it: a create that sends it is refused with 403
|
|
24993
|
+
("Cannot create an Integration App resource").
|
|
24942
24994
|
examples:
|
|
24943
24995
|
- 60a2c4e6f321d800129a1a3c
|
|
24944
24996
|
adaptorType:
|
|
@@ -25480,7 +25532,8 @@ components:
|
|
|
25480
25532
|
description: |-
|
|
25481
25533
|
Custom JavaScript hooks that run at fixed points in the import lifecycle for
|
|
25482
25534
|
transformations, validation, and custom result handling beyond what configuration alone
|
|
25483
|
-
can express.
|
|
25535
|
+
can express. A hook name not listed here (an export's `preSavePage`, for example) is
|
|
25536
|
+
dropped on save without an error, so read `hooks` back after saving.
|
|
25484
25537
|
x-celigo-ai-guidance:
|
|
25485
25538
|
- |-
|
|
25486
25539
|
JavaScript hook references attached to lifecycle stages of the import.
|
|
@@ -26445,11 +26498,11 @@ components:
|
|
|
26445
26498
|
Once:
|
|
26446
26499
|
type: object
|
|
26447
26500
|
description: |-
|
|
26448
|
-
Configures flag-based exports that
|
|
26449
|
-
export's type is "once"; omit for other export types. Each run retrieves records
|
|
26450
|
-
tracking boolean field is false, then sets that field to true after successful
|
|
26451
|
-
later runs skip them; if a run fails, the flags are left unchanged and the
|
|
26452
|
-
retried automatically on the next run.
|
|
26501
|
+
Configures flag-based exports that skip records an earlier run already processed. Required
|
|
26502
|
+
when the export's type is "once"; omit for other export types. Each run retrieves records
|
|
26503
|
+
where the tracking boolean field is false, then sets that field to true after successful
|
|
26504
|
+
processing so later runs skip them; if a run fails, the flags are left unchanged and the
|
|
26505
|
+
records are retried automatically on the next run.
|
|
26453
26506
|
x-celigo-ai-guidance:
|
|
26454
26507
|
- |-
|
|
26455
26508
|
This object is REQUIRED when the export's type field is set to "once" and should
|
|
@@ -26474,7 +26527,6 @@ components:
|
|
|
26474
26527
|
- One-time migrations where data should not be duplicated
|
|
26475
26528
|
- Processing queues where records are marked as "processed"
|
|
26476
26529
|
- Compliance scenarios requiring audit trails of exported records
|
|
26477
|
-
- Implementing exactly-once delivery semantics
|
|
26478
26530
|
- |-
|
|
26479
26531
|
4. Error handling behavior:
|
|
26480
26532
|
- If the export fails, the boolean fields remain unchanged
|
|
@@ -36499,10 +36551,12 @@ components:
|
|
|
36499
36551
|
|
|
36500
36552
|
**Delta exports (type: "delta")**
|
|
36501
36553
|
For delta/incremental exports, do NOT populate a `delta` object inside `rdbms`.
|
|
36502
|
-
Instead, use `{{lastExportDateTime}}` or `{{currentExportDateTime}}` directly in the query
|
|
36554
|
+
Instead, use `{{lastExportDateTime}}` or `{{currentExportDateTime}}` directly in the query, and
|
|
36555
|
+
set the export's top-level `delta.startDate`: without it the first run's window is empty.
|
|
36503
36556
|
```json
|
|
36504
36557
|
{
|
|
36505
36558
|
"type": "delta",
|
|
36559
|
+
"delta": { "startDate": "2026-01-01T00:00:00.000Z" },
|
|
36506
36560
|
"rdbms": {
|
|
36507
36561
|
"query": "SELECT * FROM customers WHERE updatedAt > {{lastExportDateTime}}"
|
|
36508
36562
|
}
|
|
@@ -36575,6 +36629,24 @@ components:
|
|
|
36575
36629
|
only — real-time stream listeners (`type` is `stream`) have no SQL query. For delta exports,
|
|
36576
36630
|
reference {{lastExportDateTime}}/{{currentExportDateTime}} directly in the query rather
|
|
36577
36631
|
than configuring a separate delta object.
|
|
36632
|
+
|
|
36633
|
+
Double braces render a string as a quoted SQL literal with its apostrophes escaped, and
|
|
36634
|
+
triple braces insert a value raw. Observed in Snowflake queries:
|
|
36635
|
+
|
|
36636
|
+
- String helper output (`dateFormat`, `jsonSerialize`) and both delta variables are
|
|
36637
|
+
quoted the same way; a number or boolean renders bare, whether it is a JSON value or a
|
|
36638
|
+
numeric helper's result (`{{add 2 3}}` renders `5`).
|
|
36639
|
+
- In a run, {{lastExportDateTime}} and {{currentExportDateTime}} arrive as quoted ISO 8601
|
|
36640
|
+
UTC literals with milliseconds (`'2026-01-15T00:00:00.000Z'`), or in `delta.dateFormat`
|
|
36641
|
+
when it is set: add no quotes of your own, and don't parse them with a format mask
|
|
36642
|
+
written for another format.
|
|
36643
|
+
- A preview of an unsaved export document renders both as empty, unquoted text, so a
|
|
36644
|
+
delta query fails to compile there unless the document carries both in `postData`.
|
|
36645
|
+
- The quoting leaves backslashes, which Snowflake reads as escape sequences, so a
|
|
36646
|
+
double-brace value holding a backslash arrives changed. Pass such a value in a
|
|
36647
|
+
dollar-quoted constant with triple braces (`$${{{record.field}}}$$`), which Snowflake
|
|
36648
|
+
reads as is, but only when it can't contain `$$`: a `$$` ends the constant, and the rest
|
|
36649
|
+
is read as SQL.
|
|
36578
36650
|
x-celigo-ai-guidance:
|
|
36579
36651
|
- |-
|
|
36580
36652
|
This field contains the SQL SELECT statement that will be executed to fetch data
|
|
@@ -37708,6 +37780,8 @@ components:
|
|
|
37708
37780
|
description: |-
|
|
37709
37781
|
Custom JavaScript hooks that run at fixed points in the export lifecycle for
|
|
37710
37782
|
transformations, validation, and filtering beyond what configuration alone can express.
|
|
37783
|
+
A hook name not listed here (an import's `preMap`, for example) is dropped on save
|
|
37784
|
+
without an error, so read `hooks` back after saving.
|
|
37711
37785
|
properties:
|
|
37712
37786
|
preSavePage:
|
|
37713
37787
|
type: object
|
|
@@ -447,7 +447,9 @@ paths:
|
|
|
447
447
|
delete:
|
|
448
448
|
x-internal: false
|
|
449
449
|
summary: Delete a trading partner connector
|
|
450
|
-
description:
|
|
450
|
+
description: |-
|
|
451
|
+
Deletes a trading partner connector. The recycle bin doesn't take trading partner
|
|
452
|
+
connectors, so there is no route to restore a deleted one.
|
|
451
453
|
operationId: deleteTradingPartnerConnector
|
|
452
454
|
tags:
|
|
453
455
|
- Trading Partner Connectors
|