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"
require 'chilkat'
rest = Chilkat::CkRest.new()
# URL: https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/accounts?$select=name
bTls = true
port = 443
bAutoReconnect = true
success = rest.Connect("my-dynamics-domain.api.crm.dynamics.com",port,bTls,bAutoReconnect)
if (success != true)
print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
print rest.lastErrorText() + "\n";
exit
end
rest.AddHeader("OData-MaxVersion","4.0")
rest.AddHeader("Accept","application/json")
rest.AddHeader("OData-Version","4.0")
rest.AddHeader("Authorization","Bearer DYNAMICS_CRM_ACCESS_TOKEN")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET","/api/data/v9.0/accounts?$select=name",sbResponseBody)
if (success != true)
print rest.lastErrorText() + "\n";
exit
end
respStatusCode = rest.get_ResponseStatusCode()
if (respStatusCode >= 400)
print "Response Status Code = " + respStatusCode.to_s() + "\n";
print "Response Header:" + "\n";
print rest.responseHeader() + "\n";
print "Response Body:" + "\n";
print sbResponseBody.getAsString() + "\n";
exit
end
jsonResponse = Chilkat::CkJsonObject.new()
jsonResponse.LoadSb(sbResponseBody)
odataContext = jsonResponse.stringOf("\"@odata.context\"")
i = 0
count_i = jsonResponse.SizeOfArray("value")
while i < count_i
jsonResponse.put_I(i)
odataEtag = jsonResponse.stringOf("value[i].\"@odata.etag\"")
name = jsonResponse.stringOf("value[i].name")
accountid = jsonResponse.stringOf("value[i].accountid")
i = i + 1
end
{
"@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"
}
]
}