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.
; {
; "SandboxName": "devSandbox",
; "LicenseType": "DEVELOPER",
; "TemplateId": null,
; "HistoryDays": 0,
; "CopyChatter": false,
; "AutoActivate": false,
; "ApexClassId": null,
; "Description": "My new fresh sandbox",
; "SourceId": null
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"SandboxName","devSandbox")
CkJsonObject::ckUpdateString(json,"LicenseType","DEVELOPER")
CkJsonObject::ckUpdateNull(json,"TemplateId")
CkJsonObject::ckUpdateInt(json,"HistoryDays",0)
CkJsonObject::ckUpdateBool(json,"CopyChatter",0)
CkJsonObject::ckUpdateBool(json,"AutoActivate",0)
CkJsonObject::ckUpdateNull(json,"ApexClassId")
CkJsonObject::ckUpdateString(json,"Description","My new fresh sandbox")
CkJsonObject::ckUpdateNull(json,"SourceId")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/data/v{{version}}/tooling/sobjects/SandboxInfo","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "id": "0GQ4H000000CxSzWAK",
; "success": true,
; "errors": [
; ],
; "warnings": [
; ],
; "infos": [
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s = CkJsonObject::ckStringOf(jResp,"id")
success.i = CkJsonObject::ckBoolOf(jResp,"success")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"errors")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"warnings")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"infos")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"SandboxName": "devSandbox",
"LicenseType": "DEVELOPER",
"TemplateId": null,
"HistoryDays": 0,
"CopyChatter": false,
"AutoActivate": false,
"ApexClassId": null,
"Description": "My new fresh sandbox",
"SourceId": null
}'
https://domain.com/services/data/v{{version}}/tooling/sobjects/SandboxInfo
Postman Collection Item JSON
{
"name": "Create/Clone Sandbox",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"SandboxName\": \"devSandbox\",\n \"LicenseType\": \"DEVELOPER\",\n \"TemplateId\": null,\n \"HistoryDays\": 0,\n \"CopyChatter\": false,\n \"AutoActivate\": false,\n \"ApexClassId\": null,\n \"Description\": \"My new fresh sandbox\",\n \"SourceId\": null\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/SandboxInfo",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"sobjects",
"SandboxInfo"
]
},
"description": "Creates or clones a sandbox. If you wish to clone, fill the SourceId body field with the org Id of the source sandbox."
},
"response": [
{
"name": "Create Sandbox",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"SandboxName\": \"devSandbox\",\n \"LicenseType\": \"DEVELOPER\",\n \"TemplateId\": null,\n \"HistoryDays\": 0,\n \"CopyChatter\": false,\n \"AutoActivate\": false,\n \"ApexClassId\": null,\n \"Description\": \"My new fresh sandbox\",\n \"SourceId\": null\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/SandboxInfo",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"sobjects",
"SandboxInfo"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 11 Dec 2023 10:44:57 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Sforce-Limit-Info",
"value": "api-usage=312/15000"
},
{
"key": "Location",
"value": "/services/data/v59.0/tooling/sobjects/SandboxInfo/0GQ4H000000CxSzWAK"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"id\": \"0GQ4H000000CxSzWAK\",\n \"success\": true,\n \"errors\": [],\n \"warnings\": [],\n \"infos\": []\n}"
}
]
}
