PureBasic / DocuSign REST API / Modifies tab settings for specified account
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "textTabsEnabled": "sample string 1",
; "textTabsMetadata": {
; "rights": "sample string 1",
; "uiHint": "sample string 2",
; "uiType": "sample string 3",
; "uiOrder": "sample string 4",
; "is21CFRPart11": "sample string 5",
; "options": [
; "sample string 1"
; ]
; },
; "radioTabsEnabled": "sample string 2",
; "radioTabsMetadata": {},
; "checkboxTabsEnabled": "sample string 3",
; "checkboxTabsMetadata": {},
; "listTabsEnabled": "sample string 4",
; "listTabsMetadata": {},
; "approveDeclineTabsEnabled": "sample string 5",
; "approveDeclineTabsMetadata": {},
; "noteTabsEnabled": "sample string 6",
; "noteTabsMetadata": {},
; "dataFieldRegexEnabled": "sample string 7",
; "dataFieldRegexMetadata": {},
; "dataFieldSizeEnabled": "sample string 8",
; "dataFieldSizeMetadata": {},
; "tabLocationEnabled": "sample string 9",
; "tabLocationMetadata": {},
; "tabScaleEnabled": "sample string 10",
; "tabScaleMetadata": {},
; "tabLockingEnabled": "sample string 11",
; "tabLockingMetadata": {},
; "savingCustomTabsEnabled": "sample string 12",
; "savingCustomTabsMetadata": {},
; "tabTextFormattingEnabled": "sample string 13",
; "tabTextFormattingMetadata": {},
; "sharedCustomTabsEnabled": "sample string 14",
; "sharedCustomTabsMetadata": {},
; "senderToChangeTabAssignmentsEnabled": "sample string 15",
; "senderToChangeTabAssignmentsMetadata": {},
; "tabDataLabelEnabled": "sample string 16",
; "tabDataLabelMetadata": {},
; "firstLastEmailTabsEnabled": "sample string 17",
; "firstLastEmailTabsMetadata": {},
; "calculatedFieldsEnabled": "sample string 18",
; "calculatedFieldsMetadata": {},
; "allowTabOrder": "sample string 19",
; "allowTabOrderMetadata": {}
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"textTabsEnabled","sample string 1")
CkJsonObject::ckUpdateString(json,"textTabsMetadata.rights","sample string 1")
CkJsonObject::ckUpdateString(json,"textTabsMetadata.uiHint","sample string 2")
CkJsonObject::ckUpdateString(json,"textTabsMetadata.uiType","sample string 3")
CkJsonObject::ckUpdateString(json,"textTabsMetadata.uiOrder","sample string 4")
CkJsonObject::ckUpdateString(json,"textTabsMetadata.is21CFRPart11","sample string 5")
CkJsonObject::ckUpdateString(json,"textTabsMetadata.options[0]","sample string 1")
CkJsonObject::ckUpdateString(json,"radioTabsEnabled","sample string 2")
CkJsonObject::ckUpdateNewObject(json,"radioTabsMetadata")
CkJsonObject::ckUpdateString(json,"checkboxTabsEnabled","sample string 3")
CkJsonObject::ckUpdateNewObject(json,"checkboxTabsMetadata")
CkJsonObject::ckUpdateString(json,"listTabsEnabled","sample string 4")
CkJsonObject::ckUpdateNewObject(json,"listTabsMetadata")
CkJsonObject::ckUpdateString(json,"approveDeclineTabsEnabled","sample string 5")
CkJsonObject::ckUpdateNewObject(json,"approveDeclineTabsMetadata")
CkJsonObject::ckUpdateString(json,"noteTabsEnabled","sample string 6")
CkJsonObject::ckUpdateNewObject(json,"noteTabsMetadata")
CkJsonObject::ckUpdateString(json,"dataFieldRegexEnabled","sample string 7")
CkJsonObject::ckUpdateNewObject(json,"dataFieldRegexMetadata")
CkJsonObject::ckUpdateString(json,"dataFieldSizeEnabled","sample string 8")
CkJsonObject::ckUpdateNewObject(json,"dataFieldSizeMetadata")
CkJsonObject::ckUpdateString(json,"tabLocationEnabled","sample string 9")
CkJsonObject::ckUpdateNewObject(json,"tabLocationMetadata")
CkJsonObject::ckUpdateString(json,"tabScaleEnabled","sample string 10")
CkJsonObject::ckUpdateNewObject(json,"tabScaleMetadata")
CkJsonObject::ckUpdateString(json,"tabLockingEnabled","sample string 11")
CkJsonObject::ckUpdateNewObject(json,"tabLockingMetadata")
CkJsonObject::ckUpdateString(json,"savingCustomTabsEnabled","sample string 12")
CkJsonObject::ckUpdateNewObject(json,"savingCustomTabsMetadata")
CkJsonObject::ckUpdateString(json,"tabTextFormattingEnabled","sample string 13")
CkJsonObject::ckUpdateNewObject(json,"tabTextFormattingMetadata")
CkJsonObject::ckUpdateString(json,"sharedCustomTabsEnabled","sample string 14")
CkJsonObject::ckUpdateNewObject(json,"sharedCustomTabsMetadata")
CkJsonObject::ckUpdateString(json,"senderToChangeTabAssignmentsEnabled","sample string 15")
CkJsonObject::ckUpdateNewObject(json,"senderToChangeTabAssignmentsMetadata")
CkJsonObject::ckUpdateString(json,"tabDataLabelEnabled","sample string 16")
CkJsonObject::ckUpdateNewObject(json,"tabDataLabelMetadata")
CkJsonObject::ckUpdateString(json,"firstLastEmailTabsEnabled","sample string 17")
CkJsonObject::ckUpdateNewObject(json,"firstLastEmailTabsMetadata")
CkJsonObject::ckUpdateString(json,"calculatedFieldsEnabled","sample string 18")
CkJsonObject::ckUpdateNewObject(json,"calculatedFieldsMetadata")
CkJsonObject::ckUpdateString(json,"allowTabOrder","sample string 19")
CkJsonObject::ckUpdateNewObject(json,"allowTabOrderMetadata")
; Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp::setCkAuthToken(http, "{{accessToken}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/v2.1/accounts/{{accountId}}/settings/tabs",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndProcedure
Curl Command
curl -X PUT
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"textTabsEnabled": "sample string 1",
"textTabsMetadata": {
"rights": "sample string 1",
"uiHint": "sample string 2",
"uiType": "sample string 3",
"uiOrder": "sample string 4",
"is21CFRPart11": "sample string 5",
"options": [
"sample string 1"
]
},
"radioTabsEnabled": "sample string 2",
"radioTabsMetadata": {},
"checkboxTabsEnabled": "sample string 3",
"checkboxTabsMetadata": {},
"listTabsEnabled": "sample string 4",
"listTabsMetadata": {},
"approveDeclineTabsEnabled": "sample string 5",
"approveDeclineTabsMetadata": {},
"noteTabsEnabled": "sample string 6",
"noteTabsMetadata": {},
"dataFieldRegexEnabled": "sample string 7",
"dataFieldRegexMetadata": {},
"dataFieldSizeEnabled": "sample string 8",
"dataFieldSizeMetadata": {},
"tabLocationEnabled": "sample string 9",
"tabLocationMetadata": {},
"tabScaleEnabled": "sample string 10",
"tabScaleMetadata": {},
"tabLockingEnabled": "sample string 11",
"tabLockingMetadata": {},
"savingCustomTabsEnabled": "sample string 12",
"savingCustomTabsMetadata": {},
"tabTextFormattingEnabled": "sample string 13",
"tabTextFormattingMetadata": {},
"sharedCustomTabsEnabled": "sample string 14",
"sharedCustomTabsMetadata": {},
"senderToChangeTabAssignmentsEnabled": "sample string 15",
"senderToChangeTabAssignmentsMetadata": {},
"tabDataLabelEnabled": "sample string 16",
"tabDataLabelMetadata": {},
"firstLastEmailTabsEnabled": "sample string 17",
"firstLastEmailTabsMetadata": {},
"calculatedFieldsEnabled": "sample string 18",
"calculatedFieldsMetadata": {},
"allowTabOrder": "sample string 19",
"allowTabOrderMetadata": {}
}'
https://domain.com/v2.1/accounts/{{accountId}}/settings/tabs
Postman Collection Item JSON
{
"name": "Modifies tab settings for specified account",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"textTabsEnabled\": \"sample string 1\",\n \"textTabsMetadata\": {\n \"rights\": \"sample string 1\",\n \"uiHint\": \"sample string 2\",\n \"uiType\": \"sample string 3\",\n \"uiOrder\": \"sample string 4\",\n \"is21CFRPart11\": \"sample string 5\",\n \"options\": [\n \"sample string 1\"\n ]\n },\n \"radioTabsEnabled\": \"sample string 2\",\n \"radioTabsMetadata\": {},\n \"checkboxTabsEnabled\": \"sample string 3\",\n \"checkboxTabsMetadata\": {},\n \"listTabsEnabled\": \"sample string 4\",\n \"listTabsMetadata\": {},\n \"approveDeclineTabsEnabled\": \"sample string 5\",\n \"approveDeclineTabsMetadata\": {},\n \"noteTabsEnabled\": \"sample string 6\",\n \"noteTabsMetadata\": {},\n \"dataFieldRegexEnabled\": \"sample string 7\",\n \"dataFieldRegexMetadata\": {},\n \"dataFieldSizeEnabled\": \"sample string 8\",\n \"dataFieldSizeMetadata\": {},\n \"tabLocationEnabled\": \"sample string 9\",\n \"tabLocationMetadata\": {},\n \"tabScaleEnabled\": \"sample string 10\",\n \"tabScaleMetadata\": {},\n \"tabLockingEnabled\": \"sample string 11\",\n \"tabLockingMetadata\": {},\n \"savingCustomTabsEnabled\": \"sample string 12\",\n \"savingCustomTabsMetadata\": {},\n \"tabTextFormattingEnabled\": \"sample string 13\",\n \"tabTextFormattingMetadata\": {},\n \"sharedCustomTabsEnabled\": \"sample string 14\",\n \"sharedCustomTabsMetadata\": {},\n \"senderToChangeTabAssignmentsEnabled\": \"sample string 15\",\n \"senderToChangeTabAssignmentsMetadata\": {},\n \"tabDataLabelEnabled\": \"sample string 16\",\n \"tabDataLabelMetadata\": {},\n \"firstLastEmailTabsEnabled\": \"sample string 17\",\n \"firstLastEmailTabsMetadata\": {},\n \"calculatedFieldsEnabled\": \"sample string 18\",\n \"calculatedFieldsMetadata\": {},\n \"allowTabOrder\": \"sample string 19\",\n \"allowTabOrderMetadata\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/settings/tabs",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"settings",
"tabs"
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}"
}
]
}
},
"response": [
]
}