@celigo/api-specs 0.2.79 → 0.2.81
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/agent.yml +8 -0
- package/dist/ai-agent.yml +63 -20
- package/dist/api.yml +8 -0
- package/dist/asynchelper.yml +8 -0
- package/dist/connection.yml +8 -0
- package/dist/connector.yml +8 -0
- package/dist/ediprofile.yml +8 -0
- package/dist/enduser.yml +8 -0
- package/dist/environment.yml +8 -0
- package/dist/eventreport.yml +8 -0
- package/dist/export.yml +30 -3
- package/dist/filedefinition.yml +8 -0
- package/dist/flow.yml +63 -20
- package/dist/guardrail.yml +8 -0
- package/dist/httpconnector.yml +8 -0
- package/dist/httpconnectorendpoint.yml +8 -0
- package/dist/iclient.yml +8 -0
- package/dist/import.yml +8 -0
- package/dist/integration.yml +30 -3
- package/dist/job.yml +8 -0
- package/dist/lookupcache.yml +8 -0
- package/dist/mcp-oauth-provider.yml +8 -0
- package/dist/mcp-server.yml +8 -0
- package/dist/notification.yml +8 -0
- package/dist/tag.yml +8 -0
- package/dist/template.yml +8 -0
- package/dist/tool.yml +52 -10
- package/dist/tradingpartnerconnector.yml +8 -0
- package/dist/user.yml +8 -0
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/agent.yml
CHANGED
|
@@ -600,6 +600,14 @@ components:
|
|
|
600
600
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
601
601
|
x-celigo-ai-guidance:
|
|
602
602
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
603
|
+
- |-
|
|
604
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
605
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
606
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
607
|
+
`resourceType` enum lists, or the account-wide
|
|
608
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
609
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
610
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
603
611
|
examples:
|
|
604
612
|
- '2023-04-15T14:30:15Z'
|
|
605
613
|
deletedAt:
|
package/dist/ai-agent.yml
CHANGED
|
@@ -3869,20 +3869,48 @@ components:
|
|
|
3869
3869
|
extracts evaluate against that envelope:
|
|
3870
3870
|
|
|
3871
3871
|
- **Lookup steps**: `{"statusCode": 200, "data": [<result records>],
|
|
3872
|
-
"errors": []}` — `data` holds the records the lookup
|
|
3873
|
-
|
|
3874
|
-
|
|
3875
|
-
|
|
3876
|
-
|
|
3872
|
+
"errors": []}` — `data` holds the records the lookup step returns,
|
|
3873
|
+
AFTER the export's own `transform` and output `filter` have run, so
|
|
3874
|
+
extracts must start from it and name transformed fields by their
|
|
3875
|
+
transformed name: `data[0].name` copies a field of the first result,
|
|
3876
|
+
`data` copies the whole result array. A bare result-record field name
|
|
3877
|
+
(e.g. `name`) resolves to nothing and merges nothing, and so does the
|
|
3878
|
+
raw response path a transform consumed.
|
|
3877
3879
|
- **Import steps**: `{"id": "<destination record id>", "statusCode": 200,
|
|
3878
|
-
"ignored": false, "errors": [], "_json": <raw destination response
|
|
3879
|
-
|
|
3880
|
-
|
|
3881
|
-
|
|
3882
|
-
|
|
3883
|
-
|
|
3884
|
-
|
|
3880
|
+
"ignored": false, "errors": [], "_json": <raw destination response>,
|
|
3881
|
+
...<response body fields flattened at the root>}` — use `id` for the
|
|
3882
|
+
destination-assigned id and `_json.<path>` (or the flattened
|
|
3883
|
+
`<path>`) for fields inside the destination's response body. The full
|
|
3884
|
+
envelope (including `id`) is present on real runs and in flow-builder
|
|
3885
|
+
previews; flow TEST runs never execute imports, and their mock-built
|
|
3886
|
+
envelope carries no `id` — an `extract: "id"` merges nothing in a test
|
|
3887
|
+
run even though it works on real runs.
|
|
3888
|
+
|
|
3889
|
+
An `extract` may also be a Handlebars expression. It evaluates against
|
|
3890
|
+
the same envelope as a plain path, so every path inside `{{ }}` starts
|
|
3891
|
+
where the plain paths start — `{{data.0.name}}`,
|
|
3892
|
+
`{{#compare data.0.count "==" 1}}yes{{else}}no{{/compare}}`,
|
|
3893
|
+
`{{#if data.length}}found{{/if}}` on a lookup; `{{_json.order.id}}` or
|
|
3894
|
+
`{{id}}` on an import. Index arrays with dots inside Handlebars
|
|
3895
|
+
(`data.0.name` or `data.[0].name`; `data[0].name` renders nothing), and
|
|
3896
|
+
expect a string result (`"1"`, `"false"`). There is no `record` object in
|
|
3897
|
+
this context: `{{record.<anything>}}` renders nothing. Prefer a plain
|
|
3898
|
+
path when the value is simply copied.
|
|
3885
3899
|
x-celigo-ai-guidance:
|
|
3900
|
+
- |-
|
|
3901
|
+
Handlebars is allowed in `extract` but only rooted at the envelope —
|
|
3902
|
+
`{{data.0.x}}` on a lookup, `{{_json.x}}` / `{{id}}` on an import. The
|
|
3903
|
+
`record.` root belongs to import-mapping templates; here every
|
|
3904
|
+
`{{record.…}}` form renders nothing, silently, and `{{data[0].x}}`
|
|
3905
|
+
(bracket index inside Handlebars) renders nothing too. Use Handlebars
|
|
3906
|
+
only for a derived value (a flag, a concatenation); copy values with a
|
|
3907
|
+
plain path.
|
|
3908
|
+
- |-
|
|
3909
|
+
A lookup's `data[]` is the step's output after its `transform` and
|
|
3910
|
+
`filter`, so author extracts against the transformed records — never
|
|
3911
|
+
against the raw response the transform consumed, and never against a
|
|
3912
|
+
saved `mockOutput` as stored (it is the raw response; the transform
|
|
3913
|
+
runs on top of it in a test run).
|
|
3886
3914
|
- |-
|
|
3887
3915
|
Send `fields` and `lists` as bare arrays, exactly as GET returns them.
|
|
3888
3916
|
Never wrap either in an object (e.g. `"fields": {"type": [...]}`): the
|
|
@@ -3924,22 +3952,29 @@ components:
|
|
|
3924
3952
|
properties:
|
|
3925
3953
|
extract:
|
|
3926
3954
|
type: string
|
|
3955
|
+
x-celigo-agent:
|
|
3956
|
+
- handlebars
|
|
3927
3957
|
description: |
|
|
3928
3958
|
Path within the canonical response envelope to copy the value
|
|
3929
|
-
from
|
|
3930
|
-
|
|
3931
|
-
|
|
3932
|
-
|
|
3933
|
-
|
|
3934
|
-
|
|
3935
|
-
|
|
3936
|
-
`
|
|
3959
|
+
from, or a Handlebars expression over that same envelope. For
|
|
3960
|
+
lookup steps, paths start from the envelope's `data` array
|
|
3961
|
+
(`data[0].x` and `data.0.x` are equivalent; `data` alone
|
|
3962
|
+
copies every result) — a lookup result field written without
|
|
3963
|
+
the `data` prefix resolves to nothing. For import steps, use
|
|
3964
|
+
the envelope fields `id`, `statusCode`, `ignored`, `_json.<path>`
|
|
3965
|
+
for the raw response body, or the body field itself at the
|
|
3966
|
+
envelope root (`orderNumber` and `_json.orderNumber` read the
|
|
3967
|
+
same value). A `[*]` wildcard is not honored here — `data[*].x`
|
|
3968
|
+
merges nothing; iterate arrays with `lists` instead. Inside
|
|
3969
|
+
Handlebars, index with dots (`{{data.0.x}}`, never
|
|
3970
|
+
`{{data[0].x}}`) and never use a `record.` root.
|
|
3937
3971
|
examples:
|
|
3938
3972
|
- data[0].customer.name
|
|
3939
3973
|
- data.0.fields.Product Name
|
|
3940
3974
|
- data
|
|
3941
3975
|
- id
|
|
3942
3976
|
- _json.orderNumber
|
|
3977
|
+
- '{{#if data.length}}found{{else}}missing{{/if}}'
|
|
3943
3978
|
generate:
|
|
3944
3979
|
type: string
|
|
3945
3980
|
description: |
|
|
@@ -5425,6 +5460,14 @@ components:
|
|
|
5425
5460
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
5426
5461
|
x-celigo-ai-guidance:
|
|
5427
5462
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
5463
|
+
- |-
|
|
5464
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
5465
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
5466
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
5467
|
+
`resourceType` enum lists, or the account-wide
|
|
5468
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
5469
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
5470
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
5428
5471
|
examples:
|
|
5429
5472
|
- '2023-04-15T14:30:15Z'
|
|
5430
5473
|
deletedAt:
|
package/dist/api.yml
CHANGED
|
@@ -4637,6 +4637,14 @@ components:
|
|
|
4637
4637
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
4638
4638
|
x-celigo-ai-guidance:
|
|
4639
4639
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
4640
|
+
- |-
|
|
4641
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
4642
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
4643
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
4644
|
+
`resourceType` enum lists, or the account-wide
|
|
4645
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
4646
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
4647
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
4640
4648
|
examples:
|
|
4641
4649
|
- '2023-04-15T14:30:15Z'
|
|
4642
4650
|
deletedAt:
|
package/dist/asynchelper.yml
CHANGED
|
@@ -3154,6 +3154,14 @@ components:
|
|
|
3154
3154
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
3155
3155
|
x-celigo-ai-guidance:
|
|
3156
3156
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
3157
|
+
- |-
|
|
3158
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
3159
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
3160
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
3161
|
+
`resourceType` enum lists, or the account-wide
|
|
3162
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
3163
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
3164
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
3157
3165
|
examples:
|
|
3158
3166
|
- '2023-04-15T14:30:15Z'
|
|
3159
3167
|
deletedAt:
|
package/dist/connection.yml
CHANGED
|
@@ -3244,6 +3244,14 @@ components:
|
|
|
3244
3244
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
3245
3245
|
x-celigo-ai-guidance:
|
|
3246
3246
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
3247
|
+
- |-
|
|
3248
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
3249
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
3250
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
3251
|
+
`resourceType` enum lists, or the account-wide
|
|
3252
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
3253
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
3254
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
3247
3255
|
examples:
|
|
3248
3256
|
- '2023-04-15T14:30:15Z'
|
|
3249
3257
|
deletedAt:
|
package/dist/connector.yml
CHANGED
|
@@ -1103,6 +1103,14 @@ components:
|
|
|
1103
1103
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
1104
1104
|
x-celigo-ai-guidance:
|
|
1105
1105
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
1106
|
+
- |-
|
|
1107
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
1108
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
1109
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
1110
|
+
`resourceType` enum lists, or the account-wide
|
|
1111
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
1112
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
1113
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
1106
1114
|
examples:
|
|
1107
1115
|
- '2023-04-15T14:30:15Z'
|
|
1108
1116
|
deletedAt:
|
package/dist/ediprofile.yml
CHANGED
|
@@ -656,6 +656,14 @@ components:
|
|
|
656
656
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
657
657
|
x-celigo-ai-guidance:
|
|
658
658
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
659
|
+
- |-
|
|
660
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
661
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
662
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
663
|
+
`resourceType` enum lists, or the account-wide
|
|
664
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
665
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
666
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
659
667
|
examples:
|
|
660
668
|
- '2023-04-15T14:30:15Z'
|
|
661
669
|
deletedAt:
|
package/dist/enduser.yml
CHANGED
|
@@ -1883,6 +1883,14 @@ components:
|
|
|
1883
1883
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
1884
1884
|
x-celigo-ai-guidance:
|
|
1885
1885
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
1886
|
+
- |-
|
|
1887
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
1888
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
1889
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
1890
|
+
`resourceType` enum lists, or the account-wide
|
|
1891
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
1892
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
1893
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
1886
1894
|
examples:
|
|
1887
1895
|
- '2023-04-15T14:30:15Z'
|
|
1888
1896
|
deletedAt:
|
package/dist/environment.yml
CHANGED
|
@@ -393,6 +393,14 @@ components:
|
|
|
393
393
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
394
394
|
x-celigo-ai-guidance:
|
|
395
395
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
396
|
+
- |-
|
|
397
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
398
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
399
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
400
|
+
`resourceType` enum lists, or the account-wide
|
|
401
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
402
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
403
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
396
404
|
examples:
|
|
397
405
|
- '2023-04-15T14:30:15Z'
|
|
398
406
|
deletedAt:
|
package/dist/eventreport.yml
CHANGED
|
@@ -351,6 +351,14 @@ components:
|
|
|
351
351
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
352
352
|
x-celigo-ai-guidance:
|
|
353
353
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
354
|
+
- |-
|
|
355
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
356
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
357
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
358
|
+
`resourceType` enum lists, or the account-wide
|
|
359
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
360
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
361
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
354
362
|
examples:
|
|
355
363
|
- '2023-04-15T14:30:15Z'
|
|
356
364
|
deletedAt:
|
package/dist/export.yml
CHANGED
|
@@ -15929,19 +15929,38 @@ components:
|
|
|
15929
15929
|
|
|
15930
15930
|
**Usage**
|
|
15931
15931
|
|
|
15932
|
-
|
|
15933
|
-
|
|
15932
|
+
In a flow test run, and for an upstream lookup during a page-processor preview
|
|
15933
|
+
(`previewPageProcessor`), integrator.io substitutes this mock output for the export's live
|
|
15934
|
+
response instead of calling the source. It is not substituted anywhere else: a target lookup
|
|
15935
|
+
in that preview runs its live query, `POST /v1/exports/preview` calls the source, and real
|
|
15936
|
+
runs ignore it. This allows you to:
|
|
15934
15937
|
- Test mappings with representative data
|
|
15935
15938
|
- Configure downstream flow steps without waiting for real data
|
|
15936
15939
|
- Simulate various data scenarios
|
|
15937
15940
|
|
|
15941
|
+
Where it is substituted, the records stand in for the RAW parsed response: the export's own
|
|
15942
|
+
`transform` and output `filter` still run on top of them, so downstream steps — and a
|
|
15943
|
+
lookup's results mapping — see the transformed, filtered records, not the shape stored here.
|
|
15944
|
+
|
|
15938
15945
|
**Limitations**
|
|
15939
15946
|
|
|
15940
15947
|
- Maximum of 10 records
|
|
15941
15948
|
- Maximum size of 1 MB
|
|
15942
15949
|
- Must follow the canonical format shown above
|
|
15943
15950
|
|
|
15944
|
-
Mock output can be populated automatically from preview data
|
|
15951
|
+
Mock output can be populated automatically from preview data (which is the parsed response,
|
|
15952
|
+
before `transform` / `filter`) or entered manually.
|
|
15953
|
+
x-celigo-ai-guidance:
|
|
15954
|
+
- |-
|
|
15955
|
+
Store the RAW parsed response records here, never transformed ones — the platform runs
|
|
15956
|
+
the export's `transform` and `filter` on the mock exactly as on live data, and a
|
|
15957
|
+
pre-transformed mock would be transformed twice. When you read `mockOutput` to learn
|
|
15958
|
+
what a lookup returns, apply the transform first; a results mapping authored against
|
|
15959
|
+
the stored shape walks paths that do not exist at runtime.
|
|
15960
|
+
- |-
|
|
15961
|
+
A saved mockOutput is read in exactly two places — a flow test run, and an upstream lookup
|
|
15962
|
+
during a page-processor preview. A target lookup's preview, `POST /v1/exports/preview` and
|
|
15963
|
+
every real run call the source and never read it.
|
|
15945
15964
|
properties:
|
|
15946
15965
|
page_of_records:
|
|
15947
15966
|
type: array
|
|
@@ -16787,6 +16806,14 @@ components:
|
|
|
16787
16806
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
16788
16807
|
x-celigo-ai-guidance:
|
|
16789
16808
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
16809
|
+
- |-
|
|
16810
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
16811
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
16812
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
16813
|
+
`resourceType` enum lists, or the account-wide
|
|
16814
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
16815
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
16816
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
16790
16817
|
examples:
|
|
16791
16818
|
- '2023-04-15T14:30:15Z'
|
|
16792
16819
|
deletedAt:
|
package/dist/filedefinition.yml
CHANGED
|
@@ -1173,6 +1173,14 @@ components:
|
|
|
1173
1173
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
1174
1174
|
x-celigo-ai-guidance:
|
|
1175
1175
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
1176
|
+
- |-
|
|
1177
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
1178
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
1179
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
1180
|
+
`resourceType` enum lists, or the account-wide
|
|
1181
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
1182
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
1183
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
1176
1184
|
examples:
|
|
1177
1185
|
- '2023-04-15T14:30:15Z'
|
|
1178
1186
|
deletedAt:
|
package/dist/flow.yml
CHANGED
|
@@ -4135,20 +4135,48 @@ components:
|
|
|
4135
4135
|
extracts evaluate against that envelope:
|
|
4136
4136
|
|
|
4137
4137
|
- **Lookup steps**: `{"statusCode": 200, "data": [<result records>],
|
|
4138
|
-
"errors": []}` — `data` holds the records the lookup
|
|
4139
|
-
|
|
4140
|
-
|
|
4141
|
-
|
|
4142
|
-
|
|
4138
|
+
"errors": []}` — `data` holds the records the lookup step returns,
|
|
4139
|
+
AFTER the export's own `transform` and output `filter` have run, so
|
|
4140
|
+
extracts must start from it and name transformed fields by their
|
|
4141
|
+
transformed name: `data[0].name` copies a field of the first result,
|
|
4142
|
+
`data` copies the whole result array. A bare result-record field name
|
|
4143
|
+
(e.g. `name`) resolves to nothing and merges nothing, and so does the
|
|
4144
|
+
raw response path a transform consumed.
|
|
4143
4145
|
- **Import steps**: `{"id": "<destination record id>", "statusCode": 200,
|
|
4144
|
-
"ignored": false, "errors": [], "_json": <raw destination response
|
|
4145
|
-
|
|
4146
|
-
|
|
4147
|
-
|
|
4148
|
-
|
|
4149
|
-
|
|
4150
|
-
|
|
4146
|
+
"ignored": false, "errors": [], "_json": <raw destination response>,
|
|
4147
|
+
...<response body fields flattened at the root>}` — use `id` for the
|
|
4148
|
+
destination-assigned id and `_json.<path>` (or the flattened
|
|
4149
|
+
`<path>`) for fields inside the destination's response body. The full
|
|
4150
|
+
envelope (including `id`) is present on real runs and in flow-builder
|
|
4151
|
+
previews; flow TEST runs never execute imports, and their mock-built
|
|
4152
|
+
envelope carries no `id` — an `extract: "id"` merges nothing in a test
|
|
4153
|
+
run even though it works on real runs.
|
|
4154
|
+
|
|
4155
|
+
An `extract` may also be a Handlebars expression. It evaluates against
|
|
4156
|
+
the same envelope as a plain path, so every path inside `{{ }}` starts
|
|
4157
|
+
where the plain paths start — `{{data.0.name}}`,
|
|
4158
|
+
`{{#compare data.0.count "==" 1}}yes{{else}}no{{/compare}}`,
|
|
4159
|
+
`{{#if data.length}}found{{/if}}` on a lookup; `{{_json.order.id}}` or
|
|
4160
|
+
`{{id}}` on an import. Index arrays with dots inside Handlebars
|
|
4161
|
+
(`data.0.name` or `data.[0].name`; `data[0].name` renders nothing), and
|
|
4162
|
+
expect a string result (`"1"`, `"false"`). There is no `record` object in
|
|
4163
|
+
this context: `{{record.<anything>}}` renders nothing. Prefer a plain
|
|
4164
|
+
path when the value is simply copied.
|
|
4151
4165
|
x-celigo-ai-guidance:
|
|
4166
|
+
- |-
|
|
4167
|
+
Handlebars is allowed in `extract` but only rooted at the envelope —
|
|
4168
|
+
`{{data.0.x}}` on a lookup, `{{_json.x}}` / `{{id}}` on an import. The
|
|
4169
|
+
`record.` root belongs to import-mapping templates; here every
|
|
4170
|
+
`{{record.…}}` form renders nothing, silently, and `{{data[0].x}}`
|
|
4171
|
+
(bracket index inside Handlebars) renders nothing too. Use Handlebars
|
|
4172
|
+
only for a derived value (a flag, a concatenation); copy values with a
|
|
4173
|
+
plain path.
|
|
4174
|
+
- |-
|
|
4175
|
+
A lookup's `data[]` is the step's output after its `transform` and
|
|
4176
|
+
`filter`, so author extracts against the transformed records — never
|
|
4177
|
+
against the raw response the transform consumed, and never against a
|
|
4178
|
+
saved `mockOutput` as stored (it is the raw response; the transform
|
|
4179
|
+
runs on top of it in a test run).
|
|
4152
4180
|
- |-
|
|
4153
4181
|
Send `fields` and `lists` as bare arrays, exactly as GET returns them.
|
|
4154
4182
|
Never wrap either in an object (e.g. `"fields": {"type": [...]}`): the
|
|
@@ -4190,22 +4218,29 @@ components:
|
|
|
4190
4218
|
properties:
|
|
4191
4219
|
extract:
|
|
4192
4220
|
type: string
|
|
4221
|
+
x-celigo-agent:
|
|
4222
|
+
- handlebars
|
|
4193
4223
|
description: |
|
|
4194
4224
|
Path within the canonical response envelope to copy the value
|
|
4195
|
-
from
|
|
4196
|
-
|
|
4197
|
-
|
|
4198
|
-
|
|
4199
|
-
|
|
4200
|
-
|
|
4201
|
-
|
|
4202
|
-
`
|
|
4225
|
+
from, or a Handlebars expression over that same envelope. For
|
|
4226
|
+
lookup steps, paths start from the envelope's `data` array
|
|
4227
|
+
(`data[0].x` and `data.0.x` are equivalent; `data` alone
|
|
4228
|
+
copies every result) — a lookup result field written without
|
|
4229
|
+
the `data` prefix resolves to nothing. For import steps, use
|
|
4230
|
+
the envelope fields `id`, `statusCode`, `ignored`, `_json.<path>`
|
|
4231
|
+
for the raw response body, or the body field itself at the
|
|
4232
|
+
envelope root (`orderNumber` and `_json.orderNumber` read the
|
|
4233
|
+
same value). A `[*]` wildcard is not honored here — `data[*].x`
|
|
4234
|
+
merges nothing; iterate arrays with `lists` instead. Inside
|
|
4235
|
+
Handlebars, index with dots (`{{data.0.x}}`, never
|
|
4236
|
+
`{{data[0].x}}`) and never use a `record.` root.
|
|
4203
4237
|
examples:
|
|
4204
4238
|
- data[0].customer.name
|
|
4205
4239
|
- data.0.fields.Product Name
|
|
4206
4240
|
- data
|
|
4207
4241
|
- id
|
|
4208
4242
|
- _json.orderNumber
|
|
4243
|
+
- '{{#if data.length}}found{{else}}missing{{/if}}'
|
|
4209
4244
|
generate:
|
|
4210
4245
|
type: string
|
|
4211
4246
|
description: |
|
|
@@ -5609,6 +5644,14 @@ components:
|
|
|
5609
5644
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
5610
5645
|
x-celigo-ai-guidance:
|
|
5611
5646
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
5647
|
+
- |-
|
|
5648
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
5649
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
5650
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
5651
|
+
`resourceType` enum lists, or the account-wide
|
|
5652
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
5653
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
5654
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
5612
5655
|
examples:
|
|
5613
5656
|
- '2023-04-15T14:30:15Z'
|
|
5614
5657
|
deletedAt:
|
package/dist/guardrail.yml
CHANGED
|
@@ -463,6 +463,14 @@ components:
|
|
|
463
463
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
464
464
|
x-celigo-ai-guidance:
|
|
465
465
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
466
|
+
- |-
|
|
467
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
468
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
469
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
470
|
+
`resourceType` enum lists, or the account-wide
|
|
471
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
472
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
473
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
466
474
|
examples:
|
|
467
475
|
- '2023-04-15T14:30:15Z'
|
|
468
476
|
deletedAt:
|
package/dist/httpconnector.yml
CHANGED
|
@@ -1850,6 +1850,14 @@ components:
|
|
|
1850
1850
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
1851
1851
|
x-celigo-ai-guidance:
|
|
1852
1852
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
1853
|
+
- |-
|
|
1854
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
1855
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
1856
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
1857
|
+
`resourceType` enum lists, or the account-wide
|
|
1858
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
1859
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
1860
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
1853
1861
|
examples:
|
|
1854
1862
|
- '2023-04-15T14:30:15Z'
|
|
1855
1863
|
deletedAt:
|
|
@@ -932,6 +932,14 @@ components:
|
|
|
932
932
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
933
933
|
x-celigo-ai-guidance:
|
|
934
934
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
935
|
+
- |-
|
|
936
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
937
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
938
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
939
|
+
`resourceType` enum lists, or the account-wide
|
|
940
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
941
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
942
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
935
943
|
examples:
|
|
936
944
|
- '2023-04-15T14:30:15Z'
|
|
937
945
|
deletedAt:
|
package/dist/iclient.yml
CHANGED
|
@@ -4244,6 +4244,14 @@ components:
|
|
|
4244
4244
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
4245
4245
|
x-celigo-ai-guidance:
|
|
4246
4246
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
4247
|
+
- |-
|
|
4248
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
4249
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
4250
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
4251
|
+
`resourceType` enum lists, or the account-wide
|
|
4252
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
4253
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
4254
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
4247
4255
|
examples:
|
|
4248
4256
|
- '2023-04-15T14:30:15Z'
|
|
4249
4257
|
deletedAt:
|
package/dist/import.yml
CHANGED
|
@@ -16261,6 +16261,14 @@ components:
|
|
|
16261
16261
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
16262
16262
|
x-celigo-ai-guidance:
|
|
16263
16263
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
16264
|
+
- |-
|
|
16265
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
16266
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
16267
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
16268
|
+
`resourceType` enum lists, or the account-wide
|
|
16269
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
16270
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
16271
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
16264
16272
|
examples:
|
|
16265
16273
|
- '2023-04-15T14:30:15Z'
|
|
16266
16274
|
deletedAt:
|
package/dist/integration.yml
CHANGED
|
@@ -3531,9 +3531,21 @@ components:
|
|
|
3531
3531
|
examples:
|
|
3532
3532
|
- 1.2.0
|
|
3533
3533
|
description: |-
|
|
3534
|
-
Integration App
|
|
3535
|
-
|
|
3536
|
-
|
|
3534
|
+
Version of the Integration App (or template) currently installed in this integration.
|
|
3535
|
+
For Integration Apps the connector's update workflow sets it; omit unless you are
|
|
3536
|
+
explicitly controlling versions.
|
|
3537
|
+
x-celigo-ai-guidance:
|
|
3538
|
+
- |-
|
|
3539
|
+
This is the installed version only. No API field carries an Integration App's newest
|
|
3540
|
+
available version (the connector record has none), so whether a newer release exists
|
|
3541
|
+
cannot be read from the platform — say so rather than inferring it from release notes,
|
|
3542
|
+
which are labeled by their own scheme, not by this value.
|
|
3543
|
+
- |-
|
|
3544
|
+
To date an Integration App update, read the integration's audit log
|
|
3545
|
+
(`GET /v1/integrations/{_id}/audit?source=connector`) for `version` field changes —
|
|
3546
|
+
one entry per version step, and an update run usually writes several in a row.
|
|
3547
|
+
`lastModified` moves on any write and `updateInProgress` can flip without a version
|
|
3548
|
+
change, so neither dates an update.
|
|
3537
3549
|
tag:
|
|
3538
3550
|
type:
|
|
3539
3551
|
- string
|
|
@@ -3551,6 +3563,9 @@ components:
|
|
|
3551
3563
|
API, but normally managed by the platform's update workflow.
|
|
3552
3564
|
x-celigo-ai-guidance:
|
|
3553
3565
|
- Typically system-managed; omit unless a workflow explicitly requires setting it.
|
|
3566
|
+
- |-
|
|
3567
|
+
An update run can set and clear it without changing `version`; its audit entries alone
|
|
3568
|
+
do not mean a new release was installed — the `version` changes do.
|
|
3554
3569
|
celigoAgentAutoRunMode:
|
|
3555
3570
|
type: boolean
|
|
3556
3571
|
examples:
|
|
@@ -3569,6 +3584,10 @@ components:
|
|
|
3569
3584
|
Timestamp indicating when the most recent install/update workflow was resolved/completed.
|
|
3570
3585
|
|
|
3571
3586
|
Typically system-managed; omit in normal create/update payloads.
|
|
3587
|
+
x-celigo-ai-guidance:
|
|
3588
|
+
- |-
|
|
3589
|
+
May be absent on an installed Integration App even after its update workflow has run —
|
|
3590
|
+
date an update from the audit log's `version` changes, not from this field.
|
|
3572
3591
|
settingsForm:
|
|
3573
3592
|
description: Settings form definition for the integration.
|
|
3574
3593
|
allOf:
|
|
@@ -4279,6 +4298,14 @@ components:
|
|
|
4279
4298
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
4280
4299
|
x-celigo-ai-guidance:
|
|
4281
4300
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
4301
|
+
- |-
|
|
4302
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
4303
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
4304
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
4305
|
+
`resourceType` enum lists, or the account-wide
|
|
4306
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
4307
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
4308
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
4282
4309
|
examples:
|
|
4283
4310
|
- '2023-04-15T14:30:15Z'
|
|
4284
4311
|
deletedAt:
|
package/dist/job.yml
CHANGED
|
@@ -1189,6 +1189,14 @@ components:
|
|
|
1189
1189
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
1190
1190
|
x-celigo-ai-guidance:
|
|
1191
1191
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
1192
|
+
- |-
|
|
1193
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
1194
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
1195
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
1196
|
+
`resourceType` enum lists, or the account-wide
|
|
1197
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
1198
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
1199
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
1192
1200
|
examples:
|
|
1193
1201
|
- '2023-04-15T14:30:15Z'
|
|
1194
1202
|
deletedAt:
|
package/dist/lookupcache.yml
CHANGED
|
@@ -758,6 +758,14 @@ components:
|
|
|
758
758
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
759
759
|
x-celigo-ai-guidance:
|
|
760
760
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
761
|
+
- |-
|
|
762
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
763
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
764
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
765
|
+
`resourceType` enum lists, or the account-wide
|
|
766
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
767
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
768
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
761
769
|
examples:
|
|
762
770
|
- '2023-04-15T14:30:15Z'
|
|
763
771
|
deletedAt:
|
|
@@ -422,6 +422,14 @@ components:
|
|
|
422
422
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
423
423
|
x-celigo-ai-guidance:
|
|
424
424
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
425
|
+
- |-
|
|
426
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
427
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
428
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
429
|
+
`resourceType` enum lists, or the account-wide
|
|
430
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
431
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
432
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
425
433
|
examples:
|
|
426
434
|
- '2023-04-15T14:30:15Z'
|
|
427
435
|
deletedAt:
|
package/dist/mcp-server.yml
CHANGED
|
@@ -3315,6 +3315,14 @@ components:
|
|
|
3315
3315
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
3316
3316
|
x-celigo-ai-guidance:
|
|
3317
3317
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
3318
|
+
- |-
|
|
3319
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
3320
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
3321
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
3322
|
+
`resourceType` enum lists, or the account-wide
|
|
3323
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
3324
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
3325
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
3318
3326
|
examples:
|
|
3319
3327
|
- '2023-04-15T14:30:15Z'
|
|
3320
3328
|
deletedAt:
|
package/dist/notification.yml
CHANGED
|
@@ -244,6 +244,14 @@ components:
|
|
|
244
244
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
245
245
|
x-celigo-ai-guidance:
|
|
246
246
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
247
|
+
- |-
|
|
248
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
249
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
250
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
251
|
+
`resourceType` enum lists, or the account-wide
|
|
252
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
253
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
254
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
247
255
|
examples:
|
|
248
256
|
- '2023-04-15T14:30:15Z'
|
|
249
257
|
deletedAt:
|
package/dist/tag.yml
CHANGED
|
@@ -336,6 +336,14 @@ components:
|
|
|
336
336
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
337
337
|
x-celigo-ai-guidance:
|
|
338
338
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
339
|
+
- |-
|
|
340
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
341
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
342
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
343
|
+
`resourceType` enum lists, or the account-wide
|
|
344
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
345
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
346
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
339
347
|
examples:
|
|
340
348
|
- '2023-04-15T14:30:15Z'
|
|
341
349
|
deletedAt:
|
package/dist/template.yml
CHANGED
|
@@ -643,6 +643,14 @@ components:
|
|
|
643
643
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
644
644
|
x-celigo-ai-guidance:
|
|
645
645
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
646
|
+
- |-
|
|
647
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
648
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
649
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
650
|
+
`resourceType` enum lists, or the account-wide
|
|
651
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
652
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
653
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
646
654
|
examples:
|
|
647
655
|
- '2023-04-15T14:30:15Z'
|
|
648
656
|
deletedAt:
|
package/dist/tool.yml
CHANGED
|
@@ -6033,11 +6033,21 @@ components:
|
|
|
6033
6033
|
can read them. Extracts do NOT read the raw application
|
|
6034
6034
|
response — they evaluate against the platform's canonical
|
|
6035
6035
|
per-record envelope: for lookups (`type: "export"`) that is
|
|
6036
|
-
`{"statusCode", "data": [<result records>], "errors"}
|
|
6037
|
-
|
|
6038
|
-
|
|
6039
|
-
|
|
6040
|
-
|
|
6036
|
+
`{"statusCode", "data": [<result records>], "errors"}`
|
|
6037
|
+
where `data` holds the records AFTER the export's own
|
|
6038
|
+
`transform` and output `filter`, so paths must start from
|
|
6039
|
+
`data` and name transformed fields by their transformed
|
|
6040
|
+
name (e.g. `data[0].name`) — a lookup result field
|
|
6041
|
+
written without the `data` prefix resolves to nothing;
|
|
6042
|
+
for imports it is `{"id", "statusCode", "ignored",
|
|
6043
|
+
"_json", ...<body fields flattened>}`, so use `id`,
|
|
6044
|
+
`_json.<path>`, or the body field itself at the root
|
|
6045
|
+
(`orderNumber` and `_json.orderNumber` read the same
|
|
6046
|
+
value). An extract may be a Handlebars expression over
|
|
6047
|
+
the same envelope (`{{data.0.name}}`,
|
|
6048
|
+
`{{#if data.length}}found{{/if}}`; dot indexes only; a
|
|
6049
|
+
string result); there is no `record` object in this
|
|
6050
|
+
context, so `{{record.…}}` renders nothing.
|
|
6041
6051
|
properties:
|
|
6042
6052
|
fields:
|
|
6043
6053
|
type: array
|
|
@@ -6047,15 +6057,20 @@ components:
|
|
|
6047
6057
|
properties:
|
|
6048
6058
|
extract:
|
|
6049
6059
|
type: string
|
|
6060
|
+
x-celigo-agent:
|
|
6061
|
+
- handlebars
|
|
6050
6062
|
description: |
|
|
6051
6063
|
Path within the canonical response envelope to
|
|
6052
6064
|
copy the value from (`data[0].x` / `data.0.x`
|
|
6053
|
-
for lookups; `id
|
|
6054
|
-
imports)
|
|
6065
|
+
for lookups; `id`, `_json.<path>` or the
|
|
6066
|
+
flattened body field `<path>` for imports), or
|
|
6067
|
+
a Handlebars expression over that envelope (dot
|
|
6068
|
+
indexes inside `{{ }}`, never a `record.` root).
|
|
6055
6069
|
examples:
|
|
6056
6070
|
- data[0].customer.name
|
|
6057
6071
|
- data.0.fields.Product Name
|
|
6058
6072
|
- id
|
|
6073
|
+
- '{{#if data.length}}found{{else}}missing{{/if}}'
|
|
6059
6074
|
generate:
|
|
6060
6075
|
type: string
|
|
6061
6076
|
description: |
|
|
@@ -6273,6 +6288,14 @@ components:
|
|
|
6273
6288
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
6274
6289
|
x-celigo-ai-guidance:
|
|
6275
6290
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
6291
|
+
- |-
|
|
6292
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
6293
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
6294
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
6295
|
+
`resourceType` enum lists, or the account-wide
|
|
6296
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
6297
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
6298
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
6276
6299
|
examples:
|
|
6277
6300
|
- '2023-04-15T14:30:15Z'
|
|
6278
6301
|
deletedAt:
|
|
@@ -36169,19 +36192,38 @@ components:
|
|
|
36169
36192
|
|
|
36170
36193
|
**Usage**
|
|
36171
36194
|
|
|
36172
|
-
|
|
36173
|
-
|
|
36195
|
+
In a flow test run, and for an upstream lookup during a page-processor preview
|
|
36196
|
+
(`previewPageProcessor`), integrator.io substitutes this mock output for the export's live
|
|
36197
|
+
response instead of calling the source. It is not substituted anywhere else: a target lookup
|
|
36198
|
+
in that preview runs its live query, `POST /v1/exports/preview` calls the source, and real
|
|
36199
|
+
runs ignore it. This allows you to:
|
|
36174
36200
|
- Test mappings with representative data
|
|
36175
36201
|
- Configure downstream flow steps without waiting for real data
|
|
36176
36202
|
- Simulate various data scenarios
|
|
36177
36203
|
|
|
36204
|
+
Where it is substituted, the records stand in for the RAW parsed response: the export's own
|
|
36205
|
+
`transform` and output `filter` still run on top of them, so downstream steps — and a
|
|
36206
|
+
lookup's results mapping — see the transformed, filtered records, not the shape stored here.
|
|
36207
|
+
|
|
36178
36208
|
**Limitations**
|
|
36179
36209
|
|
|
36180
36210
|
- Maximum of 10 records
|
|
36181
36211
|
- Maximum size of 1 MB
|
|
36182
36212
|
- Must follow the canonical format shown above
|
|
36183
36213
|
|
|
36184
|
-
Mock output can be populated automatically from preview data
|
|
36214
|
+
Mock output can be populated automatically from preview data (which is the parsed response,
|
|
36215
|
+
before `transform` / `filter`) or entered manually.
|
|
36216
|
+
x-celigo-ai-guidance:
|
|
36217
|
+
- |-
|
|
36218
|
+
Store the RAW parsed response records here, never transformed ones — the platform runs
|
|
36219
|
+
the export's `transform` and `filter` on the mock exactly as on live data, and a
|
|
36220
|
+
pre-transformed mock would be transformed twice. When you read `mockOutput` to learn
|
|
36221
|
+
what a lookup returns, apply the transform first; a results mapping authored against
|
|
36222
|
+
the stored shape walks paths that do not exist at runtime.
|
|
36223
|
+
- |-
|
|
36224
|
+
A saved mockOutput is read in exactly two places — a flow test run, and an upstream lookup
|
|
36225
|
+
during a page-processor preview. A target lookup's preview, `POST /v1/exports/preview` and
|
|
36226
|
+
every real run call the source and never read it.
|
|
36185
36227
|
properties:
|
|
36186
36228
|
page_of_records:
|
|
36187
36229
|
type: array
|
|
@@ -1307,6 +1307,14 @@ components:
|
|
|
1307
1307
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
1308
1308
|
x-celigo-ai-guidance:
|
|
1309
1309
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
1310
|
+
- |-
|
|
1311
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
1312
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
1313
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
1314
|
+
`resourceType` enum lists, or the account-wide
|
|
1315
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
1316
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
1317
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
1310
1318
|
examples:
|
|
1311
1319
|
- '2023-04-15T14:30:15Z'
|
|
1312
1320
|
deletedAt:
|
package/dist/user.yml
CHANGED
|
@@ -737,6 +737,14 @@ components:
|
|
|
737
737
|
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
738
738
|
x-celigo-ai-guidance:
|
|
739
739
|
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
740
|
+
- |-
|
|
741
|
+
Records that something was written, not what — a settings edit, a flag flip, or a
|
|
742
|
+
platform workflow all move it. What changed and when is in the audit log: the
|
|
743
|
+
per-resource route `GET /v1/{resourceType}/{_id}/audit` for the types its
|
|
744
|
+
`resourceType` enum lists, or the account-wide
|
|
745
|
+
`GET /v1/audit?resourceType=<singular>&_resourceId={_id}` for the further types that
|
|
746
|
+
endpoint's enum accepts (users, environments, notifications among them). A type absent
|
|
747
|
+
from both enums — jobs, connectors, templates — has only this timestamp.
|
|
740
748
|
examples:
|
|
741
749
|
- '2023-04-15T14:30:15Z'
|
|
742
750
|
deletedAt:
|
package/package.json
CHANGED