PowerBuilder / Creatio API / $expand parameter
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Odata_context
string ls_Id
string ls_CreatedOn
string ls_CreatedById
string ls_ModifiedOn
string ls_ModifiedById
integer li_ProcessListeners
string ls_ContactId
string ls_Name
string ls_OrgStructureUnitId
string ls_Notes
string ls_JobId
string ls_FullJobTitle
string ls_OwnerId
string ls_CareerStartDate
string ls_CareerDueDate
string ls_ProbationDueDate
string ls_ReasonForDismissalId
string ls_AccountId
string ls_ManagerId
string ls_AccountName
string ls_AccountOwnerId
string ls_AccountCreatedOn
string ls_AccountCreatedById
string ls_AccountModifiedOn
string ls_AccountModifiedById
integer li_AccountProcessListeners
string ls_OwnershipId
string ls_PrimaryContactId
string ls_ParentId
string ls_IndustryId
string ls_Code
string ls_TypeId
string ls_Phone
string ls_AdditionalPhone
string ls_Fax
string ls_Web
string ls_AddressTypeId
string ls_Address
string ls_CityId
string ls_RegionId
string ls_V_Zip
string ls_CountryId
string ls_AccountCategoryId
string ls_EmployeesNumberId
string ls_AnnualRevenueId
string ls_AccountNotes
string ls_AlternativeName
string ls_GPSN
string ls_GPSE
integer li_Completeness
string ls_PriceListId
string ls_AccountLogoId
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("$expand","Collection2")
loo_Http.SetRequestHeader("ForceUseSession","true")
loo_Http.SetRequestHeader("BPMCSRF","{{BPMCSRF}}")
loo_Resp = loo_Http.QuickRequestParams("GET","https://myserver.com/0/odata/Collection1(Id)",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "@odata.context": "https://myserver.com/0/odata/$metadata#Employee(Account())/$entity",
// "Id": "c31c7862-fe33-4a13-9bbc-0943fa08fd02",
// "CreatedOn": "2017-03-30T14:50:04Z",
// "CreatedById": "76929f8c-7e15-4c64-bdb0-adc62d383727",
// "ModifiedOn": "2020-02-14T06:30:46.234Z",
// "ModifiedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
// "ProcessListeners": 0,
// "ContactId": "227aab3b-7c0c-4181-abf9-81585563ab23",
// "Name": "William Walker",
// "OrgStructureUnitId": "d436a9ce-9690-4415-9e03-e8061d7cabb5",
// "Notes": "",
// "JobId": "11d68189-ced6-df11-9b2a-001d60e938c6",
// "FullJobTitle": "Developer",
// "OwnerId": "76929f8c-7e15-4c64-bdb0-adc62d383727",
// "CareerStartDate": "2019-09-08T00:00:00Z",
// "CareerDueDate": "0001-01-01T00:00:00Z",
// "ProbationDueDate": "2020-01-09T00:00:00Z",
// "ReasonForDismissalId": "00000000-0000-0000-0000-000000000000",
// "AccountId": "a0bf3e92-f36b-1410-0499-00155d043204",
// "ManagerId": "3e5bd47e-1ebd-41db-a9a6-a3560dcee3cb",
// "Account": {
// "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": "00000000-0000-0000-0000-000000000000",
// "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": "00000000-0000-0000-0000-000000000000",
// "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
ls_Odata_context = loo_JResp.StringOf("~"@odata.context~"")
ls_Id = loo_JResp.StringOf("Id")
ls_CreatedOn = loo_JResp.StringOf("CreatedOn")
ls_CreatedById = loo_JResp.StringOf("CreatedById")
ls_ModifiedOn = loo_JResp.StringOf("ModifiedOn")
ls_ModifiedById = loo_JResp.StringOf("ModifiedById")
li_ProcessListeners = loo_JResp.IntOf("ProcessListeners")
ls_ContactId = loo_JResp.StringOf("ContactId")
ls_Name = loo_JResp.StringOf("Name")
ls_OrgStructureUnitId = loo_JResp.StringOf("OrgStructureUnitId")
ls_Notes = loo_JResp.StringOf("Notes")
ls_JobId = loo_JResp.StringOf("JobId")
ls_FullJobTitle = loo_JResp.StringOf("FullJobTitle")
ls_OwnerId = loo_JResp.StringOf("OwnerId")
ls_CareerStartDate = loo_JResp.StringOf("CareerStartDate")
ls_CareerDueDate = loo_JResp.StringOf("CareerDueDate")
ls_ProbationDueDate = loo_JResp.StringOf("ProbationDueDate")
ls_ReasonForDismissalId = loo_JResp.StringOf("ReasonForDismissalId")
ls_AccountId = loo_JResp.StringOf("AccountId")
ls_ManagerId = loo_JResp.StringOf("ManagerId")
ls_AccountId = loo_JResp.StringOf("Account.Id")
ls_AccountName = loo_JResp.StringOf("Account.Name")
ls_AccountOwnerId = loo_JResp.StringOf("Account.OwnerId")
ls_AccountCreatedOn = loo_JResp.StringOf("Account.CreatedOn")
ls_AccountCreatedById = loo_JResp.StringOf("Account.CreatedById")
ls_AccountModifiedOn = loo_JResp.StringOf("Account.ModifiedOn")
ls_AccountModifiedById = loo_JResp.StringOf("Account.ModifiedById")
li_AccountProcessListeners = loo_JResp.IntOf("Account.ProcessListeners")
ls_OwnershipId = loo_JResp.StringOf("Account.OwnershipId")
ls_PrimaryContactId = loo_JResp.StringOf("Account.PrimaryContactId")
ls_ParentId = loo_JResp.StringOf("Account.ParentId")
ls_IndustryId = loo_JResp.StringOf("Account.IndustryId")
ls_Code = loo_JResp.StringOf("Account.Code")
ls_TypeId = loo_JResp.StringOf("Account.TypeId")
ls_Phone = loo_JResp.StringOf("Account.Phone")
ls_AdditionalPhone = loo_JResp.StringOf("Account.AdditionalPhone")
ls_Fax = loo_JResp.StringOf("Account.Fax")
ls_Web = loo_JResp.StringOf("Account.Web")
ls_AddressTypeId = loo_JResp.StringOf("Account.AddressTypeId")
ls_Address = loo_JResp.StringOf("Account.Address")
ls_CityId = loo_JResp.StringOf("Account.CityId")
ls_RegionId = loo_JResp.StringOf("Account.RegionId")
ls_V_Zip = loo_JResp.StringOf("Account.Zip")
ls_CountryId = loo_JResp.StringOf("Account.CountryId")
ls_AccountCategoryId = loo_JResp.StringOf("Account.AccountCategoryId")
ls_EmployeesNumberId = loo_JResp.StringOf("Account.EmployeesNumberId")
ls_AnnualRevenueId = loo_JResp.StringOf("Account.AnnualRevenueId")
ls_AccountNotes = loo_JResp.StringOf("Account.Notes")
ls_AlternativeName = loo_JResp.StringOf("Account.AlternativeName")
ls_GPSN = loo_JResp.StringOf("Account.GPSN")
ls_GPSE = loo_JResp.StringOf("Account.GPSE")
li_Completeness = loo_JResp.IntOf("Account.Completeness")
ls_PriceListId = loo_JResp.StringOf("Account.PriceListId")
ls_AccountLogoId = loo_JResp.StringOf("Account.AccountLogoId")
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -G -d "$expand=Collection2"
-H "ForceUseSession: true"
-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1(Id)
Postman Collection Item JSON
{
"name": "$expand parameter",
"request": {
"method": "GET",
"header": [
{
"key": "ForceUseSession",
"type": "text",
"value": "true"
},
{
"key": "BPMCSRF",
"type": "text",
"value": "{{BPMCSRF}}"
}
],
"url": {
"raw": "{{BaseURI}}/0/odata/{{CollectionName1}}({{ObjectId1}})?$expand={{CollectionName2}}",
"host": [
"{{BaseURI}}"
],
"path": [
"0",
"odata",
"{{CollectionName1}}({{ObjectId1}})"
],
"query": [
{
"key": "$expand",
"value": "{{CollectionName2}}"
}
]
},
"description": "Request for getting an object collection instance by instance Id of another object collection via the [$expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_SystemQueryOptionexpand) parameter."
},
"response": [
{
"name": "[200] Gets an objects collection instances by another object collection",
"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)?$expand=Account",
"protocol": "https",
"host": [
"myserver",
"com"
],
"path": [
"0",
"odata",
"Employee(c31c7862-fe33-4a13-9bbc-0943fa08fd02)"
],
"query": [
{
"key": "$expand",
"value": "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:52:02 GMT"
},
{
"key": "Content-Length",
"value": "2206"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://myserver.com/0/odata/$metadata#Employee(Account())/$entity\",\n \"Id\": \"c31c7862-fe33-4a13-9bbc-0943fa08fd02\",\n \"CreatedOn\": \"2017-03-30T14:50:04Z\",\n \"CreatedById\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"ModifiedOn\": \"2020-02-14T06:30:46.234Z\",\n \"ModifiedById\": \"410006e1-ca4e-4502-a9ec-e54d922d2c00\",\n \"ProcessListeners\": 0,\n \"ContactId\": \"227aab3b-7c0c-4181-abf9-81585563ab23\",\n \"Name\": \"William Walker\",\n \"OrgStructureUnitId\": \"d436a9ce-9690-4415-9e03-e8061d7cabb5\",\n \"Notes\": \"\",\n \"JobId\": \"11d68189-ced6-df11-9b2a-001d60e938c6\",\n \"FullJobTitle\": \"Developer\",\n \"OwnerId\": \"76929f8c-7e15-4c64-bdb0-adc62d383727\",\n \"CareerStartDate\": \"2019-09-08T00:00:00Z\",\n \"CareerDueDate\": \"0001-01-01T00:00:00Z\",\n \"ProbationDueDate\": \"2020-01-09T00:00:00Z\",\n \"ReasonForDismissalId\": \"00000000-0000-0000-0000-000000000000\",\n \"AccountId\": \"a0bf3e92-f36b-1410-0499-00155d043204\",\n \"ManagerId\": \"3e5bd47e-1ebd-41db-a9a6-a3560dcee3cb\",\n \"Account\": {\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\": \"00000000-0000-0000-0000-000000000000\",\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\": \"00000000-0000-0000-0000-000000000000\",\n \"AccountLogoId\": \"69517c67-e5de-47db-ae50-df69447a12cf\"\n }\n}"
}
]
}
