Foxpro / Creatio API / Get an object collection instance by Id
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcOdata_context
LOCAL lcId
LOCAL lcCreatedOn
LOCAL lcCreatedById
LOCAL lcModifiedOn
LOCAL lcModifiedById
LOCAL lnProcessListeners
LOCAL lcContactId
LOCAL lcName
LOCAL lcOrgStructureUnitId
LOCAL lcNotes
LOCAL lcJobId
LOCAL lcFullJobTitle
LOCAL lcOwnerId
LOCAL lcCareerStartDate
LOCAL lcCareerDueDate
LOCAL lcProbationDueDate
LOCAL lcReasonForDismissalId
LOCAL lcAccountId
LOCAL lcManagerId
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.SetRequestHeader("ForceUseSession","true")
loHttp.SetRequestHeader("BPMCSRF","{{BPMCSRF}}")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://myserver.com/0/odata/Collection1(Id)",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "@odata.context": "https://myserver.com/0/odata/$metadata#Employee/$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"
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcOdata_context = loJResp.StringOf('"@odata.context"')
lcId = loJResp.StringOf("Id")
lcCreatedOn = loJResp.StringOf("CreatedOn")
lcCreatedById = loJResp.StringOf("CreatedById")
lcModifiedOn = loJResp.StringOf("ModifiedOn")
lcModifiedById = loJResp.StringOf("ModifiedById")
lnProcessListeners = loJResp.IntOf("ProcessListeners")
lcContactId = loJResp.StringOf("ContactId")
lcName = loJResp.StringOf("Name")
lcOrgStructureUnitId = loJResp.StringOf("OrgStructureUnitId")
lcNotes = loJResp.StringOf("Notes")
lcJobId = loJResp.StringOf("JobId")
lcFullJobTitle = loJResp.StringOf("FullJobTitle")
lcOwnerId = loJResp.StringOf("OwnerId")
lcCareerStartDate = loJResp.StringOf("CareerStartDate")
lcCareerDueDate = loJResp.StringOf("CareerDueDate")
lcProbationDueDate = loJResp.StringOf("ProbationDueDate")
lcReasonForDismissalId = loJResp.StringOf("ReasonForDismissalId")
lcAccountId = loJResp.StringOf("AccountId")
lcManagerId = loJResp.StringOf("ManagerId")
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X GET
-H "ForceUseSession: true"
-H "BPMCSRF: {{BPMCSRF}}"
https://myserver.com/0/odata/Collection1(Id)
Postman Collection Item JSON
{
"name": "Get an object collection instance by Id",
"request": {
"method": "GET",
"header": [
{
"key": "ForceUseSession",
"type": "text",
"value": "true"
},
{
"key": "BPMCSRF",
"type": "text",
"value": "{{BPMCSRF}}"
}
],
"url": {
"raw": "{{BaseURI}}/0/odata/{{CollectionName1}}({{ObjectId1}})",
"host": [
"{{BaseURI}}"
],
"path": [
"0",
"odata",
"{{CollectionName1}}({{ObjectId1}})"
]
},
"description": "Request for getting an object collection instance by Id."
},
"response": [
{
"name": "[200] Gets objects collection instance by Id",
"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)",
"protocol": "https",
"host": [
"myserver",
"com"
],
"path": [
"0",
"odata",
"Employee(c31c7862-fe33-4a13-9bbc-0943fa08fd02)"
]
}
},
"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:08 GMT"
},
{
"key": "Content-Length",
"value": "877"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://myserver.com/0/odata/$metadata#Employee/$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}"
}
]
}
