DataFlex / DocuSign REST API / Creates a connect configuration for the specified account.
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "connectId": "sample string 1",
// "configurationType": "sample string 2",
// "urlToPublishTo": "sample string 3",
// "name": "sample string 4",
// "allowEnvelopePublish": "sample string 5",
// "enableLog": "sample string 6",
// "includeDocuments": "sample string 7",
// "includeCertificateOfCompletion": "sample string 8",
// "requiresAcknowledgement": "sample string 9",
// "signMessageWithX509Certificate": "sample string 10",
// "useSoapInterface": "sample string 11",
// "includeTimeZoneInformation": "sample string 12",
// "includeHMAC": "sample string 13",
// "includeEnvelopeVoidReason": "sample string 14",
// "includeSenderAccountasCustomField": "sample string 15",
// "envelopeEvents": "sample string 16",
// "recipientEvents": "sample string 17",
// "userIds": "sample string 18",
// "soapNamespace": "sample string 19",
// "allUsers": "sample string 20",
// "includeCertSoapHeader": "sample string 21",
// "includeDocumentFields": "sample string 22"
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "connectId" "sample string 1" To iSuccess
Get ComUpdateString Of hoJson "configurationType" "sample string 2" To iSuccess
Get ComUpdateString Of hoJson "urlToPublishTo" "sample string 3" To iSuccess
Get ComUpdateString Of hoJson "name" "sample string 4" To iSuccess
Get ComUpdateString Of hoJson "allowEnvelopePublish" "sample string 5" To iSuccess
Get ComUpdateString Of hoJson "enableLog" "sample string 6" To iSuccess
Get ComUpdateString Of hoJson "includeDocuments" "sample string 7" To iSuccess
Get ComUpdateString Of hoJson "includeCertificateOfCompletion" "sample string 8" To iSuccess
Get ComUpdateString Of hoJson "requiresAcknowledgement" "sample string 9" To iSuccess
Get ComUpdateString Of hoJson "signMessageWithX509Certificate" "sample string 10" To iSuccess
Get ComUpdateString Of hoJson "useSoapInterface" "sample string 11" To iSuccess
Get ComUpdateString Of hoJson "includeTimeZoneInformation" "sample string 12" To iSuccess
Get ComUpdateString Of hoJson "includeHMAC" "sample string 13" To iSuccess
Get ComUpdateString Of hoJson "includeEnvelopeVoidReason" "sample string 14" To iSuccess
Get ComUpdateString Of hoJson "includeSenderAccountasCustomField" "sample string 15" To iSuccess
Get ComUpdateString Of hoJson "envelopeEvents" "sample string 16" To iSuccess
Get ComUpdateString Of hoJson "recipientEvents" "sample string 17" To iSuccess
Get ComUpdateString Of hoJson "userIds" "sample string 18" To iSuccess
Get ComUpdateString Of hoJson "soapNamespace" "sample string 19" To iSuccess
Get ComUpdateString Of hoJson "allUsers" "sample string 20" To iSuccess
Get ComUpdateString Of hoJson "includeCertSoapHeader" "sample string 21" To iSuccess
Get ComUpdateString Of hoJson "includeDocumentFields" "sample string 22" To iSuccess
// Adds the "Authorization: Bearer {{accessToken}}" header.
Set ComAuthToken Of hoHttp To "{{accessToken}}"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://domain.com/v2.1/accounts/{{accountId}}/connect" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Send Destroy of hoResp
End_Procedure
Curl Command
curl -X POST
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"connectId": "sample string 1",
"configurationType": "sample string 2",
"urlToPublishTo": "sample string 3",
"name": "sample string 4",
"allowEnvelopePublish": "sample string 5",
"enableLog": "sample string 6",
"includeDocuments": "sample string 7",
"includeCertificateOfCompletion": "sample string 8",
"requiresAcknowledgement": "sample string 9",
"signMessageWithX509Certificate": "sample string 10",
"useSoapInterface": "sample string 11",
"includeTimeZoneInformation": "sample string 12",
"includeHMAC": "sample string 13",
"includeEnvelopeVoidReason": "sample string 14",
"includeSenderAccountasCustomField": "sample string 15",
"envelopeEvents": "sample string 16",
"recipientEvents": "sample string 17",
"userIds": "sample string 18",
"soapNamespace": "sample string 19",
"allUsers": "sample string 20",
"includeCertSoapHeader": "sample string 21",
"includeDocumentFields": "sample string 22"
}'
https://domain.com/v2.1/accounts/{{accountId}}/connect
Postman Collection Item JSON
{
"name": "Creates a connect configuration for the specified account.",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"connectId\": \"sample string 1\",\n \"configurationType\": \"sample string 2\",\n \"urlToPublishTo\": \"sample string 3\",\n \"name\": \"sample string 4\",\n \"allowEnvelopePublish\": \"sample string 5\",\n \"enableLog\": \"sample string 6\",\n \"includeDocuments\": \"sample string 7\",\n \"includeCertificateOfCompletion\": \"sample string 8\",\n \"requiresAcknowledgement\": \"sample string 9\",\n \"signMessageWithX509Certificate\": \"sample string 10\",\n \"useSoapInterface\": \"sample string 11\",\n \"includeTimeZoneInformation\": \"sample string 12\",\n \"includeHMAC\": \"sample string 13\",\n \"includeEnvelopeVoidReason\": \"sample string 14\",\n \"includeSenderAccountasCustomField\": \"sample string 15\",\n \"envelopeEvents\": \"sample string 16\",\n \"recipientEvents\": \"sample string 17\",\n \"userIds\": \"sample string 18\",\n \"soapNamespace\": \"sample string 19\",\n \"allUsers\": \"sample string 20\",\n \"includeCertSoapHeader\": \"sample string 21\",\n \"includeDocumentFields\": \"sample string 22\"\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/connect",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"connect"
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}"
}
]
},
"description": "Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide].\n\n###### Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal."
},
"response": [
]
}
