Skip to content

Commit 213ab6e

Browse files
balaji1103balaji1103
committed
TIR - Updated webforms.rest.swagger-v1.1.0.json
1 parent 51d5a8c commit 213ab6e

1 file changed

Lines changed: 49 additions & 27 deletions

File tree

‎webforms.rest.swagger-v1.1.0.json‎

Lines changed: 49 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -580,6 +580,7 @@
580580
"tokenUrl": "https://account-d.docusign.com/oauth/token",
581581
"scopes": {
582582
"webforms_read": "Read web form configuration",
583+
"webforms_write": "Create web form and modify web form configuration",
583584
"webforms_instance_read": "Read instance configuration",
584585
"webforms_instance_write": "Create instance and modify instance configuration"
585586
}
@@ -914,8 +915,24 @@
914915
"description": "The request body for the `Instances::createInstance` endpoint.",
915916
"properties": {
916917
"formValues": {
917-
"$ref": "#/definitions/WebFormValues",
918-
"description": "Key-value pairs used to prefill fields in the web form instance. The keys correspond to the values of the `publishedComponentNames` object on the `WebForm` (configuration) object.\n\nFor keys of type TextBox, Email, Date, Select, and RadioButtonGroup, the value should be a string. For keys of type Number, the value should be a number. For keys of type of CheckboxGroup, the value should be an array of strings.\n\nFor example, a web form configuration might have the following properties indicated by the `publishedComponentNames` object:\n```\n\"publishedComponentNames\": {\n \"Signer_name\": \"TextBox\",\n \"Signer_email\": \"Email\",\n \"Dropdown\": \"Select\",\n \"Hobbies\": \"CheckboxGroup\"\n}\n```\n\nThen, this property might be:\n```\n{\n \"Signer_name\": \"Francis Beagle\",\n \"Signer_email\": \"francis@example.com\",\n \"Hobbies\": [\"walking\", \"napping\"]\n}\n```\n\nNote that you do not have to include values for every component. This property is **optional.**"
918+
"type": "object",
919+
"description": "Key-value pairs used to prefill fields in the web form instance. The keys correspond to the values of the `publishedComponentNames` object on the `WebForm` (configuration) object.\n\nFor keys of type TextBox, Email, Date, Select, and RadioButtonGroup, the value should be a string. For keys of type Number, the value should be a number. For keys of type of CheckboxGroup, the value should be an array of strings.\n\nFor example, a web form configuration might have the following properties indicated by the `publishedComponentNames` object:\n```\n\"publishedComponentNames\": {\n \"Signer_name\": \"TextBox\",\n \"Signer_email\": \"Email\",\n \"Dropdown\": \"Select\",\n \"Hobbies\": \"CheckboxGroup\"\n}\n```\n\nThen, this property might be:\n```\n{\n \"Signer_name\": \"Francis Beagle\",\n \"Signer_email\": \"francis@example.com\",\n \"Hobbies\": [\"walking\", \"napping\"]\n}\n```\n\nNote that you do not have to include values for every component. This property is **optional.**",
920+
"additionalProperties": {},
921+
"example": {
922+
"Textbox_Name": "First Last",
923+
"Email_primary": "example@example.com",
924+
"Date_birth": "2020-01-01",
925+
"Number_age": 52,
926+
"Select_state": "California",
927+
"Radio_Gender": "Female",
928+
"Checkbox_hobbies": [
929+
"singing",
930+
"dancing"
931+
],
932+
"ID_card_attachment": {
933+
"documentName": "id_card.pdf"
934+
}
935+
}
919936
},
920937
"clientUserId": {
921938
"$ref": "#/definitions/ClientUserId",
@@ -949,6 +966,10 @@
949966
"$ref": "#/definitions/SendOption",
950967
"description": ""
951968
},
969+
"brandId": {
970+
"$ref": "#/definitions/BrandId",
971+
"description": ""
972+
},
952973
"recipients": {
953974
"description": "",
954975
"type": "array",
@@ -1133,8 +1154,28 @@
11331154
"description": "Metadata associated with the web form instance."
11341155
},
11351156
"formValues": {
1136-
"$ref": "#/definitions/WebFormValues",
1137-
"description": "Key-value pairs that represent the current values of the fields in the web form instance. The keys correspond to the `componentName` values of the `formContent.components` object on the `WebForm` (configuration) object. See [Form field definitions](/docs/web-forms-api/plan-integration/retrieve-configuration-details/#form-field-definitions) for more information.\n\nSee [Request that retrieves web form instance values](/docs/web-forms-api/plan-integration/retrieve-submitted-values/#request-that-retrieves-web-form-instance-values) for an example of a `formValues` object returned by this request.\n"
1157+
"type": "object",
1158+
"description": "Key-value pairs that represent the current values of the fields in the web form instance. The keys correspond to the `componentName` values of the `formContent.components` object on the `WebForm` (configuration) object. See [Form field definitions](/docs/web-forms-api/plan-integration/retrieve-configuration-details/#form-field-definitions) for more information.\n\nSee [Request that retrieves web form instance values](/docs/web-forms-api/plan-integration/retrieve-submitted-values/#request-that-retrieves-web-form-instance-values) for an example of a `formValues` object returned by this request.\n",
1159+
"additionalProperties": {},
1160+
"example": {
1161+
"Textbox_Name": "First Last",
1162+
"Email_primary": "example@example.com",
1163+
"Date_birth": "2020-01-01",
1164+
"Number_age": 52,
1165+
"Select_state": "California",
1166+
"Radio_Gender": "Female",
1167+
"Checkbox_hobbies": [
1168+
"singing",
1169+
"dancing"
1170+
],
1171+
"ID_card_attachment": {
1172+
"documentName": "id_card.pdf"
1173+
}
1174+
}
1175+
},
1176+
"brandId": {
1177+
"$ref": "#/definitions/BrandId",
1178+
"description": ""
11381179
},
11391180
"recipients": {
11401181
"description": "",
@@ -1147,6 +1188,9 @@
11471188
},
11481189
"instanceRecipientStatus": {
11491190
"$ref": "#/definitions/InstanceRecipientStatus"
1191+
},
1192+
"roleName": {
1193+
"$ref": "#/definitions/RoleName"
11501194
}
11511195
}
11521196
}
@@ -1268,28 +1312,6 @@
12681312
"x-ds-definition-name": "WebForm",
12691313
"x-ms-summary": "A web form configuration."
12701314
},
1271-
"WebFormValues": {
1272-
"type": "object",
1273-
"description": "Key-value pairs of data used to create a form instance.",
1274-
"additionalProperties": {},
1275-
"example": {
1276-
"Textbox_Name": "First Last",
1277-
"Email_primary": "example@example.com",
1278-
"Date_birth": "2020-01-01",
1279-
"Number_age": 52,
1280-
"Select_state": "California",
1281-
"Radio_Gender": "Female",
1282-
"Checkbox_hobbies": [
1283-
"singing",
1284-
"dancing"
1285-
],
1286-
"ID_card_attachment": {
1287-
"documentName": "id_card.pdf"
1288-
}
1289-
},
1290-
"x-ds-definition-name": "WebFormValues",
1291-
"x-ms-summary": "Key-value pairs of data used to create a form instance."
1292-
},
12931315
"WebFormState": {
12941316
"type": "string",
12951317
"description": "The state of the form content",
@@ -1744,4 +1766,4 @@
17441766
"description": "<ds-inlinemessage>The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact \n[DocuSign Support](https://support.docusign.com/s/?language=en_US) or your account manager to find out whether the Web Forms API is available for your production account plan.</ds-inlinemessage>\n\nMethods for working with web forms."
17451767
}
17461768
]
1747-
}
1769+
}

0 commit comments

Comments
 (0)