Cegid Docs Service (DAS) Client Library

Document management service, including tax or fiscal relevancy rules and validations.

REST Service Client

Client Controllers

Models

Enumerations

Authorization Policies

Reference

REST Service Client Classes

DigitalArchiveClient

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: DigitalArchiveClientBase (RestServiceClient)

Constructors

DigitalArchiveClient(Uri, BearerTokenCredential)

DigitalArchiveClient(Uri, BearerTokenCredential, DigitalArchiveClientOptions)

Example

Uri address = new Uri("[service-address]");
Uri authorizationServer = new Uri("[authorization-server]");
string clientId = "[client-id]"
string clientSecret = "[client-secret]"

DigitalArchiveClient client = new DigitalArchiveClient(
    new Uri(address),
    new ClientSecretCredential(
        authorizationServer,
        clientId,
        clientSecret));

^ Back to top

Client Controllers Classes

ArchivesClientController

Provides operations on archives.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: ArchivesClientControllerBase (IArchivesClientController)

Methods

ChangeStatusAsync()

Action responsible for validating and updating status of a list of documents.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkMessageInfo>> ChangeStatusAsync(string workspace, string organization, string appInstance, string containerKey, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.AccountingDocumentData> accountingDocuments, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkMessageInfo> ChangeStatus(string workspace, string organization, string appInstance, string containerKey, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.AccountingDocumentData> accountingDocuments);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Action responsible for deleting a document. Soft delete only flags the document, while hard deletes permanently.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkMessageInfo>> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentsBulkData> documents, bool? soft = true, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkMessageInfo> Delete(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentsBulkData> documents, bool? soft = true);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ExportAsync()

Action responsible for exporting container documents.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.MessageInfo>> ExportAsync(string workspace, string organization, string appInstance, string containerKey, int assignment, int startPeriod, int endPeriod, string email, bool isFullExport = false, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.MessageInfo> Export(string workspace, string organization, string appInstance, string containerKey, int assignment, int startPeriod, int endPeriod, string email, bool isFullExport = false);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAsync()

Action responsible for returning a document with metadata information.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentData>> GetAsync(string workspace, string organization, string appInstance, string containerKey, string id, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentData> Get(string workspace, string organization, string appInstance, string containerKey, string id);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAllAsync()

Action responsible for returning a list of documents. The query parameters should follow OData format.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentData>>> GetAllAsync(string workspace, string organization, string appInstance, string? containerKey, string? filter, string? orderBy, string? distinctBy, string? select, int skip, int top, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentData>> GetAll(string workspace, string organization, string appInstance, string? containerKey, string? filter, string? orderBy, string? distinctBy, string? select, int skip, int top);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetFavoritesAsync()

Action responsible for returning a list of documents markd as favorite by a specific user. The query parameters should follow OData format.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.FavoriteEntry>>> GetFavoritesAsync(string workspace, string organization, string appInstance, string user, string? containerKey, string? filter, string? orderBy, string? distinctBy, int skip, int top, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.FavoriteEntry>> GetFavorites(string workspace, string organization, string appInstance, string user, string? containerKey, string? filter, string? orderBy, string? distinctBy, int skip, int top);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetFileAsync()

Action responsible for returning a document file.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.File>> GetFileAsync(string workspace, string organization, string appInstance, string containerKey, string id, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.File> GetFile(string workspace, string organization, string appInstance, string containerKey, string id);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

MoveDocumentsAsync()

Action responsible to move documents between folders.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> MoveDocumentsAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkDocumentMove> documents, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> MoveDocuments(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkDocumentMove> documents);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SetFavoriteDocumentsAsync()

Action responsible for updating document properties based on a key/value list.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> SetFavoriteDocumentsAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkFavorite> userFavorites, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> SetFavoriteDocuments(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkFavorite> userFavorites);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Action responsible for updating properties of a list of documents.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.MessageInfo>> UpdateAsync(string workspace, string organization, string appInstance, string containerKey, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentData> documents, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.MessageInfo> Update(string workspace, string organization, string appInstance, string containerKey, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentData> documents);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateByPropertyAsync()

Action responsible for updating document properties based on a key/value list.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult> UpdateByPropertyAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.KeyValueDocument> documents, CancellationToken cancellationToken = default);

public RestServiceResult UpdateByProperty(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.KeyValueDocument> documents);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UploadAsync()

Action responsible for uploading a list of documents to a container.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkUploadMessage>> UploadAsync(string workspace, string organization, string appInstance, string containerKey, string? smartFolderKey, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkUploadMessage> Upload(string workspace, string organization, string appInstance, string containerKey, string? smartFolderKey);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

The class includes custom methods not described here.

ContactsClientController

Provides operations on contacts.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: ContactsClientControllerBase (IContactsClientController)

Methods

CreateAsync()

Action responsible for adding whitelist contacts to containers.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult> CreateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkContact> contacts, CancellationToken cancellationToken = default);

public RestServiceResult Create(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkContact> contacts);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Action responsible for deleting containers whitelist contacts.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkDeleteContact> contacts, CancellationToken cancellationToken = default);

public RestServiceResult Delete(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkDeleteContact> contacts);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAllAsync()

Action responsible for returning a list of whitelist contacts.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.Contact>>> GetAllAsync(string workspace, string organization, string appInstance, int pageIndex, int pageSize, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.Contact>> GetAll(string workspace, string organization, string appInstance, int pageIndex, int pageSize);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAllByContainerAsync()

Action responsible for returning a list of whitelist contacts from a container.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.Contact>>> GetAllByContainerAsync(string workspace, string organization, string appInstance, string containerKey, int pageIndex, int pageSize, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.Contact>> GetAllByContainer(string workspace, string organization, string appInstance, string containerKey, int pageIndex, int pageSize);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ContainersClientController

Provides operations on containers.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: ContainersClientControllerBase (IContainersClientController)

Methods

CreateAsync()

Action responsible for creating a list of containers.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Guid>> CreateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CompanyData> containers, CancellationToken cancellationToken = default);

public RestServiceResult<System.Guid> Create(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CompanyData> containers);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Action responsible for deleting a list of containers.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkContainerResponse>>> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> containers, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkContainerResponse>> Delete(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> containers);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAsync()

Action responsible for returning a container.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ContainerInfo>> GetAsync(string workspace, string organization, string appInstance, string containerKey, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ContainerInfo> Get(string workspace, string organization, string appInstance, string containerKey);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAllAsync()

Action responsible for returning a list of containers. The query parameters should follow OData format.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ContainerInfo>>> GetAllAsync(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, string? select, int skip, int top, bool? ignoreAccesses = false, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ContainerInfo>> GetAll(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, string? select, int skip, int top, bool? ignoreAccesses = false);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Action responsible for updating a list of containers.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkContainerResponse>>> UpdateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.UpdateCompanyData> containers, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkContainerResponse>> Update(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.UpdateCompanyData> containers);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

CustomCategoriesClientController

Provides operations on custom categories.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: CustomCategoriesClientControllerBase (ICustomCategoriesClientController)

Methods

CreateAsync()

Action responsible for creating a list of custom categories.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> CreateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData> categories, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Create(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData> categories);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Action responsible for deleting a list of custom categories.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> categories, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Delete(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> categories);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAsync()

Action responsible for returning a custom category.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData>> GetAsync(string workspace, string organization, string appInstance, string key, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData> Get(string workspace, string organization, string appInstance, string key);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAllAsync()

Action responsible for returning a list of custom categories. The query parameters should follow OData format.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData>>> GetAllAsync(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, int skip, int top, string? select, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData>> GetAll(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, int skip, int top, string? select);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Action responsible for updating a list of custom categories.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> UpdateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData> categories, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Update(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData> categories);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

CustomMetadataClientController

Provides operations on custom metadata.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: CustomMetadataClientControllerBase (ICustomMetadataClientController)

Methods

CreateAsync()

Action responsible for creating a list of custom metadata.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> CreateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData> metadata, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Create(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData> metadata);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Action responsible for updating a list of custom metadata.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> metadata, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Delete(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> metadata);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAsync()

Action responsible for returning a custom metadata.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData>> GetAsync(string workspace, string organization, string appInstance, string key, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData> Get(string workspace, string organization, string appInstance, string key);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAllAsync()

Action responsible for returning a list of custom metadata. The query parameters should follow OData format.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData>>> GetAllAsync(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, int skip, int top, string? select, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData>> GetAll(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, int skip, int top, string? select);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Action responsible for updating the provided metadata by id.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> UpdateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData> metadata, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Update(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData> metadata);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

CustomStatesClientController

Provides operations to manage document custom states.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: CustomStatesClientControllerBase (ICustomStatesClientController)

Methods

CreateAsync()

Action responsible for creating a list of custom states.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> CreateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData> states, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Create(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData> states);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Action responsible for deleting a list of custom states.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<int> states, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Delete(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<int> states);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAsync()

Action responsible for returning a custom state.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData>> GetAsync(string workspace, string organization, string appInstance, int key, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData> Get(string workspace, string organization, string appInstance, int key);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAllAsync()

Action responsible for returning a list of custom states. The query parameters should follow OData format.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData>>> GetAllAsync(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, int skip, int top, string? select, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData>> GetAll(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, int skip, int top, string? select);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetNextKeyAsync()

Action responsible for returning the next custom state key.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<int>> GetNextKeyAsync(string workspace, string organization, string appInstance, CancellationToken cancellationToken = default);

public RestServiceResult<int> GetNextKey(string workspace, string organization, string appInstance);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Action responsible for updating a list of custom states.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> UpdateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData> states, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Update(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData> states);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

EventsLogClientController

Provides operations on events log.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: EventsLogClientControllerBase (IEventsLogClientController)

Methods

GetAllNonSystemAsync()

Action responsible for returning a list of event log entries.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.EventLogListResponse>> GetAllNonSystemAsync(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, int skip, int top, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.EventLogListResponse> GetAllNonSystem(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, int skip, int top);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetByGroupAsync()

Action responsible for returning a list of event log entries by group.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.EventLogListResponse>> GetByGroupAsync(string workspace, string organization, string appInstance, string groupId, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.EventLogListResponse> GetByGroup(string workspace, string organization, string appInstance, string groupId);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ExportsClientController

Provides operations on exports.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: ExportsClientControllerBase (IExportsClientController)

Methods

BulkGetExportsFileAsync()

Action responsible for sending a ZIP file with archives exports.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.File>> BulkGetExportsFileAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<int> ids, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.File> BulkGetExportsFile(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<int> ids);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

BulkResendExportUrlAsync()

Action responsible for sending a list of archive export URLs to a list of email addresses.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult> BulkResendExportUrlAsync(string workspace, string organization, string appInstance, Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkResendExportUrlData resendExportUrlOptions, CancellationToken cancellationToken = default);

public RestServiceResult BulkResendExportUrl(string workspace, string organization, string appInstance, Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkResendExportUrlData resendExportUrlOptions);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAsync()

Action responsible for returning an archive export for a container.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportData>> GetAsync(string workspace, string organization, string appInstance, string containerKey, int id, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportData> Get(string workspace, string organization, string appInstance, string containerKey, int id);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAllAsync()

Action responsible for returning a list of archive exports. The query parameters should follow OData format.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportsListResponse>> GetAllAsync(string workspace, string organization, string appInstance, string? containerKey, string? filter, string? orderBy, string? distinctBy, int skip, int top, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportsListResponse> GetAll(string workspace, string organization, string appInstance, string? containerKey, string? filter, string? orderBy, string? distinctBy, int skip, int top);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetExportUrlAsync()

Action responsible for returning an archive export URL of a container.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportUrlBulkData>> GetExportUrlAsync(string workspace, string organization, string appInstance, string containerKey, int id, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportUrlBulkData> GetExportUrl(string workspace, string organization, string appInstance, string containerKey, int id);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ResendExportUrlAsync()

Action responsible for sending an archive export URL to a list of email addresses.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult> ResendExportUrlAsync(string workspace, string organization, string appInstance, int id, System.Collections.Generic.IEnumerable<string> emails, CancellationToken cancellationToken = default);

public RestServiceResult ResendExportUrl(string workspace, string organization, string appInstance, int id, System.Collections.Generic.IEnumerable<string> emails);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ExpressionsClientController

Provides operations on expressions.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: ExpressionsClientControllerBase (IExpressionsClientController)

Methods

EvaluateAsync()

Evaluates an expression. Returns success, with the expression result, or bad request, with error details, otherwise.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ExpressionReturnValue>> EvaluateAsync(string workspace, string organization, string appInstance, string expression, string? id, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ExpressionReturnValue> Evaluate(string workspace, string organization, string appInstance, string expression, string? id);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ValidateAsync()

Validates an expression. Returns success if valid or bad request, with error details, otherwise.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult> ValidateAsync(string workspace, string organization, string appInstance, string expression, CancellationToken cancellationToken = default);

public RestServiceResult Validate(string workspace, string organization, string appInstance, string expression);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GroupingsClientController

Provides operations on groupings.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: GroupingsClientControllerBase (IGroupingsClientController)

Methods

CreateAsync()

Action responsible to create a grouping data.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> CreateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData> groupings, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Create(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData> groupings);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Action responsible for deleting a list of groupings.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> groupings, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Delete(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> groupings);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAsync()

Action responsible for returning a grouping based on its key.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData>> GetAsync(string workspace, string organization, string appInstance, string key, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData> Get(string workspace, string organization, string appInstance, string key);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAllAsync()

Action responsible for returning a list of groupings. The query parameters should follow OData format.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData>>> GetAllAsync(string workspace, string organization, string appInstance, string? orderBy, string? filter, string? distinctBy, int skip, int top, string? select, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData>> GetAll(string workspace, string organization, string appInstance, string? orderBy, string? filter, string? distinctBy, int skip, int top, string? select);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Action responsible to update the provided groupings.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> UpdateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData> groupings, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Update(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData> groupings);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ProvisioningClientController

Provides operations on provisioning.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: ProvisioningClientControllerBase (IProvisioningClientController)

Methods

CheckUpgradeAsync()

Action responsible for checking if upgrades are pending.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<bool>> CheckUpgradeAsync(string workspace, string organization, string appInstance, CancellationToken cancellationToken = default);

public RestServiceResult<bool> CheckUpgrade(string workspace, string organization, string appInstance);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

InitializeTenantAsync()

Action responsible for initializing and/or upgrading a Cegid Docs subscription.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ProvisioningStateData>> InitializeTenantAsync(string workspace, string organization, string appInstance, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ProvisioningStateData> InitializeTenant(string workspace, string organization, string appInstance);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

RecycleBinClientController

Provides operations on recycle bin.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: RecycleBinClientControllerBase (IRecycleBinClientController)

Methods

EmptyAsync()

Action responsible for emptying the recycle bin, hard deleting the entries.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult> EmptyAsync(string workspace, string organization, string appInstance, bool documents = true, bool containers = false, CancellationToken cancellationToken = default);

public RestServiceResult Empty(string workspace, string organization, string appInstance, bool documents = true, bool containers = false);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAllDocumentsAsync()

Action responsible for returning deleted documents. The query parameters should follow OData format.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RecycleBinEntry>>> GetAllDocumentsAsync(string workspace, string organization, string appInstance, string? identity, string? filter, string? orderBy, string? distinctBy, int skip, int top, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RecycleBinEntry>> GetAllDocuments(string workspace, string organization, string appInstance, string? identity, string? filter, string? orderBy, string? distinctBy, int skip, int top);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

RestoreContainersAsync()

Action responsible for restoring containers.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RestoreResponse>>> RestoreContainersAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> containers, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RestoreResponse>> RestoreContainers(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> containers);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

RestoreDocumentsAsync()

Action responsible for restoring documents.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RestoreResponse>>> RestoreDocumentsAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RestoreDocumentsRequest> documents, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RestoreResponse>> RestoreDocuments(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RestoreDocumentsRequest> documents);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SmartFoldersClientController

Provides operations on smart folders.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: SmartFoldersClientControllerBase (ISmartFoldersClientController)

Methods

CreateAsync()

Action responsbile for creating a smart folder in a list of folders tree.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> CreateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData> folders, bool notifyNewUsers, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Create(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData> folders, bool notifyNewUsers);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

DeleteAsync()

Action responsible for deleting a list of smart folders in a list of folders tree.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> folderKeys, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Delete(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> folderKeys);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAsync()

Action responsible for returning a container smart folder.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData>> GetAsync(string workspace, string organization, string appInstance, string key, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData> Get(string workspace, string organization, string appInstance, string key);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetAllAsync()

Action responsible for returning a list of smart folders.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData>>> GetAllAsync(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, int skip, int top, string? select, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData>> GetAll(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, int skip, int top, string? select);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAsync()

Action responsible for updating a list of smart folders in a list of folders tree.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> UpdateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData> folders, bool notifyNewUsers, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Update(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData> folders, bool notifyNewUsers);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateAccessAsync()

Action responsible to bulk update accesses to a smart folder.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> UpdateAccessAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkSmartFolderAccess> accesses, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> UpdateAccess(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkSmartFolderAccess> accesses);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

StorageManagementClientController

Provides operations on storage management.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: StorageManagementClientControllerBase (IStorageManagementClientController)

Methods

GetStorageSizeAsync()

Action responsible to get storage size according a set of filters.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.StorageSizeData>>> GetStorageSizeAsync(string workspace, string organization, string appInstance, Cegid.Lithium.DigitalArchive.Client.Rest.Models.StorageSizeGroupOption groupBy, string? filter, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.StorageSizeData>> GetStorageSize(string workspace, string organization, string appInstance, Cegid.Lithium.DigitalArchive.Client.Rest.Models.StorageSizeGroupOption groupBy, string? filter);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

TaskQueueClientController

Provides operations for managing background tasks.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest
• Inheritance: TaskQueueClientControllerBase (ITaskQueueClientController)

Methods

GetTaskAsync()

Action responsible for returning a task.

• Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.TaskQueueData>> GetTaskAsync(string workspace, string organization, string appInstance, System.Guid id, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.TaskQueueData> GetTask(string workspace, string organization, string appInstance, System.Guid id);

Parameters

Returns

Status Codes

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

Models Classes

AccessControl

Describes an access control.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: AccessControlBase

Properties

^ Back to top

AccessControlData

Describes an access control.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: AccessControlDataBase (EntityBase)

Properties

^ Back to top

AccessControlInfo

Describes an access control.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: AccessControlInfoBase

Properties

^ Back to top

AccountingDocumentData

Describes an accounting document.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: AccountingDocumentDataBase

Properties

^ Back to top

AppInfoSelectorData

Describes an app info selector.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: AppInfoSelectorDataBase

Properties

^ Back to top

Archive

Describes an archive.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: ArchiveBase

Properties

^ Back to top

ArchiveExportData

Describes an archive export.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: ArchiveExportDataBase (EntityBase)

Properties

^ Back to top

ArchiveExportEmailSenderData

Describes an archive export email sender.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: ArchiveExportEmailSenderDataBase

Properties

^ Back to top

ArchiveExportsListResponse

Describes an archive exports list response.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: ArchiveExportsListResponseBase

Properties

^ Back to top

ArchiveExportUrlBulkData

Describes an archive export URL bulk.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: ArchiveExportUrlBulkDataBase

Properties

^ Back to top

ArchiveMessage

Describes an archive message.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: ArchiveMessageBase (Archive)

Properties

^ Back to top

BankAccountData

Describes a bank account.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: BankAccountDataBase

Properties

^ Back to top

BaseCustomCategory

Describes a base custom category.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: BaseCustomCategoryBase

Properties

^ Back to top

BaseCustomMetadata

Describes a base custom metadata.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: BaseCustomMetadataBase

Properties

^ Back to top

BaseCustomState

Describes a base custom state.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: BaseCustomStateBase

Properties

^ Back to top

BaseGroupingData

Describes a base grouping.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: BaseGroupingDataBase

Properties

^ Back to top

BaseSmartFolderTree

Describes a base smart folder tree.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: BaseSmartFolderTreeBase

Properties

^ Back to top

BulkContact

Describes a bulk contact.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: BulkContactBase

Properties

^ Back to top

BulkContainerResponse

Describes a bulk container response.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: BulkContainerResponseBase

Properties

^ Back to top

BulkDeleteContact

Describes a bulk delete contact.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: BulkDeleteContactBase

Properties

^ Back to top

BulkDocumentMove

Describes a bulk document move.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: BulkDocumentMoveBase

Properties

^ Back to top

BulkFavorite

Describes a bulk favorite.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: BulkFavoriteBase

Properties

^ Back to top

BulkMessageInfo

Describes a bulk message.

• Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
• Inheritance: BulkMessageInfoBase

Properties