The View Fields Manager service is scheduled for deprecation in the Relativity Indigo release during January 2020. Don’t implement any new custom functionality with this service and begin upgrading any applications that currently reference it. For more information, see Deprecated functionality.

View Fields Manager (REST)

A View Field is an object that contains specific information about a field. You can use the View Fields Manager service to view the relation between the Artifact IDs of View Fields objects and the Artifact IDs of a production. To learn more, visit Production overview.

The View Fields Manager service includes endpoints to retrieve View Field objects. A View Field object contains specific information about a field. This service also allows you to view the relation between View Fields and views, productions, or saved searches.

As a sample use case, you might use this service during the export process of Relativity Integration Points to retrieve all of the exportable View Fields in a workspace as well as the Artifact IDs of View Fields related to the exported view or production.

The Relativity Services API supports the same functionality for this service as available through the REST API. For more information, see View Fields Manager API.

This page contains the following information:

Client code sample

To send a request to the View Field Manager service by making a call to an endpoint with the HTTP GET method, use a URL with the following general format:

<host>/Relativity.Rest/API/Relativity.ViewFields/workspace/{workspaceID}

Read exportable View Fields in a workspace for a specific Artifact Type

View Fields allows you to see every exportable field in a specific workspace for a specific Artifact Type.

To see the View Fields, send a GET request to the following URL:

<host>/Relativity.Rest/API/Relativity.ViewFields/workspace/{workspaceID}/viewfields/readexportableviewfields/{artifactTypeID}

The JSON response contains an array of ViewFieldIDResponse objects, each one represents a single exportable field in the specified workspace.

Read View Field IDs from a production

To view the relation between the Artifact ID of a specific production and the Artifact ID of View Fields that represent the Bates fields for that production, send a GET request to the following URL:

<host>/Relativity.Rest/API/Relativity.ViewFields/workspace/{workspaceID}/viewfields/readviewfieldsidsfromproduction/{productionArtifactID}

The JSON response contains an array of ViewFieldIDResponse objects, each of them representing a View Field Artifact ID which corresponds to a Bates Field belonging to a production and its Artifact ID.

Read View Field IDs from a production

To view the relation between the Artifact ID of a specific production and the Artifact ID of View Fields that represent the Bates fields for that production, send a GET request to the following URL:

<host>/Relativity.Rest/API/Relativity.ViewFields/workspace/{workspaceID}/viewfields/readviewfieldsidsfromproduction/{artifactTypeID}/{productionArtifactID}

The ArtifactTypeID is currently unused for this request. Additionally, the body request is empty.

The JSON response contains an array of ViewFieldIDResponse objects, each of them representing a View Field Artifact ID which corresponds to a Bates Field belonging to a production and its Artifact ID.

Read View Field IDs from a saved search

To view the relations between a view, including its Artifact ID and the View Fields Artifact ID for any fields in a saved search that is associated with the view, do the following:

<host>/Relativity.Rest/API/Relativity.ViewFields/workspace/{workspaceID}/viewfields/readviewfieldsidsfromsearch/{artifactTypeID}/{viewArtifactID}

The JSON response contains an array of ViewFieldIDResponse objects, each of them representing a View Field Artifact ID belonging to a View which is also displayed with its Artifact ID.

Additional Resources

DevHelp Community GitHub Release Notes NuGet

Share knowledge with the Relativity developer community.

Access tools and resources to build an application.

Review the most recent product release notes.

Create .NET Apps faster with NuGet.