Ruby / Creatio API / Get an object collection instance by Id of another object collection instance
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
http.SetRequestHeader("ForceUseSession","true")
http.SetRequestHeader("BPMCSRF","{{BPMCSRF}}")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://myserver.com/0/odata/Collection1(Id)/Collection2",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "@odata.context": "https://myserver.com/0/odata/$metadata#Account/$entity",
# "Id": "a0bf3e92-f36b-1410-0499-00155d043204",
# "Name": "XT Group",
# "OwnerId": "cad50d15-f28d-49fc-aa79-21615ac35b86",
# "CreatedOn": "2020-01-27T08:00:14Z",
# "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
# "ModifiedOn": "2020-01-10T10:12:35Z",
# "ModifiedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
# "ProcessListeners": 0,
# "OwnershipId": "e0ae3e02-f46b-1410-fb98-00155d043204",
# "PrimaryContactId": "017df77c-b01c-4554-b7eb-760ac91cd0d7",
# "ParentId": null,
# "IndustryId": "bd7f1e4a-f36b-1410-c493-00155d043205",
# "Code": "60",
# "TypeId": "03a75490-53e6-df11-971b-001d60e938c6",
# "Phone": "+1 212 753 2819",
# "AdditionalPhone": "+1 212 753 2845",
# "Fax": "",
# "Web": "www.xtg.com",
# "AddressTypeId": "780bf68c-4b6e-df11-b988-001d60e938c6",
# "Address": "17 Road Street",
# "CityId": "c0af42ea-f36b-1410-0299-00155d043204",
# "RegionId": "00b03270-f36b-1410-fd98-00155d043204",
# "Zip": "10351",
# "CountryId": "e0be1264-f36b-1410-fa98-00155d043204",
# "AccountCategoryId": "37ea507c-55e6-df11-971b-001d60e938c6",
# "EmployeesNumberId": "2c344115-55e6-df11-971b-001d60e938c6",
# "AnnualRevenueId": "498aceb9-55e6-df11-971b-001d60e938c6",
# "Notes": "",
# "AlternativeName": "",
# "GPSN": "42.6558932018082",
# "GPSE": "-73.7562183364144",
# "Completeness": 100,
# "PriceListId": null,
# "AccountLogoId": "69517c67-e5de-47db-ae50-df69447a12cf"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
odata_context = jResp.stringOf("\"@odata.context\"")
Id = jResp.stringOf("Id")
Name = jResp.stringOf("Name")
OwnerId = jResp.stringOf("OwnerId")
CreatedOn = jResp.stringOf("CreatedOn")
CreatedById = jResp.stringOf("CreatedById")
ModifiedOn = jResp.stringOf("ModifiedOn")
ModifiedById = jResp.stringOf("ModifiedById")
ProcessListeners = jResp.IntOf("ProcessListeners")
OwnershipId = jResp.stringOf("OwnershipId")
PrimaryContactId = jResp.stringOf("PrimaryContactId")
ParentId = jResp.stringOf("ParentId")
IndustryId = jResp.stringOf("IndustryId")
Code = jResp.stringOf("Code")
TypeId = jResp.stringOf("TypeId")
Phone = jResp.stringOf("Phone")
AdditionalPhone = jResp.stringOf("AdditionalPhone")
Fax = jResp.stringOf("Fax")
Web = jResp.stringOf("Web")
AddressTypeId = jResp.stringOf("AddressTypeId")
Address = jResp.stringOf("Address")
CityId = jResp.stringOf("CityId")
RegionId = jResp.stringOf("RegionId")
v_Zip = jResp.stringOf("Zip")
CountryId = jResp.stringOf("CountryId")
AccountCategoryId = jResp.stringOf("AccountCategoryId")
EmployeesNumberId = jResp.stringOf("EmployeesNumberId")
AnnualRevenueId = jResp.stringOf("AnnualRevenueId")
Notes = jResp.stringOf("Notes")
AlternativeName = jResp.stringOf("AlternativeName")
GPSN = jResp.stringOf("GPSN")
GPSE = jResp.stringOf("GPSE")
Completeness = jResp.IntOf("Completeness")
PriceListId = jResp.stringOf("PriceListId")
AccountLogoId = jResp.stringOf("AccountLogoId")
Curl Command
curl -X GET
-H "ForceUseSession: true"
-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1(Id)/Collection2
Postman Collection Item JSON
{
"name": "Get an object collection instance by Id of another object collection instance",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "ForceUseSession",
"type": "text",
"value": "true"
},
{
"key": "BPMCSRF",
"type": "text",
"value": "{{BPMCSRF}}"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{BaseURI}}/0/odata/{{CollectionName1}}({{ObjectId1}})/{{CollectionName2}}",
"host": [
"{{BaseURI}}"
],
"path": [
"0",
"odata",
"{{CollectionName1}}({{ObjectId1}})",
"{{CollectionName2}}"
]
},
"description": "Request for getting an instance of a collection of objects by Id of an instance in another collection."
},
"response": [
{
"name": "[200] Gets an instance of a collection of objects by Id of an instance in another collection of objects",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"type": "text",
"value": "application/json"
},
{
"key": "Content-Type",
"type": "text",
"value": "application/json; charset=utf-8"
},
{
"key": "ForceUseSession",
"type": "text",
"value": "true"
},
{
"key": "BPMCSRF",
"type": "text",
"value": "{{BPMCSRF}}"
}
],
"url": {
"raw": "https://myserver.com/0/odata/Employee(c31c7862-fe33-4a13-9bbc-0943fa08fd02)/Account",
"protocol": "https",
"host": [
"myserver",
"com"
],
"path": [
"0",
"odata",
"Employee(c31c7862-fe33-4a13-9bbc-0943fa08fd02)",
"Account"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Content-Type",
"value": "application/json; odata.metadata=minimal"
},
{
"key": "Expires",
"value": "-1"
},
{
"key": "Server",
"value": "Microsoft-IIS/10.0"
},
{
"key": "OData-Version",
"value": "4.0"
},
{
"key": "X-AspNet-Version",
"value": "4.0.30319"
},
{
"key": "X-Powered-By",
"value": "ASP.NET"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Date",
"value": "Wed, 26 Feb 2020 14:50:30 GMT"
},
{
"key": "Content-Length",
"value": "1312"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://myserver.com/0/odata/$metadata#Account/$entity\",\n \"Id\": \"a0bf3e92-f36b-1410-0499-00155d043204\",\n \"Name\": \"XT Group\",\n \"OwnerId\": \"cad50d15-f28d-49fc-aa79-21615ac35b86\",\n \"CreatedOn\": \"2020-01-27T08:00:14Z\",\n \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"ModifiedOn\": \"2020-01-10T10:12:35Z\",\n \"ModifiedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"ProcessListeners\": 0,\n \"OwnershipId\": \"e0ae3e02-f46b-1410-fb98-00155d043204\",\n \"PrimaryContactId\": \"017df77c-b01c-4554-b7eb-760ac91cd0d7\",\n \"ParentId\": null,\n \"IndustryId\": \"bd7f1e4a-f36b-1410-c493-00155d043205\",\n \"Code\": \"60\",\n \"TypeId\": \"03a75490-53e6-df11-971b-001d60e938c6\",\n \"Phone\": \"+1 212 753 2819\",\n \"AdditionalPhone\": \"+1 212 753 2845\",\n \"Fax\": \"\",\n \"Web\": \"www.xtg.com\",\n \"AddressTypeId\": \"780bf68c-4b6e-df11-b988-001d60e938c6\",\n \"Address\": \"17 Road Street\",\n \"CityId\": \"c0af42ea-f36b-1410-0299-00155d043204\",\n \"RegionId\": \"00b03270-f36b-1410-fd98-00155d043204\",\n \"Zip\": \"10351\",\n \"CountryId\": \"e0be1264-f36b-1410-fa98-00155d043204\",\n \"AccountCategoryId\": \"37ea507c-55e6-df11-971b-001d60e938c6\",\n \"EmployeesNumberId\": \"2c344115-55e6-df11-971b-001d60e938c6\",\n \"AnnualRevenueId\": \"498aceb9-55e6-df11-971b-001d60e938c6\",\n \"Notes\": \"\",\n \"AlternativeName\": \"\",\n \"GPSN\": \"42.6558932018082\",\n \"GPSE\": \"-73.7562183364144\",\n \"Completeness\": 100,\n \"PriceListId\": null,\n \"AccountLogoId\": \"69517c67-e5de-47db-ae50-df69447a12cf\"\n}"
}
]
}
