Production Data Source Manager (.NET)

A production data source associates a production with a set of documents returned by a saved search. The save search is used to identify the documents to be produced for distribution to legal counsel. For general information, see Production data source on the RelativityOne Documentation site.

The Production Data Source Manager API supports the following functionality:

  • CRUD operations on data sources
  • Retrieving default field values for a data source

You can also use the Production Data Source Manager API through REST. For more information, see Production Data Source Manager (REST).

This page contains the following information:

See these related pages:

The Relativity.Productions.Client contains this API. For compatibility and package installation instructions, see Download the SDKs and NuGet packages.

Fundamentals for the Production Data Source Manager API

The Production Data Source Manager API contains the following methods, classes, and enumerations.

For reference content, see Productions API.

Create a data source

Use the CreateSingleAsync() method to add a new data source to Relativity. Pass the following arguments to this method:

  • workspaceID - the Artifact ID of the workspace containing the data source.
  • productionID - the Artifact ID of the production associated with it.
  • productionDataSource - a ProductionDataSource object specifying the properties used to create the data source.

The operation returns the Artifact ID of the new data source.

Note: You must have the permissions for working with data sources.

Read a data source

Use the ReadSingleAsync() method to retrieve a data source in a specific workspace. Pass the Artifact IDs of the workspace and the data source to this method. You can also pass an optional parameter called withPlaceholderImage to return placeholder images for a data source as follows:

  • withPlaceholderImage = true - populates values for read-only placeholder image properties on the data source. The placeholder image is available only for data sources with produced productions.
  • withPlaceholderImage = false - doesn't populate any placeholder image properties. The default setting is false.

Update a data source

Use the UpdateSingleAsync() method to modify a data source in a specific workspace. Pass the following arguments to this method:

  • workspaceID - the Artifact ID of the workspace containing the data source.
  • productionID - the Artifact ID of the production associated with it.
  • productionDataSource - a ProductionDataSource object specifying the properties that you want to update.

Delete a data source

Use the DeleteSingleAsync() method to remove a data source from Relativity. Pass the Artifact IDs of the workspace and the data source to this method.

Note: You can't delete data sources from productions already produced.

Retrieve default field values for a data source

Use the GetProductionDataSourceDefaultFieldValues() method to retrieve default field values for a data source. This method doesn't return empty or null fields.

Pass the Artifact ID of the workspace containing the data source to this method.

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.