-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
4840 lines (4832 loc) · 149 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Ironclad Public API
description: Documentation for Ironclad's REST API.
version: '1'
contact:
name: Ironclad Support
email: support@ironcladapp.com
x-konfig-ignore:
object-with-no-properties: true
servers:
- description: Production server
url: https://ironcladapp.com/public/api/v1
- description: EU Production server
url: https://eu1.ironcladapp.com/public/api/v1
- description: Demo server
url: https://demo.ironcladapp.com/public/api/v1
- description: Preview Server
url: https://preview.ironcladapp.com/public/api/v1
tags:
- description: Documentation on Ironclad Workflows.
name: Workflows
- description: Documentation on Ironclad Records.
name: Records
- description: Documentation on Ironclad Webhooks.
name: Webhooks
paths:
/workflows:
post:
tags:
- Workflows
summary: Create a Workflow Synchronously
operationId: Workflows_createSyncWorkflow
description: Launch a new Workflow synchronously.
requestBody:
$ref: '#/components/requestBodies/WorkflowLaunch'
responses:
'200':
$ref: '#/components/responses/WorkflowLaunchResponse200'
'400':
$ref: '#/components/responses/WorkflowLaunchResponse400'
get:
tags:
- Workflows
summary: List All Workflows
operationId: Workflows_listAll
description: List all workflows in your Ironclad account.
parameters:
- $ref: '#/components/parameters/QueryPageNumber'
- $ref: '#/components/parameters/QueryPageSize'
- description: >-
Filter the workflows that are listed based on their status. If this
parameter is omitted, `active` workflows will be returned. Active
workflows include workflows in the Create, Review, Sign, and Archive
stages.
name: status
in: query
schema:
type: string
enum:
- active
- paused
- completed
- cancelled
- description: Filter workflows to a specific Template ID.
name: template
in: query
schema:
type: string
- description: Retrieve workflows that have been updated since a UTC date.
name: lastUpdated
in: query
schema:
type: string
- description: >-
Filter workflows using a formula. The workflow attribute ID should
be enclosed in brackets `[ ]` and the value should be enclosed in
single quotes `' '`.
Workflow attributes for a specific workflow design can be identified
using the [List All Workflow
Schemas](https://developer.ironcladapp.com/reference/list-all-workflow-schemas)
endpoint.
Supported formula operations include:
<ul>
<li><code>Equals</code></li>
<li><code>Contains</code></li>
<li><code>And</code></li>
<li><code>Or</code></li>
</ul>
For more information on writing formulas, please refer to
<a
href="https://ironcladapp.com/formulas/#company%20display%20name">this
article</a>.
name: filter
in: query
schema:
type: string
example: Equals([counterpartyName], 'Harley Quinn')
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsListAllResponse'
/workflows/async:
post:
tags:
- Workflows
summary: Create a Workflow Asynchronously
operationId: Workflows_launchAsynchronously
description: >-
Launch a new Workflow asynchronously for non-blocking performance, which
is helpful when/if you provide files to the Workflow.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowRequestModel'
responses:
'200':
$ref: '#/components/responses/AsyncWorkflowLaunchResponse200'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsLaunchAsynchronously400Response'
/workflows/async/{asyncJobId}:
get:
tags:
- Workflows
summary: Retrieve the Status of an Async Workflow Create Job
operationId: Workflows_getAsyncJobStatus
description: >-
Check the status of a Workflow you created while using the [Create a
Workflow
Async](https://developer.ironcladapp.com/reference/create-a-workflow-sync-vs-async#create-a-new-workflow-async)
route.
parameters:
- description: >-
The identifier provided in the response of creating a Workflow
asynchronously.
name: asyncJobId
in: path
schema:
type: string
required: true
responses:
'200':
$ref: '#/components/responses/AsyncWorkflowStatusResponse200'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetAsyncJobStatus404Response'
/workflows/{id}:
get:
tags:
- Workflows
summary: Retrieve a Workflow
operationId: Workflows_getWorkflow
description: View the data associated with a specific workflow
parameters:
- description: The unique identifier or Ironclad ID of a workflow.
name: id
in: path
schema:
type: string
example: abcd1234
required: true
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowResponseModel'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetWorkflowResponse'
/workflows/{id}/approvals:
get:
tags:
- Workflows
summary: List All Workflow Approvals
operationId: Workflows_listApprovals
description: >-
Returns a list of approvals for the workflow. The `approvalGroups`
property will display only triggered approvals (i.e. conditional
approvals that have not been triggered will not appear).
parameters:
- description: The unique identifier or Ironclad ID of a workflow.
name: id
in: path
schema:
type: string
example: abcd1234
required: true
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsListApprovalsResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsListApprovals400Response'
/workflows/{id}/approval-requests:
get:
tags:
- Workflows
summary: Retrieve the Approval Requests on a Workflow
operationId: Workflows_getApprovalRequests
description: >-
Returns a list of approval requests that have taken place on the
workflow.
parameters:
- description: The unique identifier or Ironclad ID of a workflow.
name: id
in: path
schema:
type: string
required: true
- $ref: '#/components/parameters/QueryPageNumber'
- $ref: '#/components/parameters/QueryPageSize'
- description: >-
An optional boolean parameter that adds additional information about
the actor to each item in the response. Defaults to false.
name: actorDetails
in: query
schema:
type: boolean
example: false
default: false
required: false
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetApprovalRequestsResponse'
'403':
description: '403'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetApprovalRequests403Response'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetApprovalRequests404Response'
/workflows/{id}/approvals/{roleId}:
patch:
tags:
- Workflows
summary: Update Approval on a Workflow
operationId: Workflows_updateApprovalStatus
description: >-
Updates an approval to the specified status. Approvals can only be
updated during the Review step.
parameters:
- description: The unique identifier or Ironclad ID of a workflow.
name: id
in: path
schema:
type: string
example: abcd1234
required: true
- description: >-
The unique identifier of the approver role whose status should be
changed. This identifier can be retrieved using the `GET
/workflows/{id}/approvals` endpoint.
name: roleId
in: path
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsUpdateApprovalStatusRequest'
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsUpdateApprovalStatusResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsUpdateApprovalStatus400Response'
/workflows/{id}/turn-history:
get:
tags:
- Workflows
summary: Retrieve the Turn History on a Workflow
operationId: Workflows_getTurnHistory
description: An array of objects for each turn on a workflow.
parameters:
- description: The unique identifier or Ironclad ID of a workflow.
name: id
in: path
schema:
type: string
required: true
- $ref: '#/components/parameters/QueryPageNumber'
- $ref: '#/components/parameters/QueryPageSize'
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetTurnHistoryResponse'
'403':
description: '403'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetTurnHistory403Response'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetTurnHistory404Response'
/workflows/{id}/signatures:
get:
tags:
- Workflows
summary: List All Workflow Signers
operationId: Workflows_listSignatures
description: Returns a list of workflow signers and the status of their signature.
parameters:
- description: The unique identifier or Ironclad ID of a workflow.
name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsListSignaturesResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsListSignatures400Response'
'403':
description: '403'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsListSignatures403Response'
/workflows/{id}/participants:
get:
tags:
- Workflows
summary: List All Workflow Participants
operationId: Workflows_listAllParticipants
description: Returns a list of workflow participants.
parameters:
- description: The unique identifier or Ironclad ID of a workflow.
name: id
in: path
schema:
type: string
required: true
- $ref: '#/components/parameters/QueryPageNumber'
- $ref: '#/components/parameters/QueryPageSize'
- description: The Ironclad user's email address.
name: email
in: query
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsListAllParticipantsResponse'
'403':
description: '403'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsListAllParticipants403Response'
'404':
$ref: '#/components/responses/WorkflowNotFoundResponse404'
/workflows/{id}/revert-to-review:
patch:
tags:
- Workflows
summary: Revert a Workflow to the Review Step
operationId: Workflows_revertToReview
description: >-
Reverts a workflow to the Review step. Only workflows sourced from
Workflow Designer and in the Sign step can be reverted.
parameters:
- description: The unique identifier or Ironclad ID of a workflow.
name: id
in: path
schema:
type: string
required: true
- $ref: '#/components/parameters/XAsUserEmail'
- $ref: '#/components/parameters/XAsUserId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsRevertToReviewRequest'
responses:
'204':
description: '204'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsRevertToReviewResponse'
'403':
description: '403'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsRevertToReview403Response'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsRevertToReview404Response'
/workflows/{id}/comment:
post:
tags:
- Workflows
summary: Create a Comment on a Workflow
operationId: Workflows_createComment
description: Creates a comment in the specified workflow's activity feed.
parameters:
- description: The unique identifier or Ironclad ID of a workflow.
name: id
in: path
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsCreateCommentRequest'
responses:
'204':
description: '204'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsCreateCommentResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsCreateComment400Response'
deprecated: true
/workflows/{id}/comments:
post:
tags:
- Workflows
summary: Create a Comment on a Workflow
operationId: Workflows_createComment
description: Creates a comment in the specified workflow's activity feed.
parameters:
- description: The unique identifier or Ironclad ID of a workflow.
name: id
in: path
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsCreateCommentRequest1'
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/BaseActivityFeedItemModel'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsCreateComment400Response'
/workflows/{id}/attributes:
patch:
tags:
- Workflows
summary: Update Workflow Metadata
operationId: Workflows_updateMetadata
description: >-
The workflow must be in the Review step in order for its data to be
updated. Use the `remove` action to clear field values and the `set`
action to add or modify values. Form validation is enforced; required
fields cannot be removed and any required fields triggered by conditions
must be populated.
parameters:
- description: The unique identifier or Ironclad ID of a workflow.
name: id
in: path
schema:
type: string
required: true
- $ref: '#/components/parameters/XAsUserEmail'
- $ref: '#/components/parameters/XAsUserId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsUpdateMetadataRequest'
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsUpdateMetadataResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsUpdateMetadata400Response'
examples:
noInformationChanged:
summary: No information changed
value:
code: INVALID_PARAM
message: >-
No information changed. The updates provided did not
introduce any new values
param: attributes
invalidParamNonExistentAttribute:
summary: Non-existent attribute specified
value:
code: INVALID_PARAM
message: 'non-existent attribute(s) specified: someRandomAttribute'
param: attributes
invalidParamFormValidationFailed:
summary: Form validation failed
description: >-
Form validation may fail if (1) a required conditional field
is triggered but not populated by your request (2) the value
does not conform to the expected field type (e.g., sending
strings to number fields).
value:
code: INVALID_PARAM
message: form validation failed, please check schema
param: attributes
invalidParamReadOnlyField:
summary: Read-only attribute
description: Cannot patch read-only attribute someRandomFunctionAttribute
value:
code: INVALID_PARAM
message: >-
Cannot patch read-only attribute
someRandomFunctionAttribute
param: attributes
'403':
description: '403'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsUpdateMetadata403Response'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsUpdateMetadata404Response'
/workflows/{id}/document/{key}/download:
get:
tags:
- Workflows
summary: Retrieve a Workflow Document
operationId: Workflows_getDocumentByKey
description: >-
Download a document associated with a specific workflow via a reference
to its document key
parameters:
- description: The unique identifier or Ironclad ID of a workflow.
name: id
in: path
schema:
type: string
required: true
- description: >-
The unique identifier for the attachment. This key can be located
using the [Retrieve a
Workflow](https://developer.ironcladapp.com/reference/retrieve-a-workflow)
endpoint. In the response, locate the file attribute (e.g., `draft`)
and look at its `download` parameter. The download parameter
includes the key at the end of the URL
`.../document/{ATTACHMENT_KEY}/download`
name: key
in: path
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetDocumentByKeyResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetDocumentByKey400Response'
/workflows/{id}/emails:
get:
tags:
- Workflows
summary: Retrieve Email Threads from A Workflow
operationId: Workflows_getEmailThreads
description: List all email threads in the specified workflow
parameters:
- $ref: '#/components/parameters/WorkflowId'
- $ref: '#/components/parameters/QueryPageNumber'
- $ref: '#/components/parameters/QueryPageSize'
responses:
'200':
$ref: '#/components/responses/EmailsResponse200'
'404':
$ref: '#/components/responses/WorkflowNotFoundResponse404'
/workflows/{id}/emails/{emailThreadId}:
get:
tags:
- Workflows
summary: Retrieve an Email Thread from a Specified Workflow
operationId: Workflows_getEmailThread
description: List a single email thread for a specified workflow
parameters:
- $ref: '#/components/parameters/WorkflowId'
- $ref: '#/components/parameters/EmailThreadId'
responses:
'200':
$ref: '#/components/responses/EmailResponse200'
'404':
$ref: '#/components/responses/WorkflowOrEmailNotFoundResponse404'
/workflows/{id}/emails/{emailThreadId}/attachments/{attachmentId}:
get:
tags:
- Workflows
summary: Retrieve an Attachment from an Email Thread
operationId: Workflows_getAttachmentFromEmailThread
description: Retrieve an attachment from the specified email thread
parameters:
- $ref: '#/components/parameters/WorkflowId'
- $ref: '#/components/parameters/EmailThreadId'
- description: >-
The unique identifier for the attachment. This key can be located
using the [Retrieve email threads from
workflow](https://developer.ironcladapp.com/reference/retrieve-emails)
endpoint. In the response, locate the file attribute (e.g.,
`attachments`) and look at its `download` parameter. The download
parameter includes the key at the end of the URL
`...emails/{emailThreadId}/attachment/{ATTACHMENT_ID}`
name: attachmentId
in: path
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: >-
#/components/schemas/WorkflowsGetAttachmentFromEmailThreadResponse
'404':
$ref: '#/components/responses/ObjectNotFoundResponse404'
/workflow-schemas:
get:
tags:
- Workflows
summary: List All Workflow Schemas
operationId: Workflows_listAllWorkflowSchemas
description: >-
Returns a list of workflow schemas. Each schema specifies the fields
used in the workflow's launch form.
parameters:
- description: The launch form is the only form supported at this time.
name: form
in: query
required: true
schema:
type: string
default: launch
- $ref: '#/components/parameters/XAsUserEmail'
- $ref: '#/components/parameters/XAsUserId'
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsListAllWorkflowSchemasResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: >-
#/components/schemas/WorkflowsListAllWorkflowSchemas400Response
/workflow-schemas/{id}:
get:
tags:
- Workflows
summary: Retrieve a Workflow Schema
operationId: Workflows_getWorkflowSchema
description: Returns the fields used in the workflow's launch form.
parameters:
- description: >-
The unique identifier of a schema (see explanation of [Template
ID](https://developer.ironcladapp.com/reference/getting-started-api)).
A list of identifiers can be retrieved using the `GET
/workflow-schemas` endpoint. Only published workflows will have an
identifier.
name: id
in: path
schema:
type: string
required: true
- name: form
in: query
schema:
type: string
default: launch
- $ref: '#/components/parameters/XAsUserEmail'
- $ref: '#/components/parameters/XAsUserId'
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetWorkflowSchemaResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsGetWorkflowSchema400Response'
examples:
notFound:
summary: Non-existent template id.
value:
code: NOT_FOUND
message: workflow template schema not found
param: templateId
invalidParam:
summary: Invalid query parameter.
value:
code: INVALID_PARAM
message: >-
invalid query value 'randomRequest'; value must be one of
[launch]
param: /?form
/records:
get:
tags:
- Records
summary: List All Records
operationId: Records_listAll
description: >-
View all records in the company, with filtering available via query
parameters
parameters:
- $ref: '#/components/parameters/QueryPageNumber'
- $ref: '#/components/parameters/QueryPageSize'
- $ref: '#/components/parameters/RecordType'
- $ref: '#/components/parameters/RecordLastUpdated'
- $ref: '#/components/parameters/RecordFilter'
- description: >-
The field to sort Records. Only one field is supported in the sort
operation.
name: sortField
in: query
schema:
type: string
enum:
- agreementDate
- name
- lastUpdated
default: agreementDate
- description: >-
The direction the records are sorted by in correlation with the
`sortField`.
name: sortDirection
in: query
schema:
type: string
enum:
- ASC
- DESC
default: DESC
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/RecordsListAllResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/RecordsListAll400Response'
post:
tags:
- Records
summary: Create a Record
operationId: Records_createRecord
description: Create a contract record by specifying its intended metadata properties
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RecordsCreateRecordRequest'
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/RecordModel'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/RecordsCreateRecordResponse'
examples:
invalidRecordType:
summary: Unknown record type.
value:
code: INVALID_PARAM
message: unknown record type my_nonexistent_record_type
param: type
invalidRecordProperty:
summary: Unknown record property.
value:
code: INVALID_PARAM
message: unknown property my_nonexistent_record_property
param: properties.my_non_existent_record_property
/records/smart-import:
get:
tags:
- Records
summary: Retrieve Predictions
operationId: Records_getPredictions
description: >-
Retrieve status of predictions of specific smart import record or all
records in an import, one of Record Id or Import Id is required.
parameters:
- description: The ID of the Record for prediction status.
name: recordId
in: query
schema:
type: string
required: false
- description: The ID of the Import for prediction statuses.
name: importId
in: query
schema:
type: string
required: false
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/RecordsGetPredictionsResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/RecordsGetPredictions400Response'
examples:
invalidRecordType:
summary: Missing Record Id or Import Id from query.
value:
code: INVALID_PARAM
message: missing required form-data part 'recordId' or 'importId
'403':
description: '403'
content:
application/json:
schema:
$ref: '#/components/schemas/RecordsGetPredictions403Response'
examples:
outOfSmartImportCredits:
summary: Smart Imports not enabled for company.
value:
code: FORBIDDEN
message: >-
Reading smart import records not allowed for company with
id invalid-company-id
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/RecordsGetPredictions404Response'
examples:
invalidImportId:
summary: Record Id is invalid or does not exist
value:
code: NOT_FOUND
message: >-
couldn't find predictions for the record:
invalid-record-id
post:
tags:
- Records
summary: Create a Smart Import Record
operationId: Records_uploadSmartImportRecord
description: >-
Upload a file to create a record with smart import and predictions.
Provide none of recordType, newRecordTypeId, or newRecordTypeDisplayName
to default to Imported type.
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/RecordsUploadSmartImportRecordRequest'
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/RecordsUploadSmartImportRecordResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/RecordsUploadSmartImportRecord400Response'
examples:
invalidRecordType:
summary: Invalid record type.
value:
code: INVALID_PARAM
message: unknown record type invalid_record_type
param: type
invalidAttachment:
summary: Document size is too large.