PureBasic / Creatio API / Modify a field value of object collection instance
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.
; {
; "{{FieldName8}}": "{{FieldName6Value6}}"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"{{FieldName8}}","{{FieldName6Value6}}")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json; odata=verbose; IEEE754Compatible=true")
CkHttp::ckSetRequestHeader(http,"BPMCSRF","{{BPMCSRF}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json; odata=verbose")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PATCH","https://myserver.com/0/odata/Collection3({{ObjectId8}})",sbRequestBody,"utf-8","application/json; odata=verbose; IEEE754Compatible=true",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode <> 204
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Response Body:"
Debug CkHttpResponse::ckBodyStr(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
Debug "Success."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndProcedure
Curl Command
curl -X PATCH
-H "Accept: application/json; odata=verbose"
-H "Content-Type: application/json; odata=verbose; IEEE754Compatible=true"
-H "BPMCSRF: {{BPMCSRF}}"
-d '{
"{{FieldName8}}": "{{FieldName6Value6}}"
}'
https://myserver.com/0/odata/Collection3({{ObjectId8}})
Postman Collection Item JSON
{
"name": "Modify a field value of object collection instance",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json; odata=verbose",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json; odata=verbose; IEEE754Compatible=true",
"type": "text"
},
{
"key": "BPMCSRF",
"value": "{{BPMCSRF}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"{{FieldName8}}\": \"{{FieldName6Value6}}\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{BaseURI}}/0/odata/{{CollectionName3}}({{ObjectId8}})",
"host": [
"{{BaseURI}}"
],
"path": [
"0",
"odata",
"{{CollectionName3}}({{ObjectId8}})"
]
},
"description": "Request for modifying a field value of an object collection instance."
},
"response": [
{
"name": "[204] Modifies a field of object collection instance",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json; odata=verbose",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json; odata=verbose; IEEE754Compatible=true",
"type": "text"
},
{
"key": "BPMCSRF",
"value": "{{BPMCSRF}}",
"type": "text"
}
],
"body": {
"mode": "file",
"file": {
"src": "/C:/Users/M.Kysla/Downloads/scr_NewContactPhoto.png"
},
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://myserver.com/0/odata/Contact(4c63c8fa-467b-48a6-973f-b2069298404f)",
"protocol": "https",
"host": [
"myserver",
"com"
],
"path": [
"0",
"odata",
"Contact(4c63c8fa-467b-48a6-973f-b2069298404f)"
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}