Relativity.Testing.Framework.Api.Services.IWorkspaceService

IWorkspaceService

public interface IWorkspaceService

Represents the workspace API service.

Documentation

Creates the specified [Workspace](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Workspace.html). If properties are not specified in the entity, the first value found for each property will be used. It is the responsibility of the user writing/running the tests to ensure that they are adhering to all environment related best practices and rules.

Workspace CreateWithDocs(Workspace entity, int numberOfDocuments = 10)

Creates the specified [Workspace](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Workspace.html) with generated documents. If properties are not specified in the entity, the first value found for each property will be used. It is the responsibility of the user writing/running the tests to ensure that they are adhering to all environment related best practices and rules.

void Delete(int id)

Delete the [Workspace](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Workspace.html) by ArtifactID.

bool Exists(int id)

Determines whether the [Workspace](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Workspace.html) with the specified ArtifactID exists.

Workspace Get(int id)

Gets the [Workspace](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Workspace.html) by ArtifactID.

Workspace Get(string name)

Gets the [Workspace](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Workspace.html) by the specified name.

Workspace[] GetAll()

Get all [Workspace](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Workspace.html)s in the environment.

IEnumerable<Workspace> GetAllByClientName(string clientName)

Gets all [Workspace](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Workspace.html)s that are associated with the specified client.

void Update(Workspace entity)

Updates the specified [Workspace](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Workspace.html).