The Federated Instance Manager API includes the following methods available on the IFederatedInstanceManager interface in the Relativity.Identity.<VersionNumber>.Services namespace.
The <VersionNumber> variable in the namespace indicates the version number of the API. The version number uses the format uppercase V and an integer version number, such as V1 or V2 in .NET.
- CreateAsync() method - creates new federated instance. This method takes FederatedInstance object. It returns a validation exception when the required fields are not populated or a federated instance with the same name already exists.
- DeleteAsync() method - removes a federated instance. This method takes the name of a federated instance. It returns a validation exception when the federated instance does not exist.
- ReadAllAsync() method - retrieves all federated instances defined for a Relativity instance. This method returns a IReadOnlyCollection of federated instances. If no federated instances exist, it returns an empty list.
- ReadAsync() method - retrieves a single federated instance by name. This method takes the name of an instance. It returns a FederateInstance object, or it returns a validation exception when the federated instance does not exist.
- UpdateAsync() method - modifies a federated instance. It returns a validation exception when the required fields are not populated, the federated instance does not exist, or federated instance with the name used for modifying the instance already exists.