@celigo/api-specs 0.2.1
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/LICENSE +21 -0
- package/README.md +119 -0
- package/dist/account.yml +592 -0
- package/dist/agent.yml +908 -0
- package/dist/ai-agent.yml +5471 -0
- package/dist/api.yml +4140 -0
- package/dist/apim.yml +1286 -0
- package/dist/asynchelper.yml +3391 -0
- package/dist/audit.yml +2006 -0
- package/dist/connection.yml +8665 -0
- package/dist/connector.yml +1406 -0
- package/dist/ediprofile.yml +911 -0
- package/dist/editransaction.yml +1210 -0
- package/dist/enduser.yml +1724 -0
- package/dist/environment.yml +568 -0
- package/dist/eventreport.yml +692 -0
- package/dist/export.yml +17610 -0
- package/dist/filedefinition.yml +1396 -0
- package/dist/filestorage.yml +3102 -0
- package/dist/flow.yml +7928 -0
- package/dist/guardrail.yml +2763 -0
- package/dist/httpconnector.yml +2277 -0
- package/dist/httpconnectorendpoint.yml +722 -0
- package/dist/httpconnectorresource.yml +396 -0
- package/dist/iclient.yml +4452 -0
- package/dist/import.yml +15381 -0
- package/dist/integration.yml +4406 -0
- package/dist/job.yml +2014 -0
- package/dist/lookupcache.yml +1325 -0
- package/dist/marketplace.yml +685 -0
- package/dist/mcp-oauth-provider.yml +590 -0
- package/dist/mcp-server.yml +2656 -0
- package/dist/notification.yml +488 -0
- package/dist/processor.yml +1253 -0
- package/dist/profile.yml +455 -0
- package/dist/recyclebin.yml +768 -0
- package/dist/script.yml +1128 -0
- package/dist/stack.yml +1291 -0
- package/dist/state.yml +894 -0
- package/dist/subscription.yml +1405 -0
- package/dist/sync.yml +4857 -0
- package/dist/tag.yml +553 -0
- package/dist/template.yml +897 -0
- package/dist/tool.yml +33656 -0
- package/dist/tradingpartnerconnector.yml +1490 -0
- package/dist/user.yml +831 -0
- package/package.json +41 -0
- package/schemas.json +8420 -0
|
@@ -0,0 +1,911 @@
|
|
|
1
|
+
openapi: 3.2.0
|
|
2
|
+
info:
|
|
3
|
+
version: 1.0.0
|
|
4
|
+
title: EDI Profiles
|
|
5
|
+
description: API for managing Celigo EDI profiles — interchange envelope configurations for X12 and EDIFACT document exchange.
|
|
6
|
+
x-celigo-ai-guidance:
|
|
7
|
+
- |-
|
|
8
|
+
EDI profiles define the interchange envelope configuration for EDI X12 and
|
|
9
|
+
EDIFACT document exchange between trading partners.
|
|
10
|
+
They contain the control fields (ISA/GS for X12,
|
|
11
|
+
UNB for EDIFACT) that identify sender/receiver, standards versions,
|
|
12
|
+
and interchange control settings.
|
|
13
|
+
servers:
|
|
14
|
+
- url: https://api.integrator.io
|
|
15
|
+
description: Production (US / default region)
|
|
16
|
+
- url: https://api.eu.integrator.io
|
|
17
|
+
description: Production (EU region)
|
|
18
|
+
- url: https://api.au.integrator.io
|
|
19
|
+
description: Production (AU region)
|
|
20
|
+
- url: https://api.ca.integrator.io
|
|
21
|
+
description: Production (CA region)
|
|
22
|
+
security:
|
|
23
|
+
- bearerAuth: []
|
|
24
|
+
tags:
|
|
25
|
+
- name: EDI Profiles
|
|
26
|
+
description: |-
|
|
27
|
+
API for managing EDI profiles in Celigo.
|
|
28
|
+
|
|
29
|
+
EDI profiles define the interchange envelope configuration for EDI X12 and
|
|
30
|
+
EDIFACT document exchange between trading partners. They contain the control
|
|
31
|
+
fields (ISA/GS for X12, UNB for EDIFACT) that identify sender/receiver,
|
|
32
|
+
standards versions, and interchange control settings.
|
|
33
|
+
|
|
34
|
+
## EDI profile schema
|
|
35
|
+
|
|
36
|
+
{% openapi-schemas spec="ediprofile" schemas="EDIProfile" grouped="true" %}
|
|
37
|
+
paths:
|
|
38
|
+
/v1/ediprofiles:
|
|
39
|
+
get:
|
|
40
|
+
x-internal: false
|
|
41
|
+
summary: List EDI profiles
|
|
42
|
+
description: Returns all EDI profiles configured in the account.
|
|
43
|
+
x-celigo-ai-guidance:
|
|
44
|
+
- |-
|
|
45
|
+
Returns a list of all EDI profiles configured in the account.
|
|
46
|
+
If no EDI profiles exist, a 204 response with no body will be returned.
|
|
47
|
+
operationId: listEDIProfiles
|
|
48
|
+
tags:
|
|
49
|
+
- EDI Profiles
|
|
50
|
+
responses:
|
|
51
|
+
'200':
|
|
52
|
+
description: Successfully retrieved list of EDI profiles
|
|
53
|
+
headers:
|
|
54
|
+
Link:
|
|
55
|
+
description: |
|
|
56
|
+
RFC-5988 pagination links. When more pages remain, includes a `<...>; rel="next"` entry;
|
|
57
|
+
absent on the final page.
|
|
58
|
+
schema:
|
|
59
|
+
type: string
|
|
60
|
+
content:
|
|
61
|
+
application/json:
|
|
62
|
+
schema:
|
|
63
|
+
type: array
|
|
64
|
+
items:
|
|
65
|
+
$ref: '#/components/schemas/EDIProfile'
|
|
66
|
+
examples:
|
|
67
|
+
default:
|
|
68
|
+
value:
|
|
69
|
+
- _id: 690146d901d66a7545038179
|
|
70
|
+
lastModified: '2026-05-02T18:10:01.832Z'
|
|
71
|
+
name: Dyno
|
|
72
|
+
fileType: edix12
|
|
73
|
+
tpInterchangeId: '9253390501'
|
|
74
|
+
myInterchangeId: KOMAR3PL
|
|
75
|
+
controlNumber: 1
|
|
76
|
+
isa01: '00'
|
|
77
|
+
isa03: '00'
|
|
78
|
+
tpIdQualifier: '08'
|
|
79
|
+
myIdQualifier: ZZ
|
|
80
|
+
isa11: U
|
|
81
|
+
isa12: '00401'
|
|
82
|
+
isa14: '0'
|
|
83
|
+
isa15: T
|
|
84
|
+
isa16: ':'
|
|
85
|
+
tpGroupId: '9253390501'
|
|
86
|
+
myGroupId: KOMAR3PL
|
|
87
|
+
gs07: T
|
|
88
|
+
gs08: 004010UCS
|
|
89
|
+
- _id: 689e2e2c11a53a05a0337115
|
|
90
|
+
lastModified: '2025-08-14T18:51:52.968Z'
|
|
91
|
+
name: Amazon.eu
|
|
92
|
+
fileType: edifact
|
|
93
|
+
tpInterchangeId: '49494949494'
|
|
94
|
+
myInterchangeId: '12345678911'
|
|
95
|
+
controlNumber: 1
|
|
96
|
+
unb010_0001: UNOA
|
|
97
|
+
unb010_0002: '1'
|
|
98
|
+
tpIdQualifier: ZZZ
|
|
99
|
+
myIdQualifier: ZZZ
|
|
100
|
+
versionNumber: 96A
|
|
101
|
+
controllingAgency: EU
|
|
102
|
+
'204':
|
|
103
|
+
description: No EDI profiles exist in the account
|
|
104
|
+
'401':
|
|
105
|
+
$ref: '#/components/responses/401-unauthorized'
|
|
106
|
+
post:
|
|
107
|
+
x-internal: false
|
|
108
|
+
summary: Create an EDI profile
|
|
109
|
+
description: |-
|
|
110
|
+
Creates a new EDI profile for EDI X12 or EDIFACT document exchange.
|
|
111
|
+
`fileType` is immutable after creation. Only `name` and `fileType`
|
|
112
|
+
are required; all ISA/GS/UNB control fields default to safe values.
|
|
113
|
+
x-celigo-ai-guidance:
|
|
114
|
+
- |-
|
|
115
|
+
The `fileType` field is immutable after creation and determines which set of
|
|
116
|
+
interchange control fields are available: `edix12` (X12 ISA/GS segments) or
|
|
117
|
+
`edifact` (EDIFACT UNB segment). Send the enum value (`edix12`/`edifact`),
|
|
118
|
+
not the standard name (`X12`/`EDIFACT`).
|
|
119
|
+
operationId: createEDIProfile
|
|
120
|
+
tags:
|
|
121
|
+
- EDI Profiles
|
|
122
|
+
requestBody:
|
|
123
|
+
required: true
|
|
124
|
+
content:
|
|
125
|
+
application/json:
|
|
126
|
+
schema:
|
|
127
|
+
$ref: '#/components/schemas/Request'
|
|
128
|
+
examples:
|
|
129
|
+
x12-minimal:
|
|
130
|
+
summary: Minimal X12 profile
|
|
131
|
+
value:
|
|
132
|
+
name: Acme Corp X12
|
|
133
|
+
fileType: edix12
|
|
134
|
+
x12-full:
|
|
135
|
+
summary: X12 profile with interchange fields
|
|
136
|
+
value:
|
|
137
|
+
name: Acme Corp X12
|
|
138
|
+
fileType: edix12
|
|
139
|
+
tpInterchangeId: ACMECORP
|
|
140
|
+
myInterchangeId: MYCOMPANY
|
|
141
|
+
tpIdQualifier: ZZ
|
|
142
|
+
myIdQualifier: ZZ
|
|
143
|
+
isa01: '00'
|
|
144
|
+
isa03: '00'
|
|
145
|
+
isa11: U
|
|
146
|
+
isa12: '00501'
|
|
147
|
+
isa14: '0'
|
|
148
|
+
isa15: P
|
|
149
|
+
isa16: '>'
|
|
150
|
+
tpGroupId: ACME
|
|
151
|
+
myGroupId: MYAPP
|
|
152
|
+
gs07: X
|
|
153
|
+
gs08: '005010'
|
|
154
|
+
edifact:
|
|
155
|
+
summary: EDIFACT profile
|
|
156
|
+
value:
|
|
157
|
+
name: Partner EDIFACT
|
|
158
|
+
fileType: edifact
|
|
159
|
+
tpInterchangeId: '49494949494'
|
|
160
|
+
myInterchangeId: '12345678911'
|
|
161
|
+
tpIdQualifier: ZZZ
|
|
162
|
+
myIdQualifier: ZZZ
|
|
163
|
+
unb010_0001: UNOA
|
|
164
|
+
unb010_0002: '1'
|
|
165
|
+
versionNumber: D
|
|
166
|
+
releaseNumber: 96A
|
|
167
|
+
controllingAgency: UN
|
|
168
|
+
responses:
|
|
169
|
+
'201':
|
|
170
|
+
description: EDI profile created successfully
|
|
171
|
+
content:
|
|
172
|
+
application/json:
|
|
173
|
+
schema:
|
|
174
|
+
$ref: '#/components/schemas/EDIProfile'
|
|
175
|
+
examples:
|
|
176
|
+
x12-minimal:
|
|
177
|
+
summary: Created from the minimal X12 request
|
|
178
|
+
value:
|
|
179
|
+
_id: 5f8d43a1b9e5a80011a35f2c
|
|
180
|
+
lastModified: '2026-06-09T17:30:12.481Z'
|
|
181
|
+
name: Acme Corp X12
|
|
182
|
+
fileType: edix12
|
|
183
|
+
'401':
|
|
184
|
+
$ref: '#/components/responses/401-unauthorized'
|
|
185
|
+
'422':
|
|
186
|
+
$ref: '#/components/responses/422-unprocessable-entity'
|
|
187
|
+
/v1/ediprofiles/{_id}:
|
|
188
|
+
get:
|
|
189
|
+
x-internal: false
|
|
190
|
+
summary: Get an EDI profile
|
|
191
|
+
description: Returns a specific EDI profile.
|
|
192
|
+
operationId: getEDIProfileById
|
|
193
|
+
tags:
|
|
194
|
+
- EDI Profiles
|
|
195
|
+
parameters:
|
|
196
|
+
- name: _id
|
|
197
|
+
in: path
|
|
198
|
+
description: The unique identifier of the EDI profile
|
|
199
|
+
required: true
|
|
200
|
+
schema:
|
|
201
|
+
type: string
|
|
202
|
+
format: objectId
|
|
203
|
+
x-celigo-refModel: ediprofiles
|
|
204
|
+
examples:
|
|
205
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
206
|
+
responses:
|
|
207
|
+
'200':
|
|
208
|
+
description: EDI profile retrieved successfully
|
|
209
|
+
content:
|
|
210
|
+
application/json:
|
|
211
|
+
schema:
|
|
212
|
+
$ref: '#/components/schemas/EDIProfile'
|
|
213
|
+
examples:
|
|
214
|
+
x12:
|
|
215
|
+
value:
|
|
216
|
+
_id: 690146d901d66a7545038179
|
|
217
|
+
lastModified: '2026-05-02T18:10:01.832Z'
|
|
218
|
+
name: Dyno
|
|
219
|
+
fileType: edix12
|
|
220
|
+
tpInterchangeId: '9253390501'
|
|
221
|
+
myInterchangeId: KOMAR3PL
|
|
222
|
+
controlNumber: 1
|
|
223
|
+
isa01: '00'
|
|
224
|
+
isa03: '00'
|
|
225
|
+
tpIdQualifier: '08'
|
|
226
|
+
myIdQualifier: ZZ
|
|
227
|
+
isa11: U
|
|
228
|
+
isa12: '00401'
|
|
229
|
+
isa14: '0'
|
|
230
|
+
isa15: T
|
|
231
|
+
isa16: ':'
|
|
232
|
+
tpGroupId: '9253390501'
|
|
233
|
+
myGroupId: KOMAR3PL
|
|
234
|
+
gs07: T
|
|
235
|
+
gs08: 004010UCS
|
|
236
|
+
'401':
|
|
237
|
+
$ref: '#/components/responses/401-unauthorized'
|
|
238
|
+
'404':
|
|
239
|
+
$ref: '#/components/responses/404-not-found'
|
|
240
|
+
put:
|
|
241
|
+
x-internal: false
|
|
242
|
+
summary: Update an EDI profile
|
|
243
|
+
description: |-
|
|
244
|
+
Updates an existing EDI profile. `fileType` cannot be changed after
|
|
245
|
+
creation. Omitted fields are cleared to defaults.
|
|
246
|
+
operationId: updateEDIProfile
|
|
247
|
+
tags:
|
|
248
|
+
- EDI Profiles
|
|
249
|
+
parameters:
|
|
250
|
+
- name: _id
|
|
251
|
+
in: path
|
|
252
|
+
description: The unique identifier of the EDI profile
|
|
253
|
+
required: true
|
|
254
|
+
schema:
|
|
255
|
+
type: string
|
|
256
|
+
format: objectId
|
|
257
|
+
x-celigo-refModel: ediprofiles
|
|
258
|
+
examples:
|
|
259
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
260
|
+
requestBody:
|
|
261
|
+
required: true
|
|
262
|
+
content:
|
|
263
|
+
application/json:
|
|
264
|
+
schema:
|
|
265
|
+
$ref: '#/components/schemas/Request'
|
|
266
|
+
examples:
|
|
267
|
+
partial:
|
|
268
|
+
summary: Update interchange IDs only
|
|
269
|
+
value:
|
|
270
|
+
name: Dyno
|
|
271
|
+
fileType: edix12
|
|
272
|
+
tpInterchangeId: '9253390501'
|
|
273
|
+
myInterchangeId: KOMAR3PL
|
|
274
|
+
responses:
|
|
275
|
+
'200':
|
|
276
|
+
description: EDI profile updated successfully
|
|
277
|
+
content:
|
|
278
|
+
application/json:
|
|
279
|
+
schema:
|
|
280
|
+
$ref: '#/components/schemas/EDIProfile'
|
|
281
|
+
examples:
|
|
282
|
+
x12:
|
|
283
|
+
summary: Updated X12 profile
|
|
284
|
+
value:
|
|
285
|
+
_id: 690146d901d66a7545038179
|
|
286
|
+
lastModified: '2026-05-12T09:21:14.005Z'
|
|
287
|
+
name: Dyno
|
|
288
|
+
fileType: edix12
|
|
289
|
+
tpInterchangeId: '9253390501'
|
|
290
|
+
myInterchangeId: KOMAR3PL
|
|
291
|
+
controlNumber: 1
|
|
292
|
+
isa01: '00'
|
|
293
|
+
isa03: '00'
|
|
294
|
+
tpIdQualifier: '08'
|
|
295
|
+
myIdQualifier: ZZ
|
|
296
|
+
isa11: U
|
|
297
|
+
isa12: '00401'
|
|
298
|
+
isa14: '0'
|
|
299
|
+
isa15: T
|
|
300
|
+
isa16: ':'
|
|
301
|
+
tpGroupId: '9253390501'
|
|
302
|
+
myGroupId: KOMAR3PL
|
|
303
|
+
gs07: T
|
|
304
|
+
gs08: 004010UCS
|
|
305
|
+
'401':
|
|
306
|
+
$ref: '#/components/responses/401-unauthorized'
|
|
307
|
+
'404':
|
|
308
|
+
$ref: '#/components/responses/404-not-found'
|
|
309
|
+
delete:
|
|
310
|
+
x-internal: false
|
|
311
|
+
summary: Delete an EDI profile
|
|
312
|
+
description: Deletes an EDI profile. Soft-deleted and retained for 30 days.
|
|
313
|
+
operationId: deleteEDIProfile
|
|
314
|
+
tags:
|
|
315
|
+
- EDI Profiles
|
|
316
|
+
parameters:
|
|
317
|
+
- name: _id
|
|
318
|
+
in: path
|
|
319
|
+
description: The unique identifier of the EDI profile
|
|
320
|
+
required: true
|
|
321
|
+
schema:
|
|
322
|
+
type: string
|
|
323
|
+
format: objectId
|
|
324
|
+
x-celigo-refModel: ediprofiles
|
|
325
|
+
examples:
|
|
326
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
327
|
+
responses:
|
|
328
|
+
'204':
|
|
329
|
+
description: EDI profile deleted successfully
|
|
330
|
+
'401':
|
|
331
|
+
$ref: '#/components/responses/401-unauthorized'
|
|
332
|
+
'404':
|
|
333
|
+
$ref: '#/components/responses/404-not-found'
|
|
334
|
+
'422':
|
|
335
|
+
$ref: '#/components/responses/422-dependency-conflict'
|
|
336
|
+
/v1/ediprofiles/{_id}/dependencies:
|
|
337
|
+
get:
|
|
338
|
+
x-internal: false
|
|
339
|
+
operationId: listEdiProfileDependencies
|
|
340
|
+
tags:
|
|
341
|
+
- EDI Profiles
|
|
342
|
+
summary: List dependencies of an EDI profile
|
|
343
|
+
description: |-
|
|
344
|
+
Returns the set of resources that depend on the specified resource.
|
|
345
|
+
The response is an object whose keys are dependent-resource types
|
|
346
|
+
(e.g. `flows`, `imports`) and whose values are arrays of dependency
|
|
347
|
+
entries. Returns `{}` when no dependents exist, including for
|
|
348
|
+
well-formatted but nonexistent IDs.
|
|
349
|
+
parameters:
|
|
350
|
+
- name: _id
|
|
351
|
+
in: path
|
|
352
|
+
required: true
|
|
353
|
+
description: Resource ID.
|
|
354
|
+
schema:
|
|
355
|
+
type: string
|
|
356
|
+
format: objectId
|
|
357
|
+
x-celigo-refModel: ediprofiles
|
|
358
|
+
examples:
|
|
359
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
360
|
+
responses:
|
|
361
|
+
'200':
|
|
362
|
+
description: |
|
|
363
|
+
Dependency map. Keys are resource-type strings; values are arrays
|
|
364
|
+
of dependency entries. Returns `{}` when no dependents exist.
|
|
365
|
+
content:
|
|
366
|
+
application/json:
|
|
367
|
+
schema:
|
|
368
|
+
$ref: '#/components/schemas/DependencyResponse'
|
|
369
|
+
examples:
|
|
370
|
+
none:
|
|
371
|
+
summary: No dependents (also returned for a nonexistent ID)
|
|
372
|
+
value: {}
|
|
373
|
+
'401':
|
|
374
|
+
$ref: '#/components/responses/401-unauthorized'
|
|
375
|
+
components:
|
|
376
|
+
securitySchemes:
|
|
377
|
+
bearerAuth:
|
|
378
|
+
type: http
|
|
379
|
+
scheme: bearer
|
|
380
|
+
schemas:
|
|
381
|
+
EDIProfileBase:
|
|
382
|
+
type: object
|
|
383
|
+
description: Writable EDI profile fields shared by the request and response schemas.
|
|
384
|
+
properties:
|
|
385
|
+
name:
|
|
386
|
+
type: string
|
|
387
|
+
description: Human-readable name for the EDI profile
|
|
388
|
+
x-celigo-ai-guidance:
|
|
389
|
+
- Name the profile after the trading partner and EDI standard whose interchange identity it carries (e.g. "Acme Corp X12 Profile"), not after a flow's purpose — one partner's profile is reused by every document exchange with that partner.
|
|
390
|
+
examples:
|
|
391
|
+
- Acme Corp X12 Profile
|
|
392
|
+
- Partner EDIFACT Profile
|
|
393
|
+
description:
|
|
394
|
+
type: string
|
|
395
|
+
description: Detailed description of the EDI profile's purpose
|
|
396
|
+
examples:
|
|
397
|
+
- X12 interchange profile for Acme Corp trading partner
|
|
398
|
+
fileType:
|
|
399
|
+
type: string
|
|
400
|
+
enum:
|
|
401
|
+
- edix12
|
|
402
|
+
- edifact
|
|
403
|
+
x-enumDescriptions:
|
|
404
|
+
edix12: ANSI X12 EDI standard using ISA/GS envelope segments.
|
|
405
|
+
edifact: UN/EDIFACT EDI standard using UNB envelope segments.
|
|
406
|
+
description: The EDI standard this profile is configured for. Immutable after creation.
|
|
407
|
+
examples:
|
|
408
|
+
- edix12
|
|
409
|
+
- edifact
|
|
410
|
+
tpInterchangeId:
|
|
411
|
+
type: string
|
|
412
|
+
description: Trading partner's interchange identifier (ISA06 for X12, UNB sender/receiver ID for EDIFACT)
|
|
413
|
+
examples:
|
|
414
|
+
- ACMECORP
|
|
415
|
+
- '5412345678901'
|
|
416
|
+
myInterchangeId:
|
|
417
|
+
type: string
|
|
418
|
+
description: Your (sender/receiver) interchange identifier
|
|
419
|
+
examples:
|
|
420
|
+
- MYCOMPANY
|
|
421
|
+
- '1234567890123'
|
|
422
|
+
controlNumber:
|
|
423
|
+
type: integer
|
|
424
|
+
minimum: 1
|
|
425
|
+
maximum: 999999999
|
|
426
|
+
default: 1
|
|
427
|
+
description: Current interchange control number. Incremented with each interchange sent.
|
|
428
|
+
examples:
|
|
429
|
+
- 1
|
|
430
|
+
- 1001
|
|
431
|
+
isa01:
|
|
432
|
+
type: string
|
|
433
|
+
enum:
|
|
434
|
+
- '00'
|
|
435
|
+
- '01'
|
|
436
|
+
- '02'
|
|
437
|
+
- '03'
|
|
438
|
+
- '04'
|
|
439
|
+
- '05'
|
|
440
|
+
x-enumDescriptions:
|
|
441
|
+
'00': No authorization information present.
|
|
442
|
+
'01': Authorization type 01.
|
|
443
|
+
'02': Authorization type 02.
|
|
444
|
+
'03': Authorization type 03.
|
|
445
|
+
'04': Authorization type 04.
|
|
446
|
+
'05': Authorization type 05.
|
|
447
|
+
description: X12 ISA01 — Authorization Information Qualifier.
|
|
448
|
+
x-celigo-ai-guidance:
|
|
449
|
+
- |-
|
|
450
|
+
- 00: No authorization information present
|
|
451
|
+
- 01-05: Various authorization types
|
|
452
|
+
examples:
|
|
453
|
+
- '00'
|
|
454
|
+
isa02:
|
|
455
|
+
type: string
|
|
456
|
+
description: X12 ISA02 - Authorization Information (10 characters)
|
|
457
|
+
examples:
|
|
458
|
+
- ' '
|
|
459
|
+
isa03:
|
|
460
|
+
type: string
|
|
461
|
+
enum:
|
|
462
|
+
- '00'
|
|
463
|
+
- '01'
|
|
464
|
+
x-enumDescriptions:
|
|
465
|
+
'00': No security information present.
|
|
466
|
+
'01': Password-based security.
|
|
467
|
+
description: X12 ISA03 — Security Information Qualifier.
|
|
468
|
+
examples:
|
|
469
|
+
- '00'
|
|
470
|
+
isa04:
|
|
471
|
+
type: string
|
|
472
|
+
description: X12 ISA04 - Security Information (10 characters)
|
|
473
|
+
examples:
|
|
474
|
+
- ' '
|
|
475
|
+
tpIdQualifier:
|
|
476
|
+
type: string
|
|
477
|
+
description: |
|
|
478
|
+
Trading partner ID qualifier.
|
|
479
|
+
|
|
480
|
+
For X12 (ISA05/ISA07): Values include 01 (DUNS), 08 (UCC EDI), 12 (phone),
|
|
481
|
+
14 (DUNS+4), ZZ (mutually defined), etc.
|
|
482
|
+
|
|
483
|
+
For EDIFACT: Values include 14 (EAN), ZZZ (mutually defined), etc.
|
|
484
|
+
examples:
|
|
485
|
+
- ZZ
|
|
486
|
+
- '01'
|
|
487
|
+
- '14'
|
|
488
|
+
myIdQualifier:
|
|
489
|
+
type: string
|
|
490
|
+
description: |
|
|
491
|
+
Your (sender/receiver) ID qualifier. Same enum as tpIdQualifier.
|
|
492
|
+
examples:
|
|
493
|
+
- ZZ
|
|
494
|
+
- '01'
|
|
495
|
+
- '14'
|
|
496
|
+
isa11:
|
|
497
|
+
type: string
|
|
498
|
+
description: |
|
|
499
|
+
X12 ISA11 - Repetition Separator (or Interchange Control Standards Identifier
|
|
500
|
+
in older versions). Single character.
|
|
501
|
+
examples:
|
|
502
|
+
- U
|
|
503
|
+
- ^
|
|
504
|
+
isa12:
|
|
505
|
+
type: string
|
|
506
|
+
description: X12 ISA12 - Interchange Control Version Number (5 characters)
|
|
507
|
+
examples:
|
|
508
|
+
- '00401'
|
|
509
|
+
- '00501'
|
|
510
|
+
isa14:
|
|
511
|
+
type: string
|
|
512
|
+
enum:
|
|
513
|
+
- '0'
|
|
514
|
+
- '1'
|
|
515
|
+
x-enumDescriptions:
|
|
516
|
+
'0': No interchange acknowledgment requested.
|
|
517
|
+
'1': Interchange acknowledgment requested (TA1).
|
|
518
|
+
description: X12 ISA14 — Acknowledgment Requested.
|
|
519
|
+
examples:
|
|
520
|
+
- '0'
|
|
521
|
+
- '1'
|
|
522
|
+
isa15:
|
|
523
|
+
type: string
|
|
524
|
+
enum:
|
|
525
|
+
- P
|
|
526
|
+
- T
|
|
527
|
+
x-enumDescriptions:
|
|
528
|
+
P: Production data interchange.
|
|
529
|
+
T: Test data interchange.
|
|
530
|
+
description: X12 ISA15 — Interchange Usage Indicator.
|
|
531
|
+
examples:
|
|
532
|
+
- P
|
|
533
|
+
- T
|
|
534
|
+
isa16:
|
|
535
|
+
type: string
|
|
536
|
+
description: X12 ISA16 - Component Element Separator. Single character.
|
|
537
|
+
examples:
|
|
538
|
+
- '>'
|
|
539
|
+
- ':'
|
|
540
|
+
tpGroupId:
|
|
541
|
+
type: string
|
|
542
|
+
description: X12 GS02 - Trading partner's application sender/receiver code
|
|
543
|
+
examples:
|
|
544
|
+
- ACME
|
|
545
|
+
myGroupId:
|
|
546
|
+
type: string
|
|
547
|
+
description: X12 GS03 - Your application sender/receiver code
|
|
548
|
+
examples:
|
|
549
|
+
- MYAPP
|
|
550
|
+
gs07:
|
|
551
|
+
type: string
|
|
552
|
+
enum:
|
|
553
|
+
- X
|
|
554
|
+
- T
|
|
555
|
+
x-enumDescriptions:
|
|
556
|
+
X: Accredited Standards Committee X12.
|
|
557
|
+
T: Transportation Data Coordinating Committee.
|
|
558
|
+
description: X12 GS07 — Responsible Agency Code.
|
|
559
|
+
examples:
|
|
560
|
+
- X
|
|
561
|
+
gs08:
|
|
562
|
+
type: string
|
|
563
|
+
description: X12 GS08 - Version/Release/Industry Identifier Code
|
|
564
|
+
examples:
|
|
565
|
+
- '004010'
|
|
566
|
+
- '005010'
|
|
567
|
+
unb010_0001:
|
|
568
|
+
type: string
|
|
569
|
+
enum:
|
|
570
|
+
- UNOA
|
|
571
|
+
- UNOB
|
|
572
|
+
- UNOC
|
|
573
|
+
- UNOD
|
|
574
|
+
- UNOE
|
|
575
|
+
- UNOF
|
|
576
|
+
x-enumDescriptions:
|
|
577
|
+
UNOA: Level A character set (uppercase letters, digits, and basic punctuation).
|
|
578
|
+
UNOB: Level B character set (Level A plus lowercase letters).
|
|
579
|
+
UNOC: Level C character set (ISO 8859-1 Latin-1).
|
|
580
|
+
UNOD: Level D character set (ISO 8859-2 Latin-2).
|
|
581
|
+
UNOE: Level E character set (ISO 8859-5 Cyrillic).
|
|
582
|
+
UNOF: Level F character set (ISO 8859-7 Greek).
|
|
583
|
+
description: |
|
|
584
|
+
EDIFACT UNB S001/0001 - Syntax Identifier.
|
|
585
|
+
Identifies the character set used in the interchange.
|
|
586
|
+
examples:
|
|
587
|
+
- UNOB
|
|
588
|
+
unb010_0002:
|
|
589
|
+
type: string
|
|
590
|
+
enum:
|
|
591
|
+
- '1'
|
|
592
|
+
- '2'
|
|
593
|
+
- '3'
|
|
594
|
+
x-enumDescriptions:
|
|
595
|
+
'1': EDIFACT syntax version 1.
|
|
596
|
+
'2': EDIFACT syntax version 2.
|
|
597
|
+
'3': EDIFACT syntax version 3.
|
|
598
|
+
description: |
|
|
599
|
+
EDIFACT UNB S001/0002 - Syntax Version Number.
|
|
600
|
+
examples:
|
|
601
|
+
- '3'
|
|
602
|
+
versionNumber:
|
|
603
|
+
type: string
|
|
604
|
+
description: |
|
|
605
|
+
EDIFACT message version number (e.g., "D" for directory).
|
|
606
|
+
examples:
|
|
607
|
+
- D
|
|
608
|
+
releaseNumber:
|
|
609
|
+
type: string
|
|
610
|
+
description: |
|
|
611
|
+
EDIFACT message release number.
|
|
612
|
+
examples:
|
|
613
|
+
- 96A
|
|
614
|
+
- 01B
|
|
615
|
+
- 14A
|
|
616
|
+
controllingAgency:
|
|
617
|
+
type: string
|
|
618
|
+
description: |
|
|
619
|
+
EDIFACT controlling agency code.
|
|
620
|
+
examples:
|
|
621
|
+
- UN
|
|
622
|
+
- EC
|
|
623
|
+
- AA
|
|
624
|
+
ResourceResponse:
|
|
625
|
+
type: object
|
|
626
|
+
description: Response
|
|
627
|
+
x-celigo-ai-guidance:
|
|
628
|
+
- Core response fields shared by all Celigo resources
|
|
629
|
+
properties:
|
|
630
|
+
_id:
|
|
631
|
+
type: string
|
|
632
|
+
format: objectId
|
|
633
|
+
readOnly: true
|
|
634
|
+
description: Unique identifier for the resource. Format is a 24-character hexadecimal string.
|
|
635
|
+
x-celigo-ai-guidance:
|
|
636
|
+
- |-
|
|
637
|
+
The _id is used in:
|
|
638
|
+
- API endpoints that operate on a specific resource (e.g., GET, PUT, DELETE)
|
|
639
|
+
- References from other resources (e.g., flows that use this resource)
|
|
640
|
+
- Job history and error tracking
|
|
641
|
+
examples:
|
|
642
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
643
|
+
createdAt:
|
|
644
|
+
type: string
|
|
645
|
+
format: date-time
|
|
646
|
+
readOnly: true
|
|
647
|
+
description: Timestamp when the resource was created. Set automatically and cannot be modified.
|
|
648
|
+
x-celigo-ai-guidance:
|
|
649
|
+
- Recorded in ISO 8601 with a UTC timezone (Z suffix).
|
|
650
|
+
examples:
|
|
651
|
+
- '2023-04-01T09:15:32Z'
|
|
652
|
+
lastModified:
|
|
653
|
+
type: string
|
|
654
|
+
format: date-time
|
|
655
|
+
readOnly: true
|
|
656
|
+
description: Timestamp when the resource was last updated. Changes whenever any property is modified.
|
|
657
|
+
x-celigo-ai-guidance:
|
|
658
|
+
- Recorded in ISO 8601 with a UTC timezone (Z suffix); always equal to or later than `createdAt`.
|
|
659
|
+
examples:
|
|
660
|
+
- '2023-04-15T14:30:15Z'
|
|
661
|
+
deletedAt:
|
|
662
|
+
type:
|
|
663
|
+
- string
|
|
664
|
+
- 'null'
|
|
665
|
+
format: date-time
|
|
666
|
+
readOnly: true
|
|
667
|
+
description: Timestamp when the resource was soft-deleted. When null or absent, the resource is active.
|
|
668
|
+
x-celigo-ai-guidance:
|
|
669
|
+
- Non-null means the resource is soft-deleted (in the recycle bin) — recoverable within the retention period before permanent removal.
|
|
670
|
+
examples:
|
|
671
|
+
- '2023-05-20T11:45:32Z'
|
|
672
|
+
required:
|
|
673
|
+
- _id
|
|
674
|
+
EDIProfile:
|
|
675
|
+
type: object
|
|
676
|
+
required:
|
|
677
|
+
- _id
|
|
678
|
+
- name
|
|
679
|
+
- fileType
|
|
680
|
+
- lastModified
|
|
681
|
+
description: EDI profile with metadata and interchange control fields.
|
|
682
|
+
allOf:
|
|
683
|
+
- $ref: '#/components/schemas/EDIProfileBase'
|
|
684
|
+
- $ref: '#/components/schemas/ResourceResponse'
|
|
685
|
+
- type: object
|
|
686
|
+
properties:
|
|
687
|
+
_templateId:
|
|
688
|
+
type: string
|
|
689
|
+
format: objectId
|
|
690
|
+
readOnly: true
|
|
691
|
+
x-celigo-refModel: templates
|
|
692
|
+
description: Template this EDI profile was installed from.
|
|
693
|
+
examples:
|
|
694
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
695
|
+
_sourceId:
|
|
696
|
+
type: string
|
|
697
|
+
format: objectId
|
|
698
|
+
readOnly: true
|
|
699
|
+
description: Original profile ID when cloned or installed from a template.
|
|
700
|
+
examples:
|
|
701
|
+
- 5f8d43a1b9e5a80011a35f2c
|
|
702
|
+
x-celigo-ai-guidance:
|
|
703
|
+
- |-
|
|
704
|
+
Contains the complete EDI profile configuration including metadata and
|
|
705
|
+
all interchange control fields for the configured file type (X12 or EDIFACT).
|
|
706
|
+
Request:
|
|
707
|
+
type: object
|
|
708
|
+
description: |-
|
|
709
|
+
EDI profile configuration. The `fileType` field determines which set of
|
|
710
|
+
interchange control fields apply (X12 ISA/GS or EDIFACT UNB) and is
|
|
711
|
+
immutable after creation. Fields for the other standard are ignored.
|
|
712
|
+
x-celigo-ai-guidance:
|
|
713
|
+
- Request schema for creating or updating an EDI profile.
|
|
714
|
+
required:
|
|
715
|
+
- name
|
|
716
|
+
- fileType
|
|
717
|
+
allOf:
|
|
718
|
+
- $ref: '#/components/schemas/EDIProfileBase'
|
|
719
|
+
Error:
|
|
720
|
+
type: object
|
|
721
|
+
description: Standard error response envelope returned by integrator.io APIs.
|
|
722
|
+
properties:
|
|
723
|
+
errors:
|
|
724
|
+
type: array
|
|
725
|
+
description: List of errors that occurred while processing the request.
|
|
726
|
+
items:
|
|
727
|
+
type: object
|
|
728
|
+
properties:
|
|
729
|
+
code:
|
|
730
|
+
oneOf:
|
|
731
|
+
- type: string
|
|
732
|
+
- type: integer
|
|
733
|
+
description: |-
|
|
734
|
+
Machine-readable error code. Usually a string like
|
|
735
|
+
`invalid_ref`, `missing_required_field`, or `unauthorized`;
|
|
736
|
+
may be an **integer** when the error mirrors an upstream HTTP
|
|
737
|
+
status (e.g. `500`) — most commonly returned by connection-ping
|
|
738
|
+
and adaptor-proxy responses.
|
|
739
|
+
message:
|
|
740
|
+
type: string
|
|
741
|
+
description: Human-readable description of the error.
|
|
742
|
+
field:
|
|
743
|
+
type: string
|
|
744
|
+
description: |-
|
|
745
|
+
Optional pointer to the document field that caused the error.
|
|
746
|
+
Used by structural validation errors (`missing_required_field`,
|
|
747
|
+
`invalid_ref`) to indicate which field is at fault
|
|
748
|
+
(e.g. `_id`, `type`, `http.baseURI`).
|
|
749
|
+
source:
|
|
750
|
+
type: string
|
|
751
|
+
description: |-
|
|
752
|
+
Optional origin layer for the error — e.g. `application` when
|
|
753
|
+
the error came from the remote system the adaptor called,
|
|
754
|
+
`connector` when the adaptor itself rejected the request.
|
|
755
|
+
required:
|
|
756
|
+
- message
|
|
757
|
+
required:
|
|
758
|
+
- errors
|
|
759
|
+
DependencyEntry:
|
|
760
|
+
type: object
|
|
761
|
+
description: A single resource that depends on the queried resource.
|
|
762
|
+
properties:
|
|
763
|
+
id:
|
|
764
|
+
type: string
|
|
765
|
+
description: Unique identifier of the dependent resource.
|
|
766
|
+
examples:
|
|
767
|
+
- 61f92026dd053843b5d72350
|
|
768
|
+
name:
|
|
769
|
+
type: string
|
|
770
|
+
description: Display name of the dependent resource.
|
|
771
|
+
examples:
|
|
772
|
+
- Import Orders to NetSuite
|
|
773
|
+
paths:
|
|
774
|
+
type: array
|
|
775
|
+
description: |-
|
|
776
|
+
Dot-notation paths within the dependent resource that reference
|
|
777
|
+
the target resource. `[*]` denotes array elements.
|
|
778
|
+
items:
|
|
779
|
+
type: string
|
|
780
|
+
examples:
|
|
781
|
+
- - hooks.preSavePage._scriptId
|
|
782
|
+
accessLevel:
|
|
783
|
+
type: string
|
|
784
|
+
description: The caller's access level on the dependent resource.
|
|
785
|
+
examples:
|
|
786
|
+
- manage
|
|
787
|
+
dependencyIds:
|
|
788
|
+
type: object
|
|
789
|
+
description: |-
|
|
790
|
+
Map of resource types to arrays of IDs that this dependent
|
|
791
|
+
resource references on the target. Keys are singular or plural
|
|
792
|
+
resource type strings; values are arrays of ID strings.
|
|
793
|
+
additionalProperties:
|
|
794
|
+
type: array
|
|
795
|
+
items:
|
|
796
|
+
type: string
|
|
797
|
+
example:
|
|
798
|
+
script:
|
|
799
|
+
- 64ff4b21612a134bd2f45531
|
|
800
|
+
required:
|
|
801
|
+
- id
|
|
802
|
+
- name
|
|
803
|
+
- paths
|
|
804
|
+
- accessLevel
|
|
805
|
+
- dependencyIds
|
|
806
|
+
DependencyResponse:
|
|
807
|
+
type: object
|
|
808
|
+
description: |
|
|
809
|
+
Map of dependent-resource types to arrays of dependency entries.
|
|
810
|
+
Keys are plural resource type strings (e.g. `flows`, `imports`,
|
|
811
|
+
`connections`). An empty object `{}` means no dependents.
|
|
812
|
+
additionalProperties:
|
|
813
|
+
type: array
|
|
814
|
+
items:
|
|
815
|
+
$ref: '#/components/schemas/DependencyEntry'
|
|
816
|
+
example:
|
|
817
|
+
exports:
|
|
818
|
+
- id: 64ff4b21612a134bd2f45534
|
|
819
|
+
name: Bank FTP Export
|
|
820
|
+
paths:
|
|
821
|
+
- hooks.preSavePage._scriptId
|
|
822
|
+
accessLevel: manage
|
|
823
|
+
dependencyIds:
|
|
824
|
+
script:
|
|
825
|
+
- 64ff4b21612a134bd2f45531
|
|
826
|
+
flows:
|
|
827
|
+
- id: 64ff4b22612a134bd2f45538
|
|
828
|
+
name: CAMT-053 to Celigo CAM Format
|
|
829
|
+
paths:
|
|
830
|
+
- pageGenerators[*]._exportId
|
|
831
|
+
accessLevel: manage
|
|
832
|
+
dependencyIds:
|
|
833
|
+
export:
|
|
834
|
+
- 64ff4b21612a134bd2f45534
|
|
835
|
+
responses:
|
|
836
|
+
401-unauthorized:
|
|
837
|
+
description: |-
|
|
838
|
+
Unauthorized. The request lacks a valid bearer token, or the provided token
|
|
839
|
+
failed to authenticate.
|
|
840
|
+
|
|
841
|
+
Note: the 401 response is produced by the auth middleware **before** the
|
|
842
|
+
request reaches the endpoint handler, so it does **not** follow the
|
|
843
|
+
standard `{errors: [...]}` envelope. Instead the body is a bare
|
|
844
|
+
`{message: string}` object with no `code`, no `errors` array. Callers
|
|
845
|
+
handling 401s should key off the HTTP status and the `message` string,
|
|
846
|
+
not try to destructure an `errors[]`.
|
|
847
|
+
content:
|
|
848
|
+
application/json:
|
|
849
|
+
schema:
|
|
850
|
+
type: object
|
|
851
|
+
properties:
|
|
852
|
+
message:
|
|
853
|
+
type: string
|
|
854
|
+
description: |-
|
|
855
|
+
Human-readable description of the auth failure. Known values:
|
|
856
|
+
- `"Unauthorized"` — no `Authorization` header on the request.
|
|
857
|
+
- `"Bearer Authentication Failed"` — header present but token
|
|
858
|
+
is invalid, revoked, or expired.
|
|
859
|
+
required:
|
|
860
|
+
- message
|
|
861
|
+
examples:
|
|
862
|
+
missing_token:
|
|
863
|
+
summary: No Authorization header sent
|
|
864
|
+
value:
|
|
865
|
+
message: Unauthorized
|
|
866
|
+
invalid_token:
|
|
867
|
+
summary: Bearer token invalid or revoked
|
|
868
|
+
value:
|
|
869
|
+
message: Bearer Authentication Failed
|
|
870
|
+
422-unprocessable-entity:
|
|
871
|
+
description: |
|
|
872
|
+
Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.
|
|
873
|
+
content:
|
|
874
|
+
application/json:
|
|
875
|
+
schema:
|
|
876
|
+
$ref: '#/components/schemas/Error'
|
|
877
|
+
examples:
|
|
878
|
+
default:
|
|
879
|
+
value:
|
|
880
|
+
errors:
|
|
881
|
+
- code: unprocessable_entity
|
|
882
|
+
message: The request could not be processed due to a semantic error.
|
|
883
|
+
404-not-found:
|
|
884
|
+
description: |
|
|
885
|
+
Not found. The requested resource does not exist or is not visible to the caller.
|
|
886
|
+
content:
|
|
887
|
+
application/json:
|
|
888
|
+
schema:
|
|
889
|
+
$ref: '#/components/schemas/Error'
|
|
890
|
+
examples:
|
|
891
|
+
default:
|
|
892
|
+
value:
|
|
893
|
+
errors:
|
|
894
|
+
- code: not_found
|
|
895
|
+
message: The requested resource was not found.
|
|
896
|
+
422-dependency-conflict:
|
|
897
|
+
description: |-
|
|
898
|
+
The resource has dependents that must be deleted first. Each entry
|
|
899
|
+
in the `errors` array names one blocking resource.
|
|
900
|
+
content:
|
|
901
|
+
application/json:
|
|
902
|
+
schema:
|
|
903
|
+
$ref: '#/components/schemas/Error'
|
|
904
|
+
examples:
|
|
905
|
+
default:
|
|
906
|
+
value:
|
|
907
|
+
errors:
|
|
908
|
+
- code: dependencies_not_deleted
|
|
909
|
+
message: export 6902d88c10b42b2eaac9b2a1 must be deleted before you can delete connection 6398ddf316be761fb16a6523
|
|
910
|
+
x-enable-proxy: true
|
|
911
|
+
x-internal: false
|