Show/Hide Toolbars

TMS XData Documentation

Navigation: Requesting Data

HTTP Request Headers

Scroll Prev Top Next More

XData defines semantics around the following HTTP request and response headers. Additional headers may be specified, but have no unique semantics defined in XData.

 

Available Request Headers

 

Name

Description

xdata-expand-level

Clients can optionally include this header in the request to define the maximum depth for which the associated entities will be expanded (serialized inline) in an entity JSON representation.

 

xdata-expand-level: 3

 

An associated entity (navigation property) can be represented as an association reference, or inline object. If XData-ExpandLevel is not present, the value 0 (zero) is assumed, which means all direct associated entities will be represented as references. When the header is present and value is higher, then all associated entities will be serialized inline, until the depth level specified by the header. The higher the expand level, the bigger the response payload will be, since more objects will be serialized. But if client will need those objects anyway, this will minimize the need of further server requests to retrieve associated objects. Proxies are not affected by this.

 

xdata-put-mode

Overrides the value of TXDataServerModule.PutMode property for the request. Please refer to the property documentation for more info. Example:

 

xdata-put-mode: update

 

Valid values are "update" and "merge".

 

xdata-serialize-instance-ref

Overrides the value of TXDataServerModule.SerializeInstanceRef property for the request. Please refer to the property documentation for more info. Example:

 

xdata-serialize-instance-ref: ifrecursive

 

Valid values are "always" and "ifrecursive".

 

xdata-serialize-instance-type

Overrides the value of TXDataServerModule.SerializeInstanceType property for the request. Please refer to the property documentation for more info. Example:

 

xdata-serialize-instance-type: ifneeded

 

Valid values are "always" and "ifneeded".