Skip to content

Commit 8557006

Browse files
mymattcarrollmymattcarroll
authored
Merge pull request #4 from oneblink/ON-45986 (microsoft#3748)
ON-45986 # Added operation to retrieve approval record
1 parent d51b6ce commit 8557006

File tree

2 files changed

+400
-2
lines changed

2 files changed

+400
-2
lines changed

‎certified-connectors/CivicPlus/apiDefinition.swagger.json‎

Lines changed: 200 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"swagger": "2.0",
33
"info": {
4-
"version": "1.8",
4+
"version": "1.9",
55
"title": "CivicPlus Transform",
66
"description": "Empowers business users to create and deploy digital forms for enterprise and government organizations as web and native apps, while allowing developers to customize, extend, or harness the forms through their own custom apps. Connect your forms with this connector to allow easy submission of your form data into your backend systems or databases without the need to write complex integration code.",
77
"contact": {
@@ -284,6 +284,16 @@
284284
"required": true,
285285
"type": "string",
286286
"x-ms-summary": "Attachment Id"
287+
},
288+
{
289+
"name": "range",
290+
"in": "header",
291+
"description": "The range of bytes to gather for a chunked file.",
292+
"required": true,
293+
"type": "string",
294+
"default": "bytes=0-10000000",
295+
"x-ms-visibility": "internal",
296+
"x-ms-summary": "range"
287297
}
288298
],
289299
"responses": {
@@ -381,6 +391,195 @@
381391
}
382392
}
383393
},
394+
"/forms/{formId}/approval-steps": {
395+
"get": {
396+
"description": "Allows for Form approval steps to be retrieved",
397+
"summary": "Retrieve Form Approval Steps",
398+
"operationId": "GetFormApprovalSteps",
399+
"x-ms-visibility": "internal",
400+
"produces": [
401+
"application/json"
402+
],
403+
"parameters": [
404+
{
405+
"in": "path",
406+
"name": "formId",
407+
"type": "integer",
408+
"required": true,
409+
"x-ms-visibility": "important",
410+
"x-ms-dynamic-values": {
411+
"operationId": "GetForms",
412+
"value-path": "id",
413+
"value-collection": "forms",
414+
"value-title": "name"
415+
}
416+
}
417+
],
418+
"responses": {
419+
"200": {
420+
"description": "OK",
421+
"schema": {
422+
"type": "object",
423+
"additionalProperties": true,
424+
"properties": {
425+
"approvalSteps": {
426+
"type": "array",
427+
"items": {
428+
"type": "object",
429+
"additionalProperties": true,
430+
"properties": {
431+
"label": {
432+
"type": "string"
433+
}
434+
}
435+
}
436+
}
437+
}
438+
}
439+
},
440+
"401": {
441+
"description": "Unauthenticated",
442+
"schema": {
443+
"$ref": "#/definitions/APIErrorPayload"
444+
}
445+
},
446+
"403": {
447+
"description": "Forbidden",
448+
"schema": {
449+
"$ref": "#/definitions/APIErrorPayload"
450+
}
451+
},
452+
"404": {
453+
"description": "Not Found",
454+
"schema": {
455+
"$ref": "#/definitions/APIErrorPayload"
456+
}
457+
},
458+
"500": {
459+
"description": "Internal Server Error",
460+
"schema": {
461+
"$ref": "#/definitions/APIErrorPayload"
462+
}
463+
}
464+
}
465+
}
466+
},
467+
"/form-submission-meta/{submissionId}/approval-steps/{approvalLabel}": {
468+
"get": {
469+
"description": "Allows for Form Approval data for a single step to be retrieved",
470+
"summary": "Retrieve Approval Record",
471+
"operationId": "GetFormSubmissionApprovalByStepLabel",
472+
"x-ms-visibility": "important",
473+
"produces": [
474+
"application/json"
475+
],
476+
"parameters": [
477+
{
478+
"in": "path",
479+
"name": "submissionId",
480+
"description": "ID of the form submission",
481+
"required": true,
482+
"type": "string",
483+
"x-ms-summary": "Submission Id",
484+
"x-ms-visibility": "important"
485+
},
486+
{
487+
"in": "query",
488+
"name": "formId",
489+
"type": "integer",
490+
"required": true,
491+
"x-ms-summary": "Form",
492+
"x-ms-visibility": "important",
493+
"description": "Form to select an approval step",
494+
"x-ms-dynamic-values": {
495+
"operationId": "GetForms",
496+
"value-path": "id",
497+
"value-collection": "forms",
498+
"value-title": "name"
499+
}
500+
},
501+
{
502+
"in": "path",
503+
"name": "approvalLabel",
504+
"type": "string",
505+
"required": true,
506+
"x-ms-summary": "Approval Step",
507+
"x-ms-visibility": "important",
508+
"description": "Approval step to retrieve approval record",
509+
"x-ms-dynamic-values": {
510+
"operationId": "GetFormApprovalSteps",
511+
"value-path": "label",
512+
"value-collection": "approvalSteps",
513+
"value-title": "label",
514+
"parameters": {
515+
"formId": {
516+
"parameter": "formId"
517+
}
518+
}
519+
}
520+
}
521+
],
522+
"responses": {
523+
"200": {
524+
"description": "OK",
525+
"schema": {
526+
"type": "object",
527+
"additionalProperties": true,
528+
"properties": {
529+
"formSubmissionApproval": {
530+
"type": "object",
531+
"additionalProperties": true,
532+
"properties": {
533+
"updatedBy": {
534+
"type": "string",
535+
"format": "date-time",
536+
"x-ms-summary": "Approved By: Email Address"
537+
},
538+
"updatedAt": {
539+
"type": "string",
540+
"format": "date-time",
541+
"x-ms-summary": "Approved Timestamp"
542+
},
543+
"approvalFormId": {
544+
"type": "number",
545+
"x-ms-summary": "Approval Form Id"
546+
},
547+
"approvalFormSubmissionId": {
548+
"type": "string",
549+
"x-ms-summary": "Approval Form Submission Id"
550+
}
551+
}
552+
}
553+
}
554+
}
555+
},
556+
"401": {
557+
"description": "Unauthenticated",
558+
"schema": {
559+
"$ref": "#/definitions/APIErrorPayload"
560+
}
561+
},
562+
"403": {
563+
"description": "Forbidden",
564+
"schema": {
565+
"$ref": "#/definitions/APIErrorPayload"
566+
}
567+
},
568+
"404": {
569+
"description": "Not Found",
570+
"schema": {
571+
"$ref": "#/definitions/APIErrorPayload"
572+
}
573+
},
574+
"500": {
575+
"description": "Internal Server Error",
576+
"schema": {
577+
"$ref": "#/definitions/APIErrorPayload"
578+
}
579+
}
580+
}
581+
}
582+
},
384583
"/forms/{formId}/submissions/{submissionId}/pdf-document": {
385584
"post": {
386585
"description": "Allows for Form Submission PDF to be generated",

0 commit comments

Comments
 (0)