As part of the Relativity Services API (RSAPI) Deprecation, content on this page refers to outdated information about using REST APIs for the RSAPI. For more information about alternative REST APIs, see the RSAPI deprecation process.

JSON representations

The Relativity REST API uses JSON as the format for representations of DTOs returned by HTTP methods from the Services API. A JSON representation includes properties that describe a resource or collection of resources, a self link to the resource (specified in the __Location property), and links for pagination as required.

HTTP operations on a single resource return its JSON representation. When multiple objects are returned by an HTTP operation, the JSON representation includes a Results property with an array of resources.

Note: Field names used in JSON representations follow StrictMode mode conventions to ensure that resource and DTO property names match. For a list of these strings, see Constant Field names.

Default properties by resource type

All JSON representations include a specific set of common properties, as well as additional properties that are specific to each DTO type. Click a DTO type to display a list of returned properties.

Saved search object properties

Saved search DTOs are represented by a different set of JSON properties than other Relativity DTOs. Saved search DTOs include:

Note: JSON representations of the saved search DTOs are identical to the corresponding DTO properties. See AnalyticsSearch, dtSearch, and KeywordSearch for detailed property descriptions.

The JSON representation of a saved search DTO can also include objects, such as Fields, Sorts, and CriteriaCondition. Click an object type to display a list of returned properties.