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.
Common properties
These properties are returned in all JSON representations of DTOs:
- Workspace ID (This property is not returned for system admin-level resources such as Workspaces, Users, and so on.)
- Artifact Type Name
- Artifact Type ID
- Artifact ID
- Parent Artifact ID
- Relativity Text Identifier
- __Location
Batch
- Assigned To (Populates ArtifactID and Name on a User DTO.)
- Batch Set (Populates ArtifactID on a Batch Set DTO.)
- Batch Status (Populates ArtifactID on a Choice DTO.)
BatchSet
- Only common properties returned.
Document
- Only common properties returned.
Field
- Field Type ID
- Length
- Is Relational
- Unicode
- Keyboard Shortcut
- Object Type (Populates ArtifactID on an ObjectType DTO.)
- Associative Object Type (Populates ArtifactID on an ObjectType DTO.)
Folder
- Only common properties returned.
Group
- Group Type (Represents a specific category of users, such as System Administrators, System Group, or Everyone.)
Layout
- Object Type (Populates ArtifactID on an ObjectType DTO.)
RDO
- Only common properties returned.
User
- First Name
- Last Name
- Relativity Access
View
- ObjectType (Represents an ArtifactID on an ObjectType DTO.)
- Order
Saved search object properties
Saved search DTOs are represented by a different set of JSON properties than other Relativity DTOs. Saved search DTOs include:
AnalyticsSavedSearch
- ArtifactID
- ArtifactTypeID
- ConceptsText
- Fields
- Includes
- Keywords
- MinimumConceptRank
- Name
- Notes
- Owner
- QueryHint
- RelativityApplications
- RequiresManualRun
- Scope
- SearchContainerID
- SearchCriteria
- SearchFolders
- SearchIndexID
- SortByRank
- Sorts
- SystemCreatedBy
- SystemCreatedOn
- SystemLastModifiedBy
- SystemLastModifiedOn
dtSearch
- ArtifactID
- ArtifactTypeID
- Condition
- EnableStemming
- Fields
- FuzzinessLevel
- Includes
- Keywords
- Name
- Notes
- Owner
- QueryHint
- RelativityApplications
- RequiresManualRun
- Scope
- SearchContainerID
- SearchCriteria
- SearchFolders
- SearchIndexID
- SearchText
- SortByRank
- Sorts
- SystemCreatedBy
- SystemCreatedOn
- SystemLastModifiedBy
- SystemLastModifiedOn
KeywordSavedSearch
- ArtifactID
- ArtifactTypeID
- Condition
- Fields
- Includes
- Keywords
- Name
- Notes
- Owner
- QueryHint
- RelativityApplications
- RequiresManualRun
- Scope
- SearchContainerID
- SearchFolders
- SearchText
- SortByRank
- Sorts
- SystemCreatedBy
- SystemCreatedOn
- SystemLastModifiedBy
- SystemLastModifiedOn
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.
Field
- ArtifactID
- ViewFieldID
- Guids
- Name
Sort
- FieldIdentifier (Field object identified by name, Artifact ID, GUID, or view field ID)
- Order
- Direction
CriteriaCollection
- Conditions (a collection of Criteria or CriteriaCollection objects)
- BooleanOperator