Data API
Read data from dynamics mobile portal
The Data API is intended for use by external systems for reporting and analysis purposes
It Data API has the following usage limits:
- (soft limit) up to 10 request per minute
- (hard limit) up to 6Mb per request can be returned as a response
The DATA API usage requires External Consumer Subscription. Please contact our sales teams via [email protected]
The Data API is exposed to internet and can be called via HTTPS requests by sending and receiving JSON payload.
get
https://api.portal.dynamicsmobile.com/livelink/entity/:appArea/:appCode/:entity/
query
Allows external consumers to read entity records by providing filter expressions
Example - NodeJs
Example - C# (RestSharp)
var request = require('request');
var filter=`'dateCreated ge '2020-04-01 00:00:00' and dateCreated le '2021-04-31 23:59:59'`;
var sorting = `dateCreated desc`;
var options = {
'method': 'POST',
'url': `https://api.portal.dynamicsmobile.com/livelink/entity/myapparea/MOBFL/GeoLocationEvent/query?$filter=${filter}&$orderby=${sorting}`,
'headers': {
'x-api-key': '12321313'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
const jsonResponse = response.body;
const arrayOfMobileEntities = JSON.parse(jsonResponse);
for(const eventIndex in arrayOfMobileEntities ){
const event = arrayOfMobileEntities[eventIndex];
console.log(`new mobile event on ${event.DMS_DATEMODIFIED}` );
}
//parse reponse and obtain the value if the uploadPath field.
//use it to upload the packet content via PUT request
});
var appArea = "MyAppArea";
var apiKey = "1234567890";
var filter="'dateCreated ge '2020-04-01 00:00:00' and dateCreated le '2021-04-31 23:59:59'";
var sorting = "dateCreated desc";
var client = new RestClient("https://api.portal.dynamicsmobile.com/livelink/entity"+appArea+"/MOBFL/GeoLocationEvent/query?$filter="+filter+"&$orderby="+sorting);
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", apiKey);
IRestResponse response = client.Execute(request);
var jsonContent = response.Content;
//parse the json content which contains array of entities
Check out the following additional pages:
Last modified 7mo ago