Show TOC

 The Request Object Locate this document in the navigation structure

 

The request object defines the access to a server resource by specifying an OData service and an entity type.

A request object has the following format:

Syntax Syntax

  1. {
  2.   "type" : "request",    // optional
  3.   "id" : <id::string>
  4.   "service" : <service root>,
  5.   "entityType" : <entityTypeName>,
  6.   "selectProperties" : [ <entityTypeName>* ],
  7. }
End of the code.

The properties used in the request object denote the following:

Property

Description

id

Unique ID of type string.

service

Path to OData service root.

The service root is defined by an absolute path on the OData server according to the following pattern: <service root>: "/.../odata/<odata-service-document>"

The request and its entity type are absolute to the service root, which starts after the server and port information: [protocol]://[server]:[port]/<service root>

entityType

Accessed OData entity set.

selectProperties

Set of property names.

The selected properties determine the analytical processing, in particular, the aggregation semantics.