Mass Operation Manager (.NET)

You can add mass operations to object types to further customize their behavior. When a user interacts with a mass operation, you can display a custom page or execute an event handler with specialized functionality. For general information about mass operations, see Adding a custom mass operation.

The Mass Operations Manager API includes methods for creating, reading, updating, and deleting mass operations. It also includes helper methods for retrieving information about object types that be associated with a mass operation, and available event handlers and layouts for use with a mass operation.

You can also use the service through the REST API. For more information, see Mass Operation Manager (REST).

This page contains the following information:

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

Fundamentals for managing mass operations

Click the following drop-down links to learn about the methods and classes used by the Object Type Manager and related APIs.

Guidelines for managing mass operations

Review the following guidelines for working with this service:

  • Make sure that you set the appropriate field values for the type of mass operation that you want to create.
  • Use the helper methods to retrieve object types, event handlers, and layouts available for associating with mass operation.
  • Mass operations aren't available in the admin-level context, so you must specify a workspace ID.

Note: This API does not apply to the admin workspace and any attempt to reference the admin workspace (with workspaceID of -1) will result in a response status code of 400 (bad request).

Create a mass operation

You can a create a mass operation that displays a custom page or that executes a custom event handler when a user interacts with it. For general information about mass operations, see Adding a custom mass operation.

Click the following drop-down links to view sample code for custom page and event handler mass operations.

Read a mass operation

You can retrieve basic information about a mass operation or extended information, which also includes operations that you have permissions to perform on the mass operation. If you want to return extended information, use the overloaded method by passing Boolean values set to true for additional metadata and permissions as follows:

MassOperationResponse response = await massOperationManager.ReadAsync(workspaceId, massOperationId, true, true);

Update a mass operation

You can update the properties of custom page and event handler mass operations by using the overloaded UpdateAsync() method.

You can also restrict the update of a mass operation to the date that it was last modified by passing the value of LastModifiedOn property as an argument to the overloaded UpdateAsync() method. You can get the value of this property from an MassOperationResponse object, which is returned by the ReadMassOperationAsync() method.

 

Delete a mass operation

You can remove a mass operation from object types by calling the DeleteAsync() method, and passing Artifact IDs of a workspace and a mass operation to it.

Retrieve available object types for a mass operation

You can customize object types with additional functionality by creating mass operations for them. To retrieve a list of available object types in a specific workspace, call the GetAvailableObjectTypeAsync() method.

See Create a custom page mass operation for more information on how to use this function.

Retrieve available event handlers for a mass operation

You can add an event handler for a mass operation to an object type. This event handler executes when the user executes the mass operation through the Relativity UI. You can retrieve a list of available event handlers by calling the GetAvailableEventHandlersAsync() method.

Retrieve available layouts for a mass operation

When you add a mass operation that uses an event handler to an object type, you must select a layout that displays after the user initiates the operation in the Relativity UI. You can retrieve a list of layouts available for the object type by calling the GetAvailableLayoutsAsync() 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.