Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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": {}
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("textTabsEnabled","sample string 1")
loJson.UpdateString("textTabsMetadata.rights","sample string 1")
loJson.UpdateString("textTabsMetadata.uiHint","sample string 2")
loJson.UpdateString("textTabsMetadata.uiType","sample string 3")
loJson.UpdateString("textTabsMetadata.uiOrder","sample string 4")
loJson.UpdateString("textTabsMetadata.is21CFRPart11","sample string 5")
loJson.UpdateString("textTabsMetadata.options[0]","sample string 1")
loJson.UpdateString("radioTabsEnabled","sample string 2")
loJson.UpdateNewObject("radioTabsMetadata")
loJson.UpdateString("checkboxTabsEnabled","sample string 3")
loJson.UpdateNewObject("checkboxTabsMetadata")
loJson.UpdateString("listTabsEnabled","sample string 4")
loJson.UpdateNewObject("listTabsMetadata")
loJson.UpdateString("approveDeclineTabsEnabled","sample string 5")
loJson.UpdateNewObject("approveDeclineTabsMetadata")
loJson.UpdateString("noteTabsEnabled","sample string 6")
loJson.UpdateNewObject("noteTabsMetadata")
loJson.UpdateString("dataFieldRegexEnabled","sample string 7")
loJson.UpdateNewObject("dataFieldRegexMetadata")
loJson.UpdateString("dataFieldSizeEnabled","sample string 8")
loJson.UpdateNewObject("dataFieldSizeMetadata")
loJson.UpdateString("tabLocationEnabled","sample string 9")
loJson.UpdateNewObject("tabLocationMetadata")
loJson.UpdateString("tabScaleEnabled","sample string 10")
loJson.UpdateNewObject("tabScaleMetadata")
loJson.UpdateString("tabLockingEnabled","sample string 11")
loJson.UpdateNewObject("tabLockingMetadata")
loJson.UpdateString("savingCustomTabsEnabled","sample string 12")
loJson.UpdateNewObject("savingCustomTabsMetadata")
loJson.UpdateString("tabTextFormattingEnabled","sample string 13")
loJson.UpdateNewObject("tabTextFormattingMetadata")
loJson.UpdateString("sharedCustomTabsEnabled","sample string 14")
loJson.UpdateNewObject("sharedCustomTabsMetadata")
loJson.UpdateString("senderToChangeTabAssignmentsEnabled","sample string 15")
loJson.UpdateNewObject("senderToChangeTabAssignmentsMetadata")
loJson.UpdateString("tabDataLabelEnabled","sample string 16")
loJson.UpdateNewObject("tabDataLabelMetadata")
loJson.UpdateString("firstLastEmailTabsEnabled","sample string 17")
loJson.UpdateNewObject("firstLastEmailTabsMetadata")
loJson.UpdateString("calculatedFieldsEnabled","sample string 18")
loJson.UpdateNewObject("calculatedFieldsMetadata")
loJson.UpdateString("allowTabOrder","sample string 19")
loJson.UpdateNewObject("allowTabOrderMetadata")
* Adds the "Authorization: Bearer {{accessToken}}" header.
loHttp.AuthToken = "{{accessToken}}"
loHttp.SetRequestHeader("Accept","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/settings/tabs",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
CANCEL
ENDIF
? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
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}}",
"type": "string"
}
]
}
},
"response": [
]
}
