Query APIs

The REST APIs to work with queries and get query results.

The tables below indicate the 4.0 and/or 4.1 release in which support for the API was introduced.

Base URL: http://<server_name>:6405/biprws/sl/v1

Path parameters:

  • <queryID>: query statement identifier retrieved from the list of queries
  • <flowName>: query flow name
  • <rowIndex>: row index of the query flow
  • <fieldName>: name of an object of the flow

Query parameters: see the detailed description of the related API.

Action Method URL Since
Getting the List of Parameters GET /queries/<queryID>/parameters 4.1 SP3
Responding to Parameters PUT /queries/<queryID>/parameters 4.1 SP3
Action Method URL Since
Creating a Query POST /queries 4.1 SP2
Deleting a Query DELETE /queries/<queryID> 4.1 SP2
Getting the Details of a Query GET /queries/<queryID> 4.1 SP2
Getting the List of Queries GET /queries 4.1 SP2
Action Method URL Since
Accessing the OData Service GET /queries/<queryID>/data.svc/ 4.1 SP2
Getting the OData Flow Metadata GET /queries/<queryID>/data.svc/$metadata 4.1 SP2
Getting the OData Flow Content GET /queries/<queryID>/data.svc/<flowName> 4.1 SP2
OData Content - Getting the Row Count GET /queries/<queryID>/data.svc/<flowName>/$count 4.1 SP2
OData Content - Getting the First Row GET /queries/<queryID>/data.svc/<flowName>(<rowIndex>) 4.1 SP2
OData Content - Getting Property Content GET /queries/<queryID>/data.svc/<flowName>(<rowIndex>)/<fieldName> 4.1 SP2
OData Content - Getting Property Raw Content GET /queries/<queryID>/data.svc/<flowName>(<rowIndex>)/<fieldName>/$value 4.1 SP2
OData Content - Getting Content After Offset GET /queries/<queryID>/data.svc/<flowName>?$skip=<offset> 4.1 SP2
OData Content - Getting the First N Rows GET /queries/<queryID>/data.svc/<flowName>?$top=<limit> 4.1 SP2
OData Content - Getting the First N Rows After Offset GET /queries/<queryID>/data.svc/<flowName>?$skip=<offset>&$top=<limit> 4.1 SP2