Getting the OData Flow Content

Usage

Returns the data of the specified flow.

Note The OData service cannot return data page by page.
Request

GET /queries/<queryID>/data.svc/<flowName>

Response

Response type: application/xml or application/json

The data of a flow is represented by an Atom feed or an array of JSON objects.

Aside from a series of elements generated automatically (title, updated, author, link, and so on), the <feed> has the following children:

  • <id>, which contains the request URL for the specified flow
  • A series of <entry>, which represents a row of the flow

Aside from generated elements, an <entry> has the following children:

  • <id>, which contains the request URL for a row specified by <rowIndex> (/queries/<queryID>/data.svc/<flowName>(<rowIndex>)). Row indexes are generated automatically.
  • <content>, which contains the data.

The data appears in the <m:properties> tag. This tag has as many children as the query contains metadata. The tag name of each child is <d:name>, where name is a label returned by the OData flow metadata. See Getting the OData Flow Metadata.

Specifying the Request

You can add several parameters to the request to get particular results. The following table describes the possible requests and the type and meaning of the corresponding responses. These parameters are optional. See examples in the next sections.

Request Response Description Response Type

/queries/<queryID>/data.svc/<flowName>/$count

The count of records for the specified query flow.

application/text

/queries/<queryID>/data.svc/<flowName>(<rowIndex>)

A row at the <rowIndex> index for the specified query flow.

<rowIndex> is an integer.

  • application/xml
  • application/json

/queries/<queryID>/data.svc/<flowName>(<rowIndex>)/<fieldName>

Information about an object specified by <fieldName> from the row at <rowIndex> index in the specified query flow.

<fieldName> corresponds to the Property name.

  • application/xml
  • application/json

/queries/<queryID>/data.svc/<flowName>(<rowIndex>)/<fieldName>/$value

The raw value of an object specified by <fieldName> from the row at <rowIndex> in the specified query flow.

application/text

/queries/<queryID>/data.svc/<flowName>?$skip=<offset>

Query results in chunks, starting with the record number specified by the <offset> position in the specified query flow.

  • application/xml
  • application/json

/queries/<queryID>/data.svc/<flowName>?$top=<limit>

The first <limit> records in chunks of the specified query flow.

  • application/xml
  • application/json

/queries/<queryID>/data.svc/<flowName>?$skip=<offset>&$top=<limit>

The first <limit> records in chunks, starting with the record number specified by the <offset> position in the specified query flow.

  • application/xml
  • application/json