Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sHeaderName
String sHeaderValue
Integer iSequenceNumber
Boolean iAllowMergeFieldsInBody
Boolean iAllowMergeFieldsInHeader
Boolean iGenerateAuthorizationHeader
String sCalloutUrl
String sDeveloperName
String sId
String sMasterLabel
String sV_type
String sUrl
Integer i
Integer iCount_i
String sTemp1
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.
// {
// "masterLabel": "SamplePrivateLabel",
// "type": "SecuredEndpoint",
// "calloutUrl": "https://api.example.com",
// "externalCredentials": [
// {
// "developerName": "SampleExternalCredential"
// }
// ],
// "customHeaders": [
// {
// "headerName": "SampleHeader",
// "headerValue": "SampleValue",
// "sequenceNumber": 1
// }
// ],
// "calloutOptions": {
// "allowMergeFieldsInBody": false,
// "allowMergeFieldsInHeader": true,
// "generateAuthorizationHeader": true
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "masterLabel" "SamplePrivateLabel" To iSuccess
Get ComUpdateString Of hoJson "type" "SecuredEndpoint" To iSuccess
Get ComUpdateString Of hoJson "calloutUrl" "https://api.example.com" To iSuccess
Get ComUpdateString Of hoJson "externalCredentials[0].developerName" "SampleExternalCredential" To iSuccess
Get ComUpdateString Of hoJson "customHeaders[0].headerName" "SampleHeader" To iSuccess
Get ComUpdateString Of hoJson "customHeaders[0].headerValue" "SampleValue" To iSuccess
Get ComUpdateInt Of hoJson "customHeaders[0].sequenceNumber" 1 To iSuccess
Get ComUpdateBool Of hoJson "calloutOptions.allowMergeFieldsInBody" False To iSuccess
Get ComUpdateBool Of hoJson "calloutOptions.allowMergeFieldsInHeader" True To iSuccess
Get ComUpdateBool Of hoJson "calloutOptions.generateAuthorizationHeader" True To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComPTextSb Of hoHttp "PUT" "https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME" vSbRequestBody "utf-8" "application/json" False False 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 Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "calloutOptions": {
// "allowMergeFieldsInBody": false,
// "allowMergeFieldsInHeader": true,
// "generateAuthorizationHeader": true
// },
// "calloutUrl": "https://api.example.com",
// "customHeaders": [
// {
// "headerName": "SampleHeader",
// "headerValue": "SampleValue",
// "id": "0pv2o000000PAv6AAG",
// "sequenceNumber": 1
// }
// ],
// "developerName": "SamplePrivate",
// "externalCredentials": [
// {
// "developerName": "SampleExternalCredential",
// "id": "0pt2o000000CaU0AAK",
// "masterLabel": "Sample External Credential",
// "url": "/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential"
// }
// ],
// "id": "0XA2o000000XaAQGA0",
// "masterLabel": "SamplePrivateLabel",
// "parameters": [
// ],
// "type": "SecuredEndpoint",
// "url": "/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComBoolOf Of hoJResp "calloutOptions.allowMergeFieldsInBody" To iAllowMergeFieldsInBody
Get ComBoolOf Of hoJResp "calloutOptions.allowMergeFieldsInHeader" To iAllowMergeFieldsInHeader
Get ComBoolOf Of hoJResp "calloutOptions.generateAuthorizationHeader" To iGenerateAuthorizationHeader
Get ComStringOf Of hoJResp "calloutUrl" To sCalloutUrl
Get ComStringOf Of hoJResp "developerName" To sDeveloperName
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "masterLabel" To sMasterLabel
Get ComStringOf Of hoJResp "type" To sV_type
Get ComStringOf Of hoJResp "url" To sUrl
Move 0 To i
Get ComSizeOfArray Of hoJResp "customHeaders" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "customHeaders[i].headerName" To sHeaderName
Get ComStringOf Of hoJResp "customHeaders[i].headerValue" To sHeaderValue
Get ComStringOf Of hoJResp "customHeaders[i].id" To sId
Get ComIntOf Of hoJResp "customHeaders[i].sequenceNumber" To iSequenceNumber
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "externalCredentials" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "externalCredentials[i].developerName" To sDeveloperName
Get ComStringOf Of hoJResp "externalCredentials[i].id" To sId
Get ComStringOf Of hoJResp "externalCredentials[i].masterLabel" To sMasterLabel
Get ComStringOf Of hoJResp "externalCredentials[i].url" To sUrl
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "parameters" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"masterLabel": "SamplePrivateLabel",
"type": "SecuredEndpoint",
"calloutUrl": "https://api.example.com",
"externalCredentials": [
{
"developerName": "SampleExternalCredential"
}
],
"customHeaders": [
{
"headerName": "SampleHeader",
"headerValue": "SampleValue",
"sequenceNumber": 1
}
],
"calloutOptions": {
"allowMergeFieldsInBody": false,
"allowMergeFieldsInHeader": true,
"generateAuthorizationHeader": true
}
}'
https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME
Postman Collection Item JSON
{
"name": "Update Named Credential",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"masterLabel\": \"SamplePrivateLabel\",\n \"type\": \"SecuredEndpoint\",\n \"calloutUrl\": \"https://api.example.com\",\n \"externalCredentials\": [\n {\n \"developerName\": \"SampleExternalCredential\"\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleValue\",\n \"sequenceNumber\": 1\n }\n ],\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": true,\n \"generateAuthorizationHeader\": true\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"named-credential-setup",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": ""
}
]
},
"description": "Update a named credential."
},
"response": [
{
"name": "Successful Update Named Credential",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"masterLabel\": \"SamplePrivateLabel\",\n \"type\": \"SecuredEndpoint\",\n \"calloutUrl\": \"https://api.example.com\",\n \"externalCredentials\": [\n {\n \"developerName\": \"SampleExternalCredential\"\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleValue\",\n \"sequenceNumber\": 1\n }\n ],\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": true,\n \"generateAuthorizationHeader\": true\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"named-credentials",
"named-credential-setup",
":DEVELOPER_NAME"
],
"variable": [
{
"key": "DEVELOPER_NAME",
"value": "SamplePrivate"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:54:57 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": true,\n \"generateAuthorizationHeader\": true\n },\n \"calloutUrl\": \"https://api.example.com\",\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleValue\",\n \"id\": \"0pv2o000000PAv6AAG\",\n \"sequenceNumber\": 1\n }\n ],\n \"developerName\": \"SamplePrivate\",\n \"externalCredentials\": [\n {\n \"developerName\": \"SampleExternalCredential\",\n \"id\": \"0pt2o000000CaU0AAK\",\n \"masterLabel\": \"Sample External Credential\",\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n }\n ],\n \"id\": \"0XA2o000000XaAQGA0\",\n \"masterLabel\": \"SamplePrivateLabel\",\n \"parameters\": [],\n \"type\": \"SecuredEndpoint\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate\"\n}"
}
]
}
