Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel2
typeflat

...

The service root URL for OData feeds depends on your Devo domain region:

EU

https://api-eu.devo.com/odatav2/Query.svc

US

https://api-us.devo.com/odatav2/Query.svc

CA

https://api-ca.devo.com/odatav2/Query.svc

APAC

https://api-apac.devo.com/odatav2/Query.svc

What permissions do I need?

...

The following table lists the supported parameters using a feed URL for a Devo domain in the USA cloud region:


$top

Add the $top parameter to return only the first N events of the query.

Example

https://api-us.devo/odatav2/Query.svc/716ae082-4943-43b-ab3a-48940fb168ce/544dd94cfaa4e48e831f0e7e26d8fa3/query?from=2018-10-03T07:00:00&to=2018-10-04T07:10:00&$top=10


$skip

Add the $skip parameter to skip the first N events and show only the remaining ones.

Example

https://api-us.devo/odatav2/Query.svc/716ae082-4943-43b-ab3a-48940fb168ce/544dd94cfaa4e48e831f0e7e26d8fa3/query?from=2018-10-03T07:00:00&to=2018-10-04T07:10:00&$skip=9


$select

Add the $select parameter to specify the columns of the data table you want to retrieve.

Example

https://api-us.devo/odatav2/Query.svc/716ae082-4943-43b-ab3a-48940fb168ce/544dd94cfaa4e48e831f0e7e26d8fa3/query?from=2018-10-03T07:00:00&to=2018-10-04T07:10:00&$select=eventdate,cid




$format

Add the $format parameter to return the data in a specific format. The valid formats are:

  • Atom xml (default format)

  • JSON

Add =json or =xml after the parameter to indicate the format. For example: &$format=json

Example

https://api-us.devo/odatav2/Query.svc/716ae082-4943-43b-ab3a-48940fb168ce/544dd94cfaa4e48e831f0e7e26d8fa3/query?from=2018-10-03T07:00:00&to=2018-10-04T07:10:00&$format=json



timezone

Add the timezone parameter to indicate that the dates of the from and to parameters, as outlined further below, are relative to the timezone indicated. The possible values for this parameter come from an IANA standard and more information can be found here.

Example

https://api-us.devo/odatav2/Query.svc/716ae082-4943-43b-ab3a-48940fb168ce/544dd94cfaa4e48e831f0e7e26d8fa3/query?from=2018-10-03T07:00:00&to=2018-10-04T07:10:00&timezone=Europe/Madrid

Note that if no timezone is specified then UTC is always used by default. In the example provided, Madrid is UTC+2 during summertime and UTC+1 during daylight savings time. 



$metadata

Add the $metadata parameter to return only the query metadata. You cannot combine this parameter with other parameters.

To add this parameter to the OData feed URI, first remove the query time information at the end of the URL, then add the parameter without including the '&' character.

Example

https://api-us.devo/odatav2/Query.svc/716ae082-4943-43b-ab3a-48940fb168ce/544dd94cfaa4e48e831f0e7e26d8fa3/query?from=2018-10-03T07:00:00&to=2018-10-04T07:10:00$metadata

The following is an example of an OData feed with four different parameters:

...

Info

Example

Suppose the current date is 22/08/2016 15:20:00.

  • the result will be 22/08/2016 00:00:00

To (defines the end date)

  • Relative - The valid range dates you can use are days(d) and hours.

...

Info

Example

  • &from=2016-08-20T15:00:00&to=endmonth -> from 20/08/2016 15:00:00 to 01/09/2016 00:00:00

Related articles

Child pages (Children Display)