This example queries the accounts entity set and uses the $select system query option to return the name property for each account.
curl -X GET https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/accounts?$select=name \
-H "Accept: application/json" \
-H "OData-MaxVersion: 4.0" \
-H "OData-Version: 4.0" \
-H "Authorization: Bearer DYNAMICS_CRM_ACCESS_TOKEN"IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
Procedure ChilkatExample()
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; URL: https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/accounts?$select=name
bTls.i = 1
port.i = 443
bAutoReconnect.i = 1
success = CkRest::ckConnect(rest,"my-dynamics-domain.api.crm.dynamics.com",port,bTls,bAutoReconnect)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
ProcedureReturn
EndIf
CkRest::ckAddHeader(rest,"OData-MaxVersion","4.0")
CkRest::ckAddHeader(rest,"Accept","application/json")
CkRest::ckAddHeader(rest,"OData-Version","4.0")
CkRest::ckAddHeader(rest,"Authorization","Bearer DYNAMICS_CRM_ACCESS_TOKEN")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestNoBodySb(rest,"GET","/api/data/v9.0/accounts?$select=name",sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
If respStatusCode >= 400
Debug "Response Status Code = " + Str(respStatusCode)
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jsonResponse.i = CkJsonObject::ckCreate()
If jsonResponse.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jsonResponse,sbResponseBody)
i.i
count_i.i
odataContext.s = CkJsonObject::ckStringOf(jsonResponse,Chr(34) + "@odata.context" + Chr(34))
i = 0
count_i = CkJsonObject::ckSizeOfArray(jsonResponse,"value")
While i < count_i
CkJsonObject::setCkI(jsonResponse, i)
odataEtag.s = CkJsonObject::ckStringOf(jsonResponse,"value[i]." + Chr(34) + "@odata.etag" + Chr(34))
name.s = CkJsonObject::ckStringOf(jsonResponse,"value[i].name")
accountid.s = CkJsonObject::ckStringOf(jsonResponse,"value[i].accountid")
i = i + 1
Wend
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jsonResponse)
ProcedureReturn
EndProcedure
{
"@odata.context": "https://mydomain.api.crm.dynamics.com/api/data/v8.2/$metadata#accounts(name)",
"value": [
{
"@odata.etag": "W/\"1817213\"",
"name": "A. Datum",
"accountid": "475b158c-541c-e511-80d3-3863bb347ba8"
},
{
"@odata.etag": "W/\"1817214\"",
"name": "Adventure Works",
"accountid": "a8a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817215\"",
"name": "Alpine Ski House",
"accountid": "aaa19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817216\"",
"name": "Blue Yonder Airlines",
"accountid": "aca19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817217\"",
"name": "City Power & Light",
"accountid": "aea19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817218\"",
"name": "Coho Winery",
"accountid": "b0a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817219\"",
"name": "Consolidated Messenger",
"accountid": "b2a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817220\"",
"name": "Fabrikam, Inc.",
"accountid": "b4a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817221\"",
"name": "Fourth Coffee",
"accountid": "b6a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817222\"",
"name": "Graphic Design Institute",
"accountid": "b8a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817223\"",
"name": "Humongous Insurance",
"accountid": "baa19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817224\"",
"name": "Litware",
"accountid": "bca19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817225\"",
"name": "Lucerne Publishing",
"accountid": "bea19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817226\"",
"name": "Margie's Travel",
"accountid": "c0a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817227\"",
"name": "Northwind Traders",
"accountid": "c2a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817228\"",
"name": "Proseware, Inc.",
"accountid": "c4a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817229\"",
"name": "School of Fine Art",
"accountid": "c6a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817230\"",
"name": "Southridge Video",
"accountid": "c8a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817231\"",
"name": "Tailspin Toys",
"accountid": "caa19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817232\"",
"name": "The Phone Company",
"accountid": "cca19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817233\"",
"name": "Trey Research",
"accountid": "cea19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817234\"",
"name": "Wide World Importers",
"accountid": "d0a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817235\"",
"name": "Wingtip Toys",
"accountid": "d2a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817236\"",
"name": "Woodgrove Bank",
"accountid": "d4a19cdd-88df-e311-b8e5-6c3be5a8b200"
},
{
"@odata.etag": "W/\"1817237\"",
"name": "Best o' Sales",
"accountid": "2123455d-be62-e411-80d6-b4b52f567ec8"
},
{
"@odata.etag": "W/\"1817238\"",
"name": "Microsoft",
"accountid": "d3ae1b3a-8bd2-e411-80ef-c4346bac7be8"
}
]
}