Cegid Docs Service (DAS) Client Library

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

REST Service Client

Class	Description
`DigitalArchiveClient`	The entry point of the Cegid Docs Service client library.

Client Controllers

Class	Description
`Archives`	Provides operations on archives.
`Contacts`	Provides operations on contacts.
`Containers`	Provides operations on containers.
`CustomCategories`	Provides operations on custom categories.
`CustomMetadata`	Provides operations on custom metadata.
`CustomStates`	Provides operations to manage document custom states.
`EventsLog`	Provides operations on events log.
`Exports`	Provides operations on exports.
`Expressions`	Provides operations on expressions.
`Groupings`	Provides operations on groupings.
`Provisioning`	Provides operations on provisioning.
`RecycleBin`	Provides operations on recycle bin.
`SmartFolders`	Provides operations on smart folders.
`StorageManagement`	Provides operations on storage management.
`TaskQueue`	Provides operations for managing background tasks.

Models

Class	Description
`AccessControl`	Describes an access control.
`AccountingDocumentData`	Describes an accounting document.
`Archive`	Describes an archive.
`ArchiveExportData`	Describes an archive export.
`ArchiveExportEmailSenderData`	Describes an archive export email sender.
`ArchiveExportsListResponse`	Describes an archive exports list response.
`ArchiveExportUrlBulkData`	Describes an archive export URL bulk.
`ArchiveMessage`	Describes an archive message.
`BankAccountData`	Describes a bank account.
`BaseCustomCategory`	Describes a base custom category.
`BaseCustomMetadata`	Describes a base custom metadata.
`BaseCustomState`	Describes a base custom state.
`BaseGroupingData`	Describes a base grouping.
`BaseSmartFolderTree`	Describes a base smart folder tree.
`BulkContact`	Describes a bulk contact.
`BulkContainerResponse`	Describes a bulk container response.
`BulkDeleteContact`	Describes a bulk delete contact.
`BulkDocumentMove`	Describes a bulk document move.
`BulkFavorite`	Describes a bulk favorite.
`BulkMessageInfo`	Describes a bulk message.
`BulkOperationDetailResponse`	Describes a bulk operation detail response.
`BulkOperationResponse`	Describes a bulk operation response.
`BulkResendExportUrlData`	Describes a bulk resend export URL.
`BulkSmartFolderAccess`	Describes a bulk smart folder access.
`BulkSmartFolderUserData`	Describes a bulk smart folder user.
`BulkUploadMessage`	Describes a bulk upload message.
`CompanyData`	Describes a company.
`Contact`	Describes a contact.
`ContainerInfo`	Describes a container.
`ContainerSmartFolder`	Describes a container smart folder.
`CreditorData`	Describes a creditor.
`CustomCategoryData`	Describes a custom category.
`CustomFieldData`	Describes a custom field.
`CustomMetadataBooleanConfiguration`	Describes a custom metadata boolean configuration.
`CustomMetadataData`	Describes a custom metadata.
`CustomMetadataListConfiguration`	Describes a custom metadata list configuration.
`CustomMetadataListValue`	Describes a custom metadata list value.
`CustomMetadataNumericConfiguration`	Describes a custom metadata numeric configuration.
`CustomMetadataTextConfiguration`	Describes a custom metadata text configuration.
`CustomStateData`	Describes a custom state.
`DebtorAccountData`	Describes a debtor account.
`DebtorData`	Describes a debtor.
`DocumentBaseData`	Describes a document base.
`DocumentData`	Describes a document.
`DocumentGenericData`	Describes a document generic.
`DocumentLineData`	Describes a document line.
`DocumentPaymentData`	Describes a document payment.
`DocumentsBulkData`	Describes a documents bulk.
`DocumentTagData`	Describes a document tag.
`DocumentTotalData`	Describes a document total.
`EntityBase`	Describes an entity.
`EventLogData`	Describes an event log.
`EventLogListResponse`	Describes an event log list response.
`ExpressionReturnValue`	Describes an expression return value.
`FavoriteEntry`	Describes a favorite entry.
`File`	Describes a file.
`GeneralLedgerEntryData`	Describes a general ledger entry.
`GroupingData`	Describes a grouping.
`GroupingFolderConfiguration`	Describes a grouping folder configuration.
`JournalData`	Describes a journal.
`KeyValueData`	Describes a key value.
`KeyValueDocument`	Describes a key value document.
`MessageInfo`	Describes a message.
`MessageInfoDetails`	Describes a message info details.
`PartyInformationData`	Describes a party information.
`ProvisioningStateData`	Describes a provisioning state.
`RecycleBinEntry`	Describes a recycle bin entry.
`RestoreDocumentsRequest`	Describes a restore documents request.
`RestoreResponse`	Describes a restore response.
`SmartFolderCategoryData`	Describes a smart folder category.
`SmartFolderData`	Describes a smart folder.
`SmartFolderFieldData`	Describes a smart folder field.
`SmartFolderStateData`	Describes a smart folder state.
`SmartFolderSubFolderData`	Describes a smart folder sub folder.
`SmartFolderTree`	Describes a smart folder tree.
`SmartFolderTreeCategory`	Describes a smart folder tree category.
`SmartFolderTreeMetadataField`	Describes a smart folder tree metadata field.
`SmartFolderTreeState`	Describes a smart folder tree state.
`SmartFolderTreeSubFolder`	Describes a smart folder tree sub folder.
`SmartFolderUserData`	Describes a smart folder user.
`SourceData`	Describes a source.
`StorageSizeData`	Describes a storage size.
`StorageSizeKeyData`	Describes a storage size key.
`TaskQueueData`	Describes a task queue.
`TaxInformationData`	Describes a tax information.
`TransactionData`	Describes a transaction.
`TranslationData`	Describes a translation.
`TranslationFieldData`	Describes a translation field.
`UpdateCompanyData`	Describes an update company.
`UploadArchiveMessage`	Describes an upload archive message.
`UploadMessage`	Describes an upload message.
`WithholdingData`	Describes a withholding.
`WithholdingTaxData`	Describes a withholding tax.

Enumerations

Class	Description
`AccessRight`	The access right of the user.
`ArchiveExportState`	Defines an archive export state.
`ArchiveExportType`	Defines an archive export type.
`ArchiveOperationType`	Specifies the different document update operation types.
`ArchiveState`	Specifies the diferente archive states.
`ComponentType`	Identifies a component type.
`ContainerExportState`	Describes the container/company current state.
`CustomMetadataType`	Identifies a metadata type.
`CustomStateIndicator`	Defines a document state indicator.
`DeletedEntityType`	Defines a deleted entity type.
`EventLevel`	The event log entry type.
`ExportCsvType`	Defines the type of CSV export.
`ExpressionReturnValueType`	The expression return value type.
`FavoriteOperationType`	Enumeration that represents the two options on a favourite opeartion.
`ProvisioningState`	The existing provisioning states.
`SmartFolderFieldType`	Indicates the type of field.
`SourceSchemaEntity`	The request source.
`SourceType`	A document source type enumerator.
`StorageSizeGroupOption`	Identifies a storage size 'group by' option.
`SubFolderType`	Identifies the subfolder type.
`TaskQueueStatus`	The task queue status.

Authorization Policies

Policy	Description	Scope
`DefaultScope`	Defines an authorization policy that requires the default scope.	`lithium-digitalarchiveservice`
`AccessAuth`	Policy that handles access authorization to service resources.	N/A
`AccessAuthV2`	Policy that handles access authorization to service resources on higher versions (>1).	N/A
`ArchivesAdmin`	The archives admin policy.	`lithium-digitalarchiveservice-admin`
`ArchivesManagement`	The archives management policy.	`lithium-digitalarchiveservice-management`
`CallbacksAuth`	Policy that handles access authorization to the export callback service.	N/A
`Deprovisioning`	Requires a specific scope to deprovision a CegidDocs subscription.	N/A
`ElasticSearch`	Policy that handles Elastic Search operations.	`lithium-digitalarchiveservice-elasticsearch`

Reference

REST Service Client Classes

`DigitalArchiveClient`

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

Constructors

`DigitalArchiveClient(Uri, BearerTokenCredential)`

Parameter	Type	Description
`serviceUri`	`Uri`	The service URI.
`credential`	`BearerTokenCredential`	The credential that should be used to access the service.

`DigitalArchiveClient(Uri, BearerTokenCredential, DigitalArchiveClientOptions)`

Parameter	Type	Description
`serviceUri`	`Uri`	The service URI.
`credential`	`BearerTokenCredential`	The credential that should be used to access the service.
`clientOptions`	`DigitalArchiveClientOptions`	The client options.

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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string`	The container key.	Required.
`accountingDocuments`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.AccountingDocumentData>`	The accounting documents.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkMessageInfo`	Information message with success/error details for each document.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`ChangeStatusWithTaskAsync()`

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

Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Guid>> ChangeStatusWithTaskAsync(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<System.Guid> ChangeStatusWithTask(string workspace, string organization, string appInstance, string containerKey, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.AccountingDocumentData> accountingDocuments);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string`	The container key.	Required.
`accountingDocuments`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.AccountingDocumentData>`	The accounting documents.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`documents`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentsBulkData>`	The list of documents to delete.	Required.
`soft`	`bool?`	Soft delete only flags the document, while hard deletes permanently.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkMessageInfo`	A message containing details about the deleted documents.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`DeleteWithTaskAsync()`

Action responsible for deleting a list of documents using a background service. Soft delete only flags the document, while hard deletes permanently.

Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Guid>> DeleteWithTaskAsync(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<System.Guid> DeleteWithTask(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentsBulkData> documents, bool? soft = true);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`documents`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentsBulkData>`	The list of documents to delete.	Required.
`soft`	`bool?`	Soft delete only flags the document, while hard deletes permanently.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string`	The container key.	Required.
`assignment`	`int`	The assignment/fiscal year.	Required.
`startPeriod`	`int`	The starting period (from 0 to 15).	Required.
`endPeriod`	`int`	The ending period (from 0 to 15).	Required.
`email`	`string`	The list of emails, separated by semicolon (;).	Required.
`isFullExport`	`bool`	Indicates if exports all documents. If true, 'StartPeriod', 'EndPeriod', and 'Assignment' are not required.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.MessageInfo`	A message indicating whether the request was successful and the estimated time to send the export file to the list of emails.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string`	The container key.	Required.
`id`	`string`	The document id.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentData`	A document with metadata information.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string?`	The container key.	Required.
`filter`	`string?`	The select filter.	Required.
`orderBy`	`string?`	A list of properties to sort by.	Required.
`distinctBy`	`string?`	A list of properties to perform a distinct query.	Required.
`select`	`string?`	A list of properties to be returned.	Required.
`skip`	`int`	The number of records to skip.	Required.
`top`	`int`	The number of records to take.	Required.< 200. > 0.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentData>`	A list of documents with metadata.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`user`	`string`	The user id.	Required.
`containerKey`	`string?`	The container key.	Required.
`filter`	`string?`	The select filter.	Required.
`orderBy`	`string?`	A list of properties to sort by.	Required.
`distinctBy`	`string?`	A list of properties to perform a distinct query.	Required.
`skip`	`int`	The number of records to skip.	Required.
`top`	`int`	The number of records to take.	Required.< 200. > 0.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.FavoriteEntry>`	A list of favorite entries.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string`	The container key.	Required.
`id`	`string`	The document id.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.File`	The document in base64 format.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`documents`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkDocumentMove>`	The documents.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	If error, response contains not updated smart folders and a detailed error, else the response is empty.

Status Codes

Status Code	Description
`HttpStatusCode.Created`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`MoveDocumentsWithTaskAsync()`

Action responsible to move documents between folders using a background service.

Authorization Policy: AccessAuthV2

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

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

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`documents`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkDocumentMove>`	The documents.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`userFavorites`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkFavorite>`	The documents to (un)mark as favorite.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	If error, response contains not updated documents and a detailed error, else the response is empty.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`SetFavoriteDocumentsWithTaskAsync()`

Action responsible for setting a list of documents as user favorites using a background service.

Authorization Policy: AccessAuthV2

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

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

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`userFavorites`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkFavorite>`	The documents to (un)mark as favorite.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string`	The container key.	Required.
`documents`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentData>`	The documents.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.MessageInfo`	A message indicating the number of success and failed updated documents.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.
`HttpStatusCode.Conflict`	Failure: conflict.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`documents`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.KeyValueDocument>`	The key/value document properties values.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`UpdateByPropertyWithTaskAsync()`

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

Authorization Policy: AccessAuthV2

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

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

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`documents`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.KeyValueDocument>`	The key/value document properties values.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`UpdateWithTaskAsync()`

Action responsible for updating properties of a list of documents using a background service.

Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Guid>> UpdateWithTaskAsync(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<System.Guid> UpdateWithTask(string workspace, string organization, string appInstance, string containerKey, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentData> documents);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string`	The container key.	Required.
`documents`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentData>`	The documents.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.
`HttpStatusCode.Conflict`	Failure: conflict.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string`	The container key.	Required.
`smartFolderKey`	`string?`	The smart folder key.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkUploadMessage`	A list of messages indicating success and failed uploaded documents.

Status Codes

Status Code	Description
`HttpStatusCode.Accepted`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`contacts`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkContact>`	The list of contacts to add.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`CreateWithTaskAsync()`

Action responsible for adding whitelist contacts to containers using a background service.

Authorization Policy: AccessAuthV2

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

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

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`contacts`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkContact>`	The list of contacts to add.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`contacts`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkDeleteContact>`	The list of contacts to delete.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`DeleteWithTaskAsync()`

Action responsible for deleting containers whitelist contacts using a background service.

Authorization Policy: AccessAuthV2

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

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

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`contacts`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkDeleteContact>`	The list of contacts to delete.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`pageIndex`	`int`	The page index.	Required.
`pageSize`	`int`	The page size.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.Contact>`	A list of whitelist contacts.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string`	The container key.	Required.
`pageIndex`	`int`	The page index.	Required.
`pageSize`	`int`	The page size.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.Contact>`	A list of whitelist contacts.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`ContainersClientController`

Provides operations on containers.

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

Methods

`CreateWithTaskAsync()`

Action responsible for creating a list of containers using a background service.

Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Guid>> CreateWithTaskAsync(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> CreateWithTask(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CompanyData> containers);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containers`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CompanyData>`	The list of containers.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.Conflict`	Failure: conflict.

^ 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, bool? soft = true, 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, bool? soft = true);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containers`	`System.Collections.Generic.IEnumerable<string>`	The list of container keys.	Required.Not empty.
`soft`	`bool?`	Soft delete only flags the container, while hard deletes permanently.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkContainerResponse>`	A list of not deleted containers.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`DeleteWithTaskAsync()`

Action responsible for deleting a list of containers using a background service.

Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Guid>> DeleteWithTaskAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> containers, bool? soft = true, CancellationToken cancellationToken = default);

public RestServiceResult<System.Guid> DeleteWithTask(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> containers, bool? soft = true);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containers`	`System.Collections.Generic.IEnumerable<string>`	The list of container keys.	Required.Not empty.
`soft`	`bool?`	Soft delete only flags the container, while hard deletes permanently.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string`	The container key.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ContainerInfo`	A container.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`filter`	`string?`	The select filter.	Required.
`orderBy`	`string?`	A list of properties to sort by.	Required.
`distinctBy`	`string?`	A list of properties to perform a distinct query.	Required.
`select`	`string?`	A list of properties to be returned.	Required.
`skip`	`int`	The number of records to skip.	Required.
`top`	`int`	The number of records to take.	Required.
`ignoreAccesses`	`bool?`	If true, containers will be returned independently of the current user or client. By default value is false. Only tokens with the scope "lithium-digitalarchiveservice-nolimit" can set this parameter's value.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ContainerInfo>`	A list of containers.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containers`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.UpdateCompanyData>`	The list of updatable containers.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkContainerResponse>`	A list of not updated containers.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`UpdateWithTaskAsync()`

Action responsible for updating a list of containers using a background service.

Authorization Policy: AccessAuthV2

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

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

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containers`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.UpdateCompanyData>`	The list of updatable containers.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`categories`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData>`	The list of custom categories.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not created custom categories.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`categories`	`System.Collections.Generic.IEnumerable<string>`	The list of custom category keys.	Required.Not empty.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not deleted custom categories.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`key`	`string`	The custom category key.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData`	A custom category.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`filter`	`string?`	The select filter.	Required.
`orderBy`	`string?`	A list of properties to sort by.	Required.
`distinctBy`	`string?`	A list of properties to perform a distinct query.	Required.
`skip`	`int`	The number of records to skip.	Required.
`top`	`int`	The number of records to take.	Required.
`select`	`string?`	A list of properties to be returned.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData>`	A list of custom categories.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`categories`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData>`	The list of custom categories.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not updated custom categories.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`metadata`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData>`	The list of custom metadata.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not created custom metadata.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`metadata`	`System.Collections.Generic.IEnumerable<string>`	The list of custom metadata keys.	Required.Not empty.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not deleted custom metadata.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`key`	`string`	The document metadata key.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData`	A custom metadata.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`filter`	`string?`	The select filter.	Required.
`orderBy`	`string?`	A list of properties to sort by.	Required.
`distinctBy`	`string?`	A list of properties to perform a distinct query.	Required.
`skip`	`int`	The number of records to skip.	Required.
`top`	`int`	The number of records to take.	Required.
`select`	`string?`	A list of properties to be returned.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData>`	A list of custom metadata.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`metadata`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData>`	The list of custom metadata.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not updated custom metadata.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`states`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData>`	The list of custom states.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not created custom states.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.Conflict`	Failure: conflict.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`states`	`System.Collections.Generic.IEnumerable<int>`	The list of custom state keys.	Required.Not empty.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not deleted custom states.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`key`	`int`	The numeric custom state key.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData`	A custom state.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`filter`	`string?`	The select filter.	Required.
`orderBy`	`string?`	A list of properties to sort by.	Required.
`distinctBy`	`string?`	A list of properties to perform a distinct query.	Required.
`skip`	`int`	The number of records to skip.	Required.
`top`	`int`	The number of records to take.	Required.
`select`	`string?`	A list of properties to be returned.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData>`	A list of custom states.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.

Returns

Return Type	Description
`int`	The next custom state numeric key.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`states`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData>`	The list of custom states.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not updated custom states.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`filter`	`string?`	The select filter.	Required.
`orderBy`	`string?`	A list of properties to sort by.	Required.
`distinctBy`	`string?`	A list of properties to perform a distinct query.	Required.
`skip`	`int`	The number of records to skip.	Required.
`top`	`int`	The number of records to take.	Required.< 100. > 0.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.EventLogListResponse`	A list of event log entries.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`groupId`	`string`	The group id.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.EventLogListResponse`	A list of event log entries.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`ids`	`System.Collections.Generic.IEnumerable<int>`	The list of archive export ids.	Required.Not empty.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.File`	The archives exports in a ZIP file.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`resendExportUrlOptions`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkResendExportUrlData`	The export options.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string`	The container key.	Required.
`id`	`int`	The export id.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportData`	The archive export.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string?`	The container key.	Required.
`filter`	`string?`	The select filter.	Required.
`orderBy`	`string?`	A list of properties to sort by.	Required.
`distinctBy`	`string?`	A list of properties to perform a distinct query.	Required.
`skip`	`int`	The number of records to skip.	Required.
`top`	`int`	The number of records to take.	Required.< 100. > 0.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportsListResponse`	A list of archive exports.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containerKey`	`string`	The container key.	Required.
`id`	`int`	The export id.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportUrlBulkData`	The archive export URL.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`id`	`int`	The export id.	Required.
`emails`	`System.Collections.Generic.IEnumerable<string>`	The list of email addresses.	Required.Not empty.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`expression`	`string`	The expression to evaluate.	Required.
`id`	`string?`	The document unique identifier (GUID).	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ExpressionReturnValue`	The return value, as a string, with the value's underlying type.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`expression`	`string`	The expression.	Required.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`groupings`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData>`	A list of groupings.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not created groupings.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`groupings`	`System.Collections.Generic.IEnumerable<string>`	The grouping keys.	Required.Not empty.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not deleted groupings.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`key`	`string`	The grouping key.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData`	A grouping data.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`orderBy`	`string?`	A list of properties to sort by.	Required.
`filter`	`string?`	The select filter.	Required.
`distinctBy`	`string?`	A list of properties to perform a distinct query.	Required.
`skip`	`int`	The number of records to skip.	Required.
`top`	`int`	The number of records to take.	Required.
`select`	`string?`	A list of properties to be returned.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData>`	A list of groupings.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`groupings`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData>`	A list of groupings.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not updated groupings.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace.	Required.
`organization`	`string`	The organization.	Required.
`appInstance`	`string`	The app instance.	Required.

Returns

Return Type	Description
`bool`	If tenant needs upgrade.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace.	Required.
`organization`	`string`	The organization.	Required.
`appInstance`	`string`	The app instance.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ProvisioningStateData`	The current provisioning state.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> EmptyAsync(string workspace, string organization, string appInstance, bool documents = true, bool containers = false, CancellationToken cancellationToken = default);

public RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse> Empty(string workspace, string organization, string appInstance, bool documents = true, bool containers = false);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`documents`	`bool`	Whether documents should be deleted.	Required.
`containers`	`bool`	Whether containers should be deleted.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	If error, response contains not cleared documents and a detailed error, else the response is empty.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.Conflict`	Failure: conflict.

^ Back to top

`EmptyWithTaskAsync()`

Action responsible for emptying the recycle bin, hard deleting the entries, using a background service.

Authorization Policy: AccessAuthV2

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

public RestServiceResult<System.Guid> EmptyWithTask(string workspace, string organization, string appInstance, bool documents = true, bool containers = false);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`documents`	`bool`	Whether documents should be deleted.	Required.
`containers`	`bool`	Whether containers should be deleted.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.Conflict`	Failure: conflict.

^ Back to top

`GetAllContainersAsync()`

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>>> GetAllContainersAsync(string workspace, string organization, string appInstance, 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>> GetAllContainers(string workspace, string organization, string appInstance, string? filter, string? orderBy, string? distinctBy, int skip, int top);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`filter`	`string?`	The select filter.	Required.
`orderBy`	`string?`	A list of properties to sort by.	Required.
`distinctBy`	`string?`	A list of properties to perform a distinct query.	Required.
`skip`	`int`	The number of records to skip.	Required.
`top`	`int`	The number of records to take.	Required.< 200. > 0.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RecycleBinEntry>`	A list of deleted documents.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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? 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? filter, string? orderBy, string? distinctBy, int skip, int top);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`filter`	`string?`	The select filter.	Required.
`orderBy`	`string?`	A list of properties to sort by.	Required.
`distinctBy`	`string?`	A list of properties to perform a distinct query.	Required.
`skip`	`int`	The number of records to skip.	Required.
`top`	`int`	The number of records to take.	Required.< 200. > 0.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RecycleBinEntry>`	A list of deleted documents.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containers`	`System.Collections.Generic.IEnumerable<string>`	The list of containers ids.	Required.Not empty.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RestoreResponse>`	A list of not restored containers.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RestoreContainersWithTaskAsync()`

Action responsible for restoring containers using a background service.

Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Guid>> RestoreContainersWithTaskAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> containers, CancellationToken cancellationToken = default);

public RestServiceResult<System.Guid> RestoreContainersWithTask(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> containers);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`containers`	`System.Collections.Generic.IEnumerable<string>`	The list of containers ids.	Required.Not empty.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`documents`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RestoreDocumentsRequest>`	The list of documents.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RestoreResponse>`	A list of not restored documents.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`RestoreDocumentsWithTaskAsync()`

Action responsible for restoring documents using a background service.

Authorization Policy: AccessAuthV2

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

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

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`documents`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.RestoreDocumentsRequest>`	The list of documents.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`folders`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData>`	The list of smart folders.	Required.
`notifyNewUsers`	`bool`	The notify new users.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	If error, response contains not created smart folders and a detailed error, else the response is empty.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`CreateWithTaskAsync()`

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

Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Guid>> CreateWithTaskAsync(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<System.Guid> CreateWithTask(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData> folders, bool notifyNewUsers);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`folders`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData>`	The list of smart folders.	Required.
`notifyNewUsers`	`bool`	The notify new users.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`folderKeys`	`System.Collections.Generic.IEnumerable<string>`	The folder keys.	Required.Not empty.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	If error, response contains not deleted smart folders and a detailed error, else the response is empty.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`DeleteWithTaskAsync()`

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

Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Guid>> DeleteWithTaskAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> folderKeys, CancellationToken cancellationToken = default);

public RestServiceResult<System.Guid> DeleteWithTask(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> folderKeys);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`folderKeys`	`System.Collections.Generic.IEnumerable<string>`	The folder keys.	Required.Not empty.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`key`	`string`	The smart folder key.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData`	A smart folder.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`filter`	`string?`	The select filter.	Required.
`orderBy`	`string?`	A list of properties to sort by.	Required.
`distinctBy`	`string?`	A list of properties to perform a distinct query.	Required.
`skip`	`int`	The number of records to skip.	Required.
`top`	`int`	The number of records to take.	Required.
`select`	`string?`	A list of properties to be returned.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData>`	An list of smart folders.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`folders`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData>`	The list of smart folders.	Required.
`notifyNewUsers`	`bool`	The notify new users.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	If error, response contains not updated smart folders and a detailed error, else the response is empty.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ Back to top

`UpdateAccessAsync()`

Action responsible to update accesses in 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`accesses`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkSmartFolderAccess>`	The accesses.	Required.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse`	A message of not updated smart folders.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`UpdateAccessWithTaskAsync()`

Action responsible to update accesses in a smart folder using a background service.

Authorization Policy: AccessAuthV2

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

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

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`accesses`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkSmartFolderAccess>`	The accesses.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

`UpdateWithTaskAsync()`

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

Authorization Policy: AccessAuthV2

public async Task<RestServiceResult<System.Guid>> UpdateWithTaskAsync(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<System.Guid> UpdateWithTask(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData> folders, bool notifyNewUsers);

Parameters

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`folders`	`System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData>`	The list of smart folders.	Required.
`notifyNewUsers`	`bool`	The notify new users.	Required.

Returns

Return Type	Description
`System.Guid`	Returns the identifier of the task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`groupBy`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.StorageSizeGroupOption`	The group by parameter.	Required.
`filter`	`string?`	The filter parameter.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.StorageSizeData>`	A list containing information about the storage size in use.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

^ 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

Parameter	Type	Description	Rules
`workspace`	`string`	The workspace key.	Required.
`organization`	`string`	The organization key.	Required.
`appInstance`	`string`	The app instance key.	Required.
`id`	`System.Guid`	The task id.	Required.Not empty.

Returns

Return Type	Description
`Cegid.Lithium.DigitalArchive.Client.Rest.Models.TaskQueueData`	A queue task.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

^ Back to top

Models Classes

`AccessControl`

Describes an access control.

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

Properties

Property	Type	Description	Rules
`Identity`	`string`	Gets or sets the user identity.	Required.
`Profile`	`string?`	Gets or sets the profile.
`Permission`	`string?`	Gets or sets the permission.

^ Back to top

`AccessControlData`

Describes an access control.

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

Properties

Property	Type	Description	Rules
`Profile`	`string`	Gets or sets the profile.	Required.
`IsDeleted`	`bool`	Whether the access is deleted.	Required.
`ContainerId`	`string`	Gets or sets the container id.	Required.
`ContainerKey`	`string`	Gets or sets the container key.	Required.
`Identity`	`string`	Gets or sets the identity.	Required.

^ Back to top

`AccessControlInfo`

Describes an access control.

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

Properties

Property	Type	Description	Rules
`Identity`	`string`	Gets or sets the user identity.	Required.
`Profile`	`string`	Gets or sets the profile.	Required.
`ContainerId`	`string?`	Gets or sets the container id.

^ Back to top

`AccountingDocumentData`

Describes an accounting document.

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

Properties

Property	Type	Description	Rules
`Id`	`string`	Gets or sets the id.	Required.
`State`	`int`	Gets or sets the state.	Required.
`GeneralLedgerEntry`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.GeneralLedgerEntryData?`	Gets or sets the general ledger entry.

^ Back to top

`AppInfoSelectorData`

Describes an app info selector.

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

Properties

Property	Type	Description	Rules
`AccountId`	`string`	Gets or sets the account id.	Required.
`AccountKey`	`string`	Gets or sets the account key.	Required.
`Claims`	`string`	Gets or sets the claims.	Required.
`Companies`	`System.Collections.Generic.IList<string>`	Gets or sets the companies.	Required.Not empty.
`SubscriptionAlias`	`string`	Gets or sets the subscription alias.	Required.
`SubscriptionDescription`	`string`	Gets or sets the subscription description.	Required.
`SubscriptionId`	`string`	Gets or sets the subscription id.	Required.
`Managers`	`System.Collections.Generic.IList<string>`	Gets or sets the managers.	Required.Not empty.

^ Back to top

`Archive`

Describes an archive.

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

Properties

Property	Type	Description
`Name`	`string?`	Gets or sets the name.
`DocId`	`string?`	Gets or sets the optional document id.
`Category`	`string?`	Gets or sets the optional document category.
`State`	`int?`	Gets or sets the optional document state.
`Metadata`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.KeyValueData>?`	Gets or sets the optional metadata key/value pairs.
`CustomFields`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomFieldData>?`	Gets or sets the optional custom fields in key/value pairs.

^ Back to top

`ArchiveExportData`

Describes an archive export.

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

Properties

Property	Type	Description	Rules
`ExportUrl`	`string`	Gets or sets the export url.	Required.
`ContainerKey`	`string`	Gets or sets the container key.	Required.
`ContainerDescription`	`string`	Gets or sets the container description.	Required.
`FiscalYear`	`int?`	Gets or sets the fiscal year.
`StartPeriod`	`int?`	Gets or sets the start period.
`EndPeriod`	`int?`	Gets or sets the end period.
`ExportedBy`	`string`	Gets or sets the exported by.	Required.
`ExportedDate`	`System.DateTime`	Gets or sets the exported date.	Required.
`ExpireDate`	`System.DateTime`	Gets or sets the expire date.	Required.
`Type`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportType`	Gets or sets the type.	Required.
`State`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportState`	Gets or sets the state.	Required.
`ContainerState`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ContainerExportState`	Gets or sets the container export state.	Required.
`Senders`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportEmailSenderData>`	Gets or sets the senders.	Required.

^ Back to top

`ArchiveExportEmailSenderData`

Describes an archive export email sender.

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

Properties

Property	Type	Description	Rules
`Email`	`string`	Gets or sets the email.	Required.
`SentDate`	`System.DateTime`	Gets or sets the sent date.	Required.

^ Back to top

`ArchiveExportsListResponse`

Describes an archive exports list response.

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

Properties

Property	Type	Description	Rules
`ArchiveExports`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportData>`	Gets or sets the archive exports.	Required.

^ Back to top

`ArchiveExportUrlBulkData`

Describes an archive export URL bulk.

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

Properties

Property	Type	Description	Rules
`Url`	`string`	Gets or sets the url.	Required.
`ContainerDescription`	`string`	Gets or sets the container description.	Required.
`ContainerKey`	`string`	Gets or sets the container key.	Required.

^ Back to top

`ArchiveMessage`

Describes an archive message.

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

Properties

Property	Type	Description	Rules
`UploadDate`	`System.DateTime`	Gets or sets the upload date.	Required.
`IsLocked`	`bool?`	Whether the archive is locked.
`IsDeleted`	`bool?`	Whether the archive is deleted.

^ Back to top

`BankAccountData`

Describes a bank account.

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

Properties

Property	Type	Description
`BankAccountName`	`string?`	Gets or sets the bank account name.
`Bic`	`string?`	Gets or sets the bic.
`IbanNumber`	`string?`	Gets or sets the iban number.
`CurrencyCode`	`string?`	Gets or sets the currency code.
`CreditorInfo`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.CreditorData?`	Gets or sets the creditor.
`DebtorInfo`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.DebtorData?`	Gets or sets the debtor.
`BookingDate`	`System.DateTime?`	Gets or sets the booking date.
`ValueDate`	`System.DateTime?`	Gets or sets the value date.
`RemittanceInformation`	`string?`	Gets or sets the remittance information.
`Amount`	`decimal?`	Gets or sets the amount.
`DebitCreditIndicator`	`string?`	Gets or sets the debit credit indicator.
`BankTransactionCode`	`string?`	Gets or sets the bank transaction code.

^ Back to top

`BaseCustomCategory`

Describes a base custom category.

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

Properties

Property	Type	Description	Rules
`Id`	`string?`	Gets or sets the custom document category id.
`Key`	`string`	Gets or sets the document category key.	Required.
`Name`	`string`	Gets or sets the document category name.	Required.
`Description`	`string?`	Gets or sets the document category description.
`IsDefault`	`bool?`	If this flag is active, this custom category will be automatically selected when creating custom folders.
`IsExternalManaged`	`bool`	Indicates that the custom category is being managed by an external application.	Required.

^ Back to top

`BaseCustomMetadata`

Describes a base custom metadata.

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

Properties

Property	Type	Description	Rules
`Id`	`string?`	Gets or sets the custom document metadata id.
`Key`	`string`	Gets or sets the document metadata key.	Required.
`Name`	`string`	Gets or sets the document metadata name.	Required.
`Description`	`string?`	Gets or sets the document metadata description.
`DescriptionTooltip`	`bool`	Whether to show description as a tooltip.	Required.
`Placeholder`	`string?`	Gets or sets the placeholder.
`Tag`	`string?`	Gets or sets the tag.
`Icon`	`string?`	Gets or sets the icon.
`IsExternalManaged`	`bool`	Indicates that the custom metadata is being managed by an external application.	Required.
`IsDefault`	`bool`	If this flag is active, this metadata will be automatically selected when creating custom folders.	Required.
`Type`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataType`	Gets or sets the metadata type.	Required.
`ComponentType`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ComponentType`	Gets or sets the component type.	Required.
`ListConfiguration`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataListConfiguration?`	Gets or sets the list configuration (available if component type Select Box or Radio Button).
`NumericConfiguration`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataNumericConfiguration?`	Gets or sets the numeric configuration.
`BooleanConfiguration`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataBooleanConfiguration?`	Gets or sets the boolean configuration.
`TextConfiguration`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataTextConfiguration?`	Gets or sets the text configuration.

^ Back to top

`BaseCustomState`

Describes a base custom state.

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

Properties

Property	Type	Description	Rules
`Id`	`string?`	Gets or sets the custom document state id.
`Key`	`int`	Gets or sets the numeric document state key.	Required.
`Name`	`string`	Gets or sets the document state name.	Required.
`Description`	`string?`	Gets or sets the document state description.
`Indicator`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateIndicator`	Gets or sets the indicator.	Required.
`IsHidden`	`bool`	Gets or sets a value indicating whether the document state is hidden or not.	Required.
`LockFiles`	`bool`	Gets or sets a value indicating whether should lock documents for edit. If this flag is set to true, the documents assigned with this custom state should be blocked for edit.	Required.
`IsDefault`	`bool?`	If this flag is active, this custom state will be automatically selected when creating custom folders.
`IsExternalManaged`	`bool`	Indicates that the custom state is being managed by an external application.	Required.

^ Back to top

`BaseGroupingData`

Describes a base grouping.

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

Properties

Property	Type	Description	Rules
`Id`	`string?`	Gets or sets the custom grouping id.
`Key`	`string`	Gets or sets the key.	Required.
`Name`	`string`	Gets or sets the name.	Required.
`Description`	`string?`	Gets or sets the description.
`Expanded`	`bool`	Gets or sets a value indicating whether the grouping is shown expanded by default.	Required.
`Folders`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingFolderConfiguration>?`	Gets or sets the folders.

^ Back to top

`BaseSmartFolderTree`

Describes a base smart folder tree.

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

Properties

Property	Type	Description	Rules
`Key`	`string`	Gets or sets the smart folder key.	Required.
`Count`	`int`	Gets or sets the document count.	Required.
`Storage`	`long`	Gets or sets the storage in bytes.	Required.
`Order`	`int?`	Gets or sets the order.

^ Back to top

`BulkContact`

Describes a bulk contact.

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

Properties

Property	Type	Description	Rules
`ContainerKey`	`string`	Gets or sets the container key.	Required.
`Contacts`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.Contact>`	Gets or sets the contacts.	Required.

^ Back to top

`BulkContainerResponse`

Describes a bulk container response.

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

Properties

Property	Type	Description	Rules
`ContainerKey`	`string?`	Gets or sets the container key.
`Message`	`string`	Gets or sets the message.	Required.
`ContainerDescription`	`string?`	Gets or sets the container description.
`ErrorCode`	`string?`	Gets or sets the error code.
`StatusCode`	`int?`	Gets or sets the status code.

^ Back to top

`BulkDeleteContact`

Describes a bulk delete contact.

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

Properties

Property	Type	Description	Rules
`ContactId`	`string`	Gets or sets the contact id.	Required.
`ContainerKey`	`string`	Gets or sets the container key.	Required.

^ Back to top

`BulkDocumentMove`

Describes a bulk document move.

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

Properties

Property	Type	Description	Rules
`ContainerKey`	`string`	Gets or sets the container key.	Required.
`SmartFolderKeyOrigin`	`string`	Gets or sets the smart folder key of destination.	Required.
`SmartFolderKeyTarget`	`string`	Gets or sets the smart folder key target.	Required.
`CategoryTarget`	`string?`	Gets or sets the destination category.
`StateTarget`	`int?`	Gets or sets the destination state.
`CustomFields`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomFieldData>?`	Gets or sets the custom fields.
`Documents`	`System.Collections.Generic.IList<string>`	Gets or sets the documents.	Required.Not empty.

^ Back to top

`BulkFavorite`

Describes a bulk favorite.

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

Properties

Property	Type	Description	Rules
`UserId`	`string`	Gets or sets the destination state.	Required.
`EntityIds`	`System.Collections.Generic.IList<string>`	Gets or sets the entity identifiers.	Required.Not empty.
`ContainerKey`	`string?`	Gets or sets the container key.
`Operation`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.FavoriteOperationType`	Gets or sets the operation.	Required.

^ Back to top

`BulkMessageInfo`

Describes a bulk message.

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

Properties

Property	Type	Description	Rules
`Message`	`string`	Gets or sets the message.	Required.
`Details`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.MessageInfoDetails>?`	Gets or sets the details.

^ Back to top

`BulkOperationDetailResponse`

Describes a bulk operation detail response.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: BulkOperationDetailResponseBase

Properties

Property	Type	Description	Rules
`Message`	`string`	Gets or sets the message.	Required.
`EntityKey`	`string`	Gets or sets the entity key.	Required.
`ErrorCode`	`string?`	Gets or sets the error code.
`StatusCode`	`int?`	Gets or sets the status code.

^ Back to top

`BulkOperationResponse`

Describes a bulk operation response.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: BulkOperationResponseBase

Properties

Property	Type	Description	Rules
`Message`	`string`	Gets or sets the message.	Required.
`Details`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationDetailResponse>`	Gets or sets the details.	Required.

^ Back to top

`BulkResendExportUrlData`

Describes a bulk resend export URL.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: BulkResendExportUrlDataBase

Properties

Property	Type	Description	Rules
`Ids`	`System.Collections.Generic.IList<int>`	Gets or sets the ids.	Required.Not empty.
`Emails`	`System.Collections.Generic.IList<string>`	Gets or sets the emails.	Required.Not empty.

^ Back to top

`BulkSmartFolderAccess`

Describes a bulk smart folder access.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: BulkSmartFolderAccessBase

Properties

Property	Type	Description	Rules
`SmartFolderKey`	`string`	Gets or sets the smart folder key.	Required.
`NotifyNewUsers`	`bool`	If true, new users should be notified.	Required.
`Users`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkSmartFolderUserData>`	Gets or sets the users.	Required.

^ Back to top

`BulkSmartFolderUserData`

Describes a bulk smart folder user.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: BulkSmartFolderUserDataBase (SmartFolderUserData)

Properties

Property	Type	Description	Rules
`Email`	`string?`	Gets or sets the email.
`Username`	`string?`	Gets or sets the username.

^ Back to top

`BulkUploadMessage`

Describes a bulk upload message.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: BulkUploadMessageBase

Properties

Property	Type	Description	Rules
`SuccessfulFiles`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.UploadArchiveMessage>`	Gets or sets the successful files.	Required.
`UnsuccessfulFiles`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.UploadArchiveMessage>`	Gets or sets the unsuccessful files.	Required.

^ Back to top

`ColumnItem`

Describes a column item.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: ColumnItemBase

Properties

Property	Type	Description	Rules
`Key`	`string`	Gets or sets the key.	Required.
`Description`	`string?`	Gets or sets the description.
`Order`	`int`	Gets or sets the order.	Required.

^ Back to top

`CompanyData`

Describes a company.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CompanyDataBase

Properties

Property	Type	Description	Rules
`CountryCode`	`string`	Gets or sets the country code.	Required.
`TaxId`	`string`	Gets or sets the tax id.	Required.
`Description`	`string?`	Gets or sets the company description or name.
`IsDemo`	`bool`	Whether the company is for demonstration.	Required.
`IsExternalManaged`	`bool`	Whether the company is managed by a third party.	Required.
`ContainerKey`	`string?`	Gets or sets the container key.
`IsInactive`	`bool?`	Indicates if the container is flagged as inactive.
`WithLock`	`bool`	Whether this entity is locked by a pending operation.	Required.
`Accesses`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.AccessControl>?`	Gets or sets the accesses.
`SmartFolders`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ContainerSmartFolder>?`	Gets or sets the smart folders.
`Senders`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.Contact>?`	Gets or sets the senders.

^ Back to top

`Contact`

Describes a contact.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: ContactBase

Properties

Property	Type	Description	Rules
`Name`	`string?`	Gets or sets the name.
`Contact`	`string`	Gets or sets the contact.	Required.
`CompanyTaxId`	`string`	Gets or sets the company tax id.	Required.
`Type`	`string`	Gets or sets the type.	Required.
`IsDeleted`	`bool`	Whether the contact is deleted.	Required.

^ Back to top

`Container`

Describes a container.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: ContainerBase

Properties

Property	Type	Description	Rules
`ContainerKey`	`string?`	Gets or sets the container key.

^ Back to top

`ContainerInfo`

Describes a container.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: ContainerInfoBase (CompanyData)

Properties

Property	Type	Description	Rules
`Workspace`	`string`	Gets or sets the workspace.	Required.
`Organization`	`string`	Gets or sets the organization.	Required.
`AppInstance`	`string`	Gets or sets the app instance.	Required.
`Id`	`string?`	Gets or sets the id.
`IsCompany`	`bool?`	Whether the container represents a company.
`IsDeleted`	`bool`	Whether the container is deleted.	Required.

^ Back to top

`ContainerOverview`

Describes a container overview.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: ContainerOverviewBase (CompanyData)

Properties

Property	Type	Description	Rules
`Id`	`string`	Gets or sets the id.	Required.
`Documents`	`int`	Gets or sets the number of container documents.	Required.
`Storage`	`long`	Gets or sets the storage in bytes.	Required.
`IsDeleted`	`bool`	Whether the container is deleted.	Required.

^ Back to top

`ContainerSmartFolder`

Describes a container smart folder.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: ContainerSmartFolderBase

Properties

Property	Type	Description	Rules
`Key`	`string`	Gets or sets the smart folder key.	Required.
`Users`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderUserData>?`	Gets or sets the users.

^ Back to top

`ContainerTree`

Describes a container tree.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: ContainerTreeBase

Properties

Property	Type	Description	Rules
`Container`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ContainerInfo`	Gets or sets the container.	Required.
`States`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BaseCustomState>?`	Gets or sets a list of container smart folders available states.
`Categories`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BaseCustomCategory>?`	Gets or sets a list of container smart folders available categories.
`Fields`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BaseCustomMetadata>?`	Gets or sets a list of container smart folders available fields.
`SmartFolders`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderTree>`	Gets or sets the list of smart folders tree.	Required.
`Users`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.UserAccessListResponse`	Gets or sets the list of users and accesses.	Required.
`Groupings`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BaseGroupingData>?`	Gets or sets the groupings.

^ Back to top

`CountResult`

Describes a count result.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CountResultBase

Properties

Property	Type	Description	Rules
`Key`	`string`	Gets or sets the key.	Required.
`Count`	`int`	Gets or sets the count.	Required.

^ Back to top

`CreditorData`

Describes a creditor.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CreditorDataBase

Properties

Property	Type	Description	Rules
`CreditorAccount`	`string?`	Gets or sets the creditor account.
`Name`	`string?`	Gets or sets the name.

^ Back to top

`CustomCategoryData`

Describes a custom category.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CustomCategoryDataBase (BaseCustomCategory)

Properties

Property	Type	Description	Rules
`IsSystem`	`bool`	Gets or sets a value indicating whether the document category is assigned as a system entity.	Required.
`ModifiedBy`	`string?`	Gets or sets the modified by.
`ModifiedDate`	`System.DateTime?`	Gets or sets the modified date.
`CreatedDate`	`System.DateTime?`	Gets or sets the created date.
`CreatedBy`	`string?`	Gets or sets the created by.
`Translations`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.TranslationFieldData>?`	Gets or sets the list of fields translation.

^ Back to top

`CustomEntities`

Describes a custom entities.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CustomEntitiesBase

Properties

Property	Type	Description	Rules
`States`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData>`	Gets or sets the list of custom states.	Required.
`Categories`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData>`	Gets or sets the list of custom categories.	Required.
`Fields`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData>?`	Gets or sets the list of custom fields.

^ Back to top

`CustomFieldData`

Describes a custom field.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CustomFieldDataBase

Properties

Property	Type	Description	Rules
`Key`	`string`	Gets or sets the key.	Required.
`Value`	`string?`	Gets or sets the text value.
`ValueBool`	`bool?`	Gets or sets the boolean value.
`ValueNumber`	`decimal?`	Gets or sets the integer or decimal value.
`ValueDate`	`System.DateTime?`	Gets or sets the date or date and time value.

^ Back to top

`CustomMetadataBooleanConfiguration`

Describes a custom metadata boolean configuration.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CustomMetadataBooleanConfigurationBase

Properties

Property	Type	Description	Rules
`AllowUndeterminedValues`	`bool?`	If true value can be undeterminated.

^ Back to top

`CustomMetadataData`

Describes a custom metadata.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CustomMetadataDataBase (BaseCustomMetadata)

Properties

Property	Type	Description	Rules
`IsSystem`	`bool`	Gets or sets a value indicating whether the document metadata is assigned as a system entity.	Required.
`ModifiedBy`	`string?`	Gets or sets the user key that modified the entity.
`ModifiedDate`	`System.DateTime?`	Gets or sets the modified date.
`CreatedDate`	`System.DateTime?`	Gets or sets the created date.
`CreatedBy`	`string?`	Gets or sets the user key that created the entity.
`Translations`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.TranslationFieldData>?`	Gets or sets the list of fields translation.

^ Back to top

`CustomMetadataListConfiguration`

Describes a custom metadata list configuration.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CustomMetadataListConfigurationBase

Properties

Property	Type	Description	Rules
`AllowEmpty`	`bool`	If select box set as the metatda field component, whether to allow an empty value to be selected.	Required.
`Values`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataListValue>`	Gets or sets the ordered list values.	Required.

^ Back to top

`CustomMetadataListValue`

Describes a custom metadata list value.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CustomMetadataListValueBase

Properties

Property	Type	Description	Rules
`Order`	`int`	Gets or sets the order.	Required.
`Value`	`string`	Gets or sets the value.	Required.

^ Back to top

`CustomMetadataNumericConfiguration`

Describes a custom metadata numeric configuration.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CustomMetadataNumericConfigurationBase

Properties

Property	Type	Description	Rules
`DecimalPlaces`	`int`	Gets or sets the decimal places.	Required.
`MaxValue`	`decimal?`	Gets or sets the maximum value.
`MinValue`	`decimal?`	Gets or sets the minimum value.
`StepValue`	`decimal?`	Gets or sets the step value.
`MaxLength`	`int?`	Gets or sets the maximum length.

^ Back to top

`CustomMetadataTextConfiguration`

Describes a custom metadata text configuration.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CustomMetadataTextConfigurationBase

Properties

Property	Type	Description	Rules
`MaxLength`	`int?`	Gets or sets the maximum length.
`Mask`	`string?`	Gets or sets the mask.

^ Back to top

`CustomStateData`

Describes a custom state.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: CustomStateDataBase (BaseCustomState)

Properties

Property	Type	Description	Rules
`ModifiedBy`	`string?`	Gets or sets the modified by.
`ModifiedDate`	`System.DateTime?`	Gets or sets the modified date.
`CreatedDate`	`System.DateTime?`	Gets or sets the created date.
`CreatedBy`	`string?`	Gets or sets the created by.
`IsSystem`	`bool`	Gets or sets a value indicating whether the document state is assigned as a system entity.	Required.
`Translations`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.TranslationFieldData>?`	Gets or sets the list of fields translation.

^ Back to top

`DebtorAccountData`

Describes a debtor account.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DebtorAccountDataBase

Properties

Property	Type	Description
`BankAccountName`	`string?`	Gets or sets the bank account name.
`Bic`	`string?`	Gets or sets the bic.
`IbanNumber`	`string?`	Gets or sets the iban number.

^ Back to top

`DebtorData`

Describes a debtor.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DebtorDataBase

Properties

Property	Type	Description	Rules
`DebtorAccount`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.DebtorAccountData`	Gets or sets the debtor account.	Required.
`Name`	`string?`	Gets or sets the name.

^ Back to top

`DeprovisioningStateData`

Describes a deprovisioning state.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DeprovisioningStateDataBase

Properties

Property	Type	Description	Rules
`Entity`	`string`	Gets or sets the entity.	Required.
`Cleared`	`bool`	If entity was cleared or not.	Required.

^ Back to top

`DistinctFields`

Describes a distinct fields.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DistinctFieldsBase

Properties

Property	Type	Description	Rules
`Fields`	`System.Collections.Generic.IList<string>`	Gets or sets the fields.	Required.Not empty.
`AfterKey`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.KeyValueData>?`	Gets or sets the after key.

^ Back to top

`DistinctResult`

Describes a distinct result.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DistinctResultBase

Properties

Property	Type	Description	Rules
`AfterKey`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.KeyValueData>?`	Gets or sets the after key.
`Value`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DistinctValue>`	Gets or sets the value.	Required.

^ Back to top

`DistinctValue`

Describes a distinct value.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DistinctValueBase

Properties

Property	Type	Description	Rules
`Properties`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.KeyValueData>?`	Gets or sets the properties.

^ Back to top

`DocumentBaseData`

Describes a document base.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DocumentBaseDataBase

Properties

Property	Type	Description
`DocumentType`	`string?`	Gets or sets the document type.
`DocumentStatus`	`string?`	Gets or sets the document status.
`DocumentDate`	`System.DateTime?`	Gets or sets the document date.
`DocumentNo`	`string?`	Gets or sets the document number.
`SupplierInfo`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.PartyInformationData?`	Gets or sets the supplier.
`CustomerInfo`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.PartyInformationData?`	Gets or sets the customer.
`CurrencyCode`	`string?`	Gets or sets the currency code.
`AtCud`	`string?`	Gets or sets the at cud.
`HashControl`	`string?`	Gets or sets the hash control.
`CertificateNumber`	`string?`	Gets or sets the certificate number.
`Lines`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentLineData>?`	Gets or sets the lines.
`Payments`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentPaymentData>?`	Gets or sets the payments.
`TaxInformation`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.TaxInformationData>?`	Gets or sets the tax information.
`WithholdingTax`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.WithholdingTaxData?`	Gets or sets the withholding tax.
`DocumentTotals`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentTotalData?`	Gets or sets the document totals.
`DocumentUrl`	`string?`	Gets or sets the document url.
`BankAccountEntry`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.BankAccountData?`	Gets or sets the bank account entry.
`GeneralLedgerEntry`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.GeneralLedgerEntryData?`	Gets or sets the general ledger entry.
`CompanyTaxId`	`string?`	Gets or sets the company tax id.
`CompanyName`	`string?`	Gets or sets the company name.

^ Back to top

`DocumentData`

Describes a document.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DocumentDataBase

Properties

Property	Type	Description	Rules
`Id`	`string`	Gets or sets the id.	Required.
`Version`	`int?`	Gets or sets the version.
`FileName`	`string?`	Gets or sets the file name.
`ContainerName`	`string?`	Gets or sets the container name.
`ContainerTaxId`	`string?`	Gets or sets the container tax id.
`ContainerKey`	`string?`	Gets or sets the container key.
`SentBy`	`string?`	Gets or sets the sent by.
`UploadDate`	`System.DateTime?`	Gets or sets the upload date.
`UpdatedBy`	`string?`	Gets or sets the updated by.
`LastEntryDate`	`System.DateTime?`	Gets or sets the last entry date.
`IsLocked`	`bool?`	Whether the document is locked.
`IsTaxRelevant`	`bool?`	Whether the document is tax relevant.
`IsDeleted`	`bool?`	Whether the document is deleted.
`DeletedBy`	`string?`	Gets or sets the deleted by.
`DeletedDate`	`System.DateTime?`	Gets or sets the deleted date.
`Category`	`string?`	Gets or sets the category.
`State`	`int`	Gets or sets the document state.	Required.
`FileContentUrl`	`string?`	Gets or sets the file content url.
`Remarks`	`string?`	Gets or sets the remarks. Text is truncated to 255 characters.
`FavoriteBy`	`System.Collections.Generic.IList<string>?`	Gets or sets the list of favorites by user.
`Tags`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentTagData>?`	Gets or sets the tags.
`Sources`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SourceData>?`	Gets or sets the sources.
`CustomFields`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomFieldData>?`	Gets or sets the custom fields in key/value pairs.
`Document`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentBaseData?`	Gets or sets the document.
`SmartFolderKey`	`string?`	Gets or sets the smart folder key.
`Checksum`	`string?`	An alphanumeric value that uniquely represents the contents of a file.
`FileSize`	`long`	Gets or sets the file size.	Required.
`WithLock`	`bool`	Whether this entity is locked by a pending operation.	Required.

^ Back to top

`DocumentGenericData`

Describes a document generic.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DocumentGenericDataBase

Properties

Property	Type	Description	Rules
`Id`	`string`	Gets or sets the id.	Required.
`FileName`	`string?`	Gets or sets the file name.
`ContainerKey`	`string?`	Gets or sets the container key.
`ContainerTaxId`	`string?`	Gets or sets the container tax id.
`ContainerName`	`string?`	Gets or sets the container name.
`SmartFolderName`	`string?`	Gets or sets the smart folder name.
`SmartFolderIcon`	`string?`	Gets or sets the smart folder icon.
`SmartFolderKey`	`string?`	Gets or sets the smart folder key.
`LastEntryDate`	`System.DateTime?`	Gets or sets the last entry date.
`FileSize`	`long`	Gets or sets the file size.	Required.
`WithLock`	`bool`	Whether this entity is locked by a pending operation.	Required.
`State`	`int`	Gets or sets the document state.	Required.

^ Back to top

`DocumentLineData`

Describes a document line.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DocumentLineDataBase

Properties

Property	Type	Description	Rules
`LineNumber`	`long?`	Gets or sets the line number.
`ProductCode`	`string?`	Gets or sets the product code.
`ProductDescription`	`string?`	Gets or sets the product description.
`ProductType`	`string?`	Gets or sets the product type.
`Quantity`	`decimal?`	Gets or sets the quantity.
`UnitPrice`	`decimal?`	Gets or sets the unit price.
`TaxBase`	`decimal?`	Gets or sets the tax base.
`Amount`	`decimal?`	Gets or sets the amount.
`DebitCreditIndicator`	`string?`	Gets or sets the debit credit indicator.
`Tax`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.TaxInformationData`	Gets or sets the tax.	Required.

^ Back to top

`DocumentPaymentData`

Describes a document payment.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DocumentPaymentDataBase

Properties

Property	Type	Description
`PaymentMechanism`	`string?`	Gets or sets the payment mechanism.
`PaymentDescription`	`string?`	Gets or sets the payment description.
`OriginatingOn`	`string?`	Gets or sets the originating on.
`SettlementAmount`	`decimal?`	Gets or sets the settlement amount.
`PaymentAmount`	`decimal?`	Gets or sets the payment amount.
`PaymentDate`	`System.DateTime?`	Gets or sets the payment date.

^ Back to top

`DocumentsBulkData`

Describes a documents bulk.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DocumentsBulkDataBase

Properties

Property	Type	Description	Rules
`ContainerKey`	`string`	Gets or sets the container key.	Required.
`Documents`	`System.Collections.Generic.IList<string>`	Gets or sets the documents ids.	Required.Not empty.

^ Back to top

`DocumentTagData`

Describes a document tag.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DocumentTagDataBase

Properties

Property	Type	Description	Rules
`UserKey`	`string?`	Gets or sets the user key.
`Tag`	`string?`	Gets or sets the tag.

^ Back to top

`DocumentTotalData`

Describes a document total.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DocumentTotalDataBase

Properties

Property	Type	Description
`NetTotal`	`decimal?`	Gets or sets the net total.
`VatTotal`	`decimal?`	Gets or sets the vat total.
`StampTaxTotal`	`decimal?`	Gets or sets the stamp tax total.
`TaxPayable`	`decimal?`	Gets or sets the tax payable.
`GrossTotal`	`decimal?`	Gets or sets the gross total.
`SettlementAmount`	`decimal?`	Gets or sets the settlement amount.

^ Back to top

`DocumentUsage`

Describes a document usage.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: DocumentUsageBase

Properties

Property	Type	Description	Rules
`DocumentId`	`string`	Gets or sets the document id.	Required.
`DocumentDescription`	`string`	Gets or sets the document description.	Required.

^ Back to top

`ElasticSearchDocumentKeysData`

Describes an elastic search document keys.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: ElasticSearchDocumentKeysDataBase

Properties

Property	Type	Description	Rules
`ContainerId`	`string`	Gets or sets the container id.	Required.
`Id`	`string`	Gets or sets the document id.	Required.
`ParentId`	`string?`	Gets or sets the parent document id.

^ Back to top

`EmptyResponse`

Describes an empty response.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: EmptyResponseBase

Properties

Property	Type	Description	Rules
`Id`	`string`	Gets or sets the id.	Required.
`Name`	`string`	Gets or sets the name.	Required.
`Message`	`string`	Gets or sets the restore status message.	Required.
`Key`	`string?`	Gets or sets the key.
`Type`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.DeletedEntityType`	Gets or sets the type.	Required.

^ Back to top

`EntityBase`

Describes an entity.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: EntityBaseBase

Properties

Property	Type	Description	Rules
`Id`	`int`	Gets or sets the id.	Required.

^ Back to top

`EventLogData`

Describes an event log.

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

Properties

Property	Type	Description	Rules
`Workspace`	`string`	Gets or sets the workspace.	Required.
`Organization`	`string`	Gets or sets the organization.	Required.
`AppInstance`	`string`	Gets or sets the app instance.	Required.
`ContainerKey`	`string?`	Gets or sets the container key.
`Code`	`string`	Gets or sets the code.	Required.
`SourceSchemaEntity`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.SourceSchemaEntity`	Gets or sets the source schema entity.	Required.
`SourceKey`	`string?`	Gets or sets the source key.
`Date`	`System.DateTime`	Gets or sets the date.	Required.
`User`	`string`	Gets or sets the user.	Required.
`UserId`	`string`	Gets or sets the user id.	Required.
`Message`	`System.Collections.Generic.IList<string>`	Gets or sets the message.	Required.Not empty.
`FriendlyMessage`	`string?`	Gets or sets the friendly message.
`EventLevel`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.EventLevel`	Gets or sets the event level.	Required.
`IsSystem`	`bool`	Whether the event was fired by the system.	Required.
`GroupId`	`string?`	Gets or sets the group id.

^ Back to top

`EventLogListResponse`

Describes an event log list response.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: EventLogListResponseBase

Properties

Property	Type	Description	Rules
`EventsLog`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.EventLogData>`	Gets or sets the events log.	Required.

^ Back to top

`ExpressionReturnValue`

Describes an expression return value.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: ExpressionReturnValueBase

Properties

Property	Type	Description	Rules
`Value`	`string`	Gets or sets the return value.	Required.
`Type`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ExpressionReturnValueType`	Gets or sets the return value type.	Required.
`TypeAsText`	`string`	Gets or sets the type as text.	Required.

^ Back to top

`FavoriteEntry`

Describes a favorite entry.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: FavoriteEntryBase (DocumentGenericData)

Properties

Property	Type	Description
`Category`	`string?`	Gets or sets the category.
`SentBy`	`string?`	Gets or sets the sent by.
`SentDate`	`System.DateTime?`	Gets or sets the sent date.
`Remarks`	`string?`	Gets or sets the remarks.
`UpdatedBy`	`string?`	Gets or sets the updated by.

^ Back to top

`File`

Describes a file.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: FileBase

Properties

Property	Type	Description	Rules
`Name`	`string`	Gets or sets the name.	Required.
`ContentType`	`string`	Gets or sets the content type.	Required.
`Data`	`byte[]`	Gets or sets the data.	Required.

^ Back to top

`GeneralLedgerEntryData`

Describes a general ledger entry.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: GeneralLedgerEntryDataBase

Properties

Property	Type	Description
`TransactionUrl`	`string?`	Gets or sets the transaction url.
`SubscriptionId`	`string?`	Gets or sets the subscription id.
`CostCenterId`	`string?`	Gets or sets the cost center id.
`Journal`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.JournalData?`	Gets or sets the journal.
`Transaction`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.TransactionData?`	Gets or sets the transaction.

^ Back to top

`GroupingData`

Describes a grouping.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: GroupingDataBase (BaseGroupingData)

Properties

Property	Type	Description	Rules
`IsSystem`	`bool`	Gets or sets a value indicating whether the grouping is assigned as a system entity.	Required.
`IsExternalManaged`	`bool`	Gets or sets a value indicating whether the grouping is assigned as externally managed.	Required.
`ModifiedBy`	`string?`	Gets or sets the modified by.
`ModifiedDate`	`System.DateTime?`	Gets or sets the modified date.
`CreatedDate`	`System.DateTime?`	Gets or sets the created date.
`CreatedBy`	`string?`	Gets or sets the created by.
`Translations`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.TranslationFieldData>?`	Gets or sets the list of fields translation.

^ Back to top

`GroupingFolderConfiguration`

Describes a grouping folder configuration.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: GroupingFolderConfigurationBase

Properties

Property	Type	Description	Rules
`Order`	`int`	Gets or sets the order.	Required.
`Folder`	`string`	Gets or sets the folder key.	Required.

^ Back to top

`InProcessingOrErrorEntry`

Describes an in processing or error entry.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: InProcessingOrErrorEntryBase (DocumentGenericData)

Properties

Property	Type	Description	Rules
`SentBy`	`string?`	Gets or sets the sent by.
`SentDate`	`System.DateTime?`	Gets or sets the sent date.

^ Back to top

`JournalData`

Describes a journal.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: JournalDataBase

Properties

Property	Type	Description	Rules
`JournalId`	`string?`	Gets or sets the journal id.
`Description`	`string?`	Gets or sets the description.

^ Back to top

`KeyValueData`

Describes a key value.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: KeyValueDataBase

Properties

Property	Type	Description	Rules
`Key`	`string`	Gets or sets the key.	Required.
`Value`	`string?`	Gets or sets the value.

^ Back to top

`KeyValueDocument`

Describes a key value document.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: KeyValueDocumentBase

Properties

Property	Type	Description	Rules
`ContainerKey`	`string`	Gets or sets the container key.	Required.
`Id`	`string`	Gets or sets the id.	Required.
`Properties`	`System.Collections.Generic.IDictionary<string, string?>?`	Gets or sets the properties.	Not empty.

^ Back to top

`MenuData`

Describes a menu.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: MenuDataBase

Properties

Property	Type	Description	Rules
`MenuItems`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.MenuItemData>?`	Gets or sets the menu items.
`DefaultActions`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.MenuDefaultActionData>`	Gets or sets the default actions.	Required.

^ Back to top

`MenuDefaultActionData`

Describes a menu default action.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: MenuDefaultActionDataBase

Properties

Property	Type	Description	Rules
`ContextUri`	`string`	Gets or sets the context uri.	Required.
`Icon`	`string?`	Gets or sets the icon.
`Caption`	`string`	Gets or sets the caption.	Required.
`Hidden`	`bool`	Sets or gets a value indicating whether the menu default action is hidden or not.	Required.
`ViewTitle`	`string`	Gets or sets the view title.	Required.

^ Back to top

`MenuItemData`

Describes a menu item.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: MenuItemDataBase

Properties

Property	Type	Description	Rules
`Id`	`System.Guid`	Gets or sets the id.	Required.Not empty.
`Uri`	`string?`	Gets or sets the uri.
`Caption`	`string`	Gets or sets the caption.	Required.
`Icon`	`string?`	Gets or sets the icon.
`MenuItems`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.MenuItemData>?`	Gets or sets the menu items.

^ Back to top

`MessageInfo`

Describes a message.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: MessageInfoBase

Properties

Property	Type	Description	Rules
`Message`	`string`	Gets or sets the message.	Required.
`Details`	`System.Collections.Generic.IList<string>?`	Gets or sets the details.

^ Back to top

`MessageInfoDetails`

Describes a message info details.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: MessageInfoDetailsBase

Properties

Property	Type	Description	Rules
`Id`	`string`	Gets or sets the id.	Required.
`Details`	`string?`	Gets or sets the details.

^ Back to top

`PartyInformationData`

Describes a party information.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: PartyInformationDataBase

Properties

Property	Type	Description
`TaxNumber`	`string?`	Gets or sets the tax number.
`Name`	`string?`	Gets or sets the name.
`CountryCode`	`string?`	Gets or sets the country code.

^ Back to top

`ProvisioningStateData`

Describes a provisioning state.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: ProvisioningStateDataBase

Properties

Property	Type	Description	Rules
`Message`	`string`	Gets or sets the message.	Required.
`State`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.ProvisioningState`	Gets or sets the state.	Required.

^ Back to top

`RecycleBinEntry`

Describes a recycle bin entry.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: RecycleBinEntryBase (DocumentGenericData)

Properties

Property	Type	Description	Rules
`IsExternalManaged`	`bool?`	Whether the recycle bin entry is manaed by a third party.
`DeletedBy`	`string?`	Gets or sets the deleted by.
`DeletedDate`	`System.DateTime?`	Gets or sets the deleted date.
`Type`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.DeletedEntityType`	Gets or sets the type.	Required.
`Category`	`string?`	Gets or sets the category.
`AllowUpdate`	`bool?`	Gets or sets a value indicating if the current user has access to restore or permanently delete the document entry.

^ Back to top

`RestoreDocumentsRequest`

Describes a restore documents request.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: RestoreDocumentsRequestBase

Properties

Property	Type	Description	Rules
`Documents`	`System.Collections.Generic.IList<string>`	Gets or sets the documents.	Required.Not empty.
`ContainerKey`	`string`	Gets or sets the container key.	Required.

^ Back to top

`RestoreResponse`

Describes a restore response.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: RestoreResponseBase

Properties

Property	Type	Description	Rules
`Id`	`string`	Gets or sets the id.	Required.
`Name`	`string`	Gets or sets the name.	Required.
`Message`	`string`	Gets or sets the restore status message.	Required.
`Key`	`string?`	Gets or sets the key.

^ Back to top

`SmartFolderCategoryData`

Describes a smart folder category.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: SmartFolderCategoryDataBase

Properties

Property	Type	Description	Rules
`Key`	`string`	Gets or sets the category key.	Required.
`IsDefault`	`bool`	Gets or sets a value indicating whether the category is default or not. When this value is true means that this category will be assigned to the document imported into the folder when the category is not defined. Only one categorycan be setted as default by folder.	Required.
`Order`	`int?`	Gets or sets the order.

^ Back to top

`SmartFolderData`

Describes a smart folder.

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

Properties

Property	Type	Description	Rules
`Key`	`string`	Gets or sets the smart folder key.	Required.
`Name`	`string`	Gets or sets the name.	Required.
`Description`	`string?`	Gets or sets the description.
`Icon`	`string?`	Gets or sets the icon.
`Group`	`string?`	Gets or sets the group.
`IsExternalManaged`	`bool`	Indicates that the folder is managed by an external application.	Required.
`IsDefault`	`bool`	Indicates that whenever new containers are created, the folder must also be created. When creating a new default folder, when recording it must be created in all containers.	Required.
`IsDeleted`	`bool`	Gets or sets a value indicating whether the folder is deleted or not.	Required.
`IsSystem`	`bool`	Gets or sets a value indicating whether the folder is a system entity or not.	Required.
`IsHidden`	`bool`	Gets or sets a value indicating whether the folder should be hidden or not.	Required.
`IsReadOnly`	`bool?`	Gets or sets a value indicating whether the folder is read only or not.
`CreateSubFolders`	`bool`	Gets or sets a value indicating if is to create the sub-folders specified on SubFolders property.	Required.
`DescriptionTooltip`	`bool`	Whether to show description as a tooltip.	Required.
`ShowFieldsExpanded`	`bool?`	Gets or sets a value indicating if is the smart folder fields expander on documents details view is expanded by default.
`ContainerKeys`	`System.Collections.Generic.IList<string>?`	Gets or sets the container keys.
`States`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderStateData>`	Gets or sets the states.	Required.
`Categories`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderCategoryData>`	Gets or sets the categories.	Required.
`Fields`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderFieldData>?`	Gets or sets the fields.
`SubFolders`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderSubFolderData>?`	Gets or sets the sub folders structure.
`Users`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderUserData>?`	Gets or sets the users.
`ModifiedDate`	`System.DateTime?`	Gets or sets the modified date.
`ModifiedBy`	`string?`	Gets or sets the modified by.
`CreatedDate`	`System.DateTime?`	Gets or sets the created date.
`CreatedBy`	`string?`	Gets or sets the created by.
`Translations`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.TranslationFieldData>?`	Gets or sets the list of fields translation.
`WithLock`	`bool`	Whether this entity is locked by a pending operation.	Required.

^ Back to top

`SmartFolderFieldData`

Describes a smart folder field.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: SmartFolderFieldDataBase

Properties

Property	Type	Description	Rules
`Key`	`string`	Gets or sets the field key.	Required.
`Visible`	`bool`	Gets or sets a value indicating whether the field should be visible in the grid or not.	Required.
`Required`	`bool`	Gets or sets a value indicating whether the field should be mandatory to fill or not.	Required.
`DefaultValue`	`string?`	Gets or sets the default value.
`DefaultValueAsExpression`	`bool?`	Whether the default value is a custom expression.
`Order`	`int?`	Gets or sets the order.
`Width`	`string?`	Gets or sets the width.
`IsReadOnly`	`bool?`	Indicates if the property is read only or not.
`FieldType`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderFieldType`	Gets or sets the field type.	Required.

^ Back to top

`SmartFolderStateData`

Describes a smart folder state.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: SmartFolderStateDataBase

Properties

Property	Type	Description	Rules
`Key`	`int`	Gets or sets the numeric state key.	Required.
`IsDefault`	`bool`	Gets or sets a value indicating whether the state is default or not. When this value is true means that this state will be assigned to the document imported into the folder when the state is not defined. Only one state can be setted as default by folder.	Required.
`Order`	`int?`	Gets or sets the order.

^ Back to top

`SmartFolderSubFolderData`

Describes a smart folder sub folder.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: SmartFolderSubFolderDataBase

Properties

Property	Type	Description	Rules
`Key`	`string?`	Gets or sets the id of the subfolder. Can be a "State", "Category", or the key of a metadata field.
`Type`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.SubFolderType`	Gets or sets the type.	Required.
`Level`	`int`	Gets or sets the level of the subfolder.	Required.

^ Back to top

`SmartFolderTree`

Describes a smart folder tree.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: SmartFolderTreeBase (BaseSmartFolderTree)

Properties

Property	Type	Description	Rules
`Name`	`string`	Gets or sets the name.	Required.
`Description`	`string`	Gets or sets the description.	Required.
`Icon`	`string?`	Gets or sets the icon.
`Group`	`string?`	Gets or sets the group.
`IsExternalManaged`	`bool`	Indicates that the folder is managed by an external application.	Required.
`IsSystem`	`bool?`	Gets or sets a value indicating whether the folder is a system entity or not.
`IsReadOnly`	`bool`	Gets or sets a value indicating whether the folder is read only or not.	Required.
`DescriptionTooltip`	`bool`	Gets or sets the scalar property 1.	Required.
`Users`	`System.Collections.Generic.IDictionary<string, string>`	Gets or sets the list of allowed users and profiles.	Required.Not empty.
`SubFolders`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderTreeSubFolder>?`	Gets or sets the sub folders.
`LoadSubFolders`	`bool`	Whether to load or not the smart folder's subfolders.	Required.

^ Back to top

`SmartFolderTreeCategory`

Describes a smart folder tree category.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: SmartFolderTreeCategoryBase (BaseSmartFolderTree)

Properties

The model has no properties.

^ Back to top

`SmartFolderTreeMetadataField`

Describes a smart folder tree metadata field.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: SmartFolderTreeMetadataFieldBase (BaseSmartFolderTree)

Properties

Property	Type	Description
`Value`	`string?`	Gets or sets the value.
`IsDefault`	`bool?`	If this flag is active, this metadata will be automatically selected when creating custom folders.
`Visible`	`bool?`	Gets or sets a value indicating whether the field should be visible in the grid or not.
`Required`	`bool?`	Gets or sets a value indicating whether the field should be mandatory to fill or not.
`Width`	`string?`	Gets or sets the width.
`Type`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataType?`	Gets or sets the type.
`IsReadOnly`	`bool?`	Indicates if the property is read only or not.

^ Back to top

`SmartFolderTreeState`

Describes a smart folder tree state.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: SmartFolderTreeStateBase

Properties

Property	Type	Description	Rules
`Key`	`int`	Gets or sets the smart folder state key.	Required.
`Count`	`int`	Gets or sets the document count.	Required.
`Storage`	`long`	Gets or sets the storage in bytes.	Required.
`Order`	`int?`	Gets or sets the order.

^ Back to top

`SmartFolderTreeSubFolder`

Describes a smart folder tree sub folder.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: SmartFolderTreeSubFolderBase

Properties

Property	Type	Description	Rules
`Level`	`int`	Gets or sets the level of the subfolder.	Required.
`IsSystem`	`bool?`	Gets or sets a value indicating whether the folder is a system entity or not.
`Type`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.SubFolderType`	Gets or sets the type.	Required.
`State`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderTreeState?`	Gets or sets the state.
`Category`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderTreeCategory?`	Gets or sets the category.
`Field`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderTreeMetadataField?`	Gets or sets the custom fields.
`SubFolders`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderTreeSubFolder>?`	Gets or sets the sub folders.

^ Back to top

`SmartFolderUserData`

Describes a smart folder user.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: SmartFolderUserDataBase

Properties

Property	Type	Description	Rules
`ContainerKey`	`string`	Gets or sets the container key.	Required.
`Identity`	`string`	Gets or sets the user identity.	Required.
`Profile`	`string`	Gets or sets the profile.	Required.

^ Back to top

`SourceData`

Describes a source.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: SourceDataBase

Properties

Property	Type	Description	Rules
`Source`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.SourceType`	Gets or sets the source.	Required.
`SourceId`	`string?`	Gets or sets the source id.

^ Back to top

`StorageSizeData`

Describes a storage size.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: StorageSizeDataBase

Properties

Property	Type	Description	Rules
`Key`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.StorageSizeKeyData`	Gets or sets the key(s).	Required.
`Size`	`long`	Gets or sets the size.	Required.
`Count`	`long?`	Gets or sets the document count.

^ Back to top

`StorageSizeKeyData`

Describes a storage size key.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: StorageSizeKeyDataBase

Properties

Property	Type	Description
`AppInstanceKey`	`string?`	Gets or sets the app instance key.
`ContainerKey`	`string?`	Gets or sets the container key.
`SmartFolderKey`	`string?`	Gets or sets the smart folder key.

^ Back to top

`TaskQueueData`

Describes a task queue.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: TaskQueueDataBase

Properties

Property	Type	Description	Rules
`Id`	`System.Guid`	Gets or sets the task queue id.	Required.Not empty.
`Message`	`string`	Gets or sets the message.	Required.
`Status`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.TaskQueueStatus`	Gets or sets the task queue status.	Required.

^ Back to top

`TaxInformationData`

Describes a tax information.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: TaxInformationDataBase

Properties

Property	Type	Description
`TaxCountryRegion`	`string?`	Gets or sets the tax country region.
`TaxType`	`string?`	Gets or sets the tax type.
`TaxCode`	`string?`	Gets or sets the tax code.
`TaxExemptionReason`	`string?`	Gets or sets the tax exemption reason.
`TaxBase`	`decimal?`	Gets or sets the tax base.
`TaxPercentage`	`decimal?`	Gets or sets the tax percentage.
`TaxAmount`	`decimal?`	Gets or sets the tax amount.
`Amount`	`decimal?`	Gets or sets the amount.

^ Back to top

`TransactionData`

Describes a transaction.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: TransactionDataBase

Properties

Property	Type	Description
`TransactionId`	`string?`	Gets or sets the transaction id.
`Period`	`int?`	Gets or sets the period.
`PeriodYear`	`int?`	Gets or sets the period year.
`TransactionDate`	`System.DateTime?`	Gets or sets the transaction date.
`Description`	`string?`	Gets or sets the description.
`DocArchivalNumber`	`string?`	Gets or sets the doc archival number.
`GlPostingDate`	`System.DateTime?`	Gets or sets the gl posting date.
`CurrencyCode`	`string?`	Gets or sets the currency code.
`SystemId`	`string?`	Gets or sets the system id.
`SystemEntryDate`	`System.DateTime?`	Gets or sets the system entry date.

^ Back to top

`TranslationData`

Describes a translation.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: TranslationDataBase

Properties

Property	Type	Description	Rules
`Language`	`string`	Gets or sets the two letter language.	Required.
`Translation`	`string`	Gets or sets the translation.	Required.

^ Back to top

`TranslationFieldData`

Describes a translation field.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: TranslationFieldDataBase

Properties

Property	Type	Description	Rules
`Field`	`string`	Gets or sets the field.	Required.
`Translations`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.TranslationData>`	Gets or sets the list of field translations.	Required.

^ Back to top

`UpdateCompanyData`

Describes an update company.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: UpdateCompanyDataBase

Properties

Property	Type	Description	Rules
`Description`	`string`	Gets or sets the description.	Required.
`IsExternalManaged`	`bool`	Whether the company is managed by a third party.	Required.
`ContainerKey`	`string?`	Gets or sets the container key.
`IsInactive`	`bool?`	Indicates if the container is flagged as inactive.

^ Back to top

`UploadArchiveMessage`

Describes an upload archive message.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: UploadArchiveMessageBase

Properties

Property	Type	Description	Rules
`Id`	`string`	Gets or sets the id.	Required.
`Name`	`string`	Gets or sets the name.	Required.
`State`	`int?`	Gets or sets the state.
`Error`	`string?`	Gets or sets the upload error.
`ErrorCode`	`string?`	Gets or sets the error code.
`StatusCode`	`int?`	Gets or sets the status code.

^ Back to top

`UploadMessage`

Describes an upload message.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: UploadMessageBase

Properties

Property	Type	Description	Rules
`Archives`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.UploadArchiveMessage>`	Gets or sets the archives.	Required.

^ Back to top

`UserAccessListResponse`

Describes an user access list response.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: UserAccessListResponseBase

Properties

Property	Type	Description	Rules
`Users`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.UserData>`	Gets or sets the users.	Required.
`Accesses`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.AccessControlData>?`	Gets or sets the accesses.

^ Back to top

`UserContainerRoleData`

Describes an user container role.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: UserContainerRoleDataBase

Properties

Property	Type	Description	Rules
`ContainerKey`	`string`	Gets or sets the container key.	Required.
`Role`	`string`	Gets or sets the role.	Required.

^ Back to top

`UserData`

Describes an user.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: UserDataBase

Properties

Property	Type	Description	Rules
`UserKey`	`string?`	Gets or sets the user key.
`Name`	`string`	Gets or sets the name.	Required.
`Email`	`string`	Gets or sets the email.	Required.
`Picture`	`string?`	Gets or sets the picture.
`AccessRight`	`Cegid.Lithium.DigitalArchive.Client.Rest.Models.AccessRight`	Gets or sets the user access right.	Required.

^ Back to top

`WithholdingData`

Describes a withholding.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: WithholdingDataBase

Properties

Property	Type	Description
`WithholdingTaxType`	`string?`	Gets or sets the withholding tax type.
`WithholdingTaxDescription`	`string?`	Gets or sets the withholding tax description.
`WithholdingTaxAmount`	`decimal?`	Gets or sets the withholding tax amount.

^ Back to top

`WithholdingTaxData`

Describes a withholding tax.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models
Inheritance: WithholdingTaxDataBase

Properties

Property	Type	Description	Rules
`WithholdingTaxAmountTotal`	`decimal`	Gets or sets the withholding tax amount total.	Required.
`Withholdings`	`System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.WithholdingData>?`	Gets or sets the withholdings.

^ Back to top

Enumerations Classes

`AccessRight`

The access right of the user.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`ReadOnly`	0	Read only access.
`ReadWrite`	1	Read and write access.

^ Back to top

`ArchiveExportState`

Defines an archive export state.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Active`	0	Identifies an active archive export url.
`ToExpire`	1	Identifies a to expire archive export url.
`Expired`	2	Identifies an expired archive export url.

^ Back to top

`ArchiveExportType`

Defines an archive export type.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Full`	0	Identifies a total archive export.
`FiscalRelevantOnly`	1	Identifies an only fiscal relevant archive export.

^ Back to top

`ArchiveOperationType`

Specifies the different document update operation types.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Edit`	0	The edit entry type.
`Delete`	1	The delete entry type.
`Restore`	2	Restore document form recycle bin.
`Move`	3	The move to custom folder operation type.
`ChangeStatus`	4	The change document status operation.

^ Back to top

`ArchiveState`

Specifies the diferente archive states.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Accepted`	1	The accepted state.
`Error`	2	The archive state that represents an archive on error.
`Processed`	3	The processed state.
`RelevantStored`	4	The relevant stored state.
`Stored`	5	The stored state.
`ToAccounting`	6	The to accounting state.
`InAccounting`	7	The in accounting state.

^ Back to top

`ComponentType`

Identifies a component type.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`InputText`	0	An input text component.
`Checkbox`	1	A checkbox component.
`DatePicker`	2	A date picker component.
`SelectBox`	3	A select box component.
`InputNumber`	4	An input number component.
`AreaText`	5	An area text component.
`RadioButton`	6	A radio button component.
`MoneyInput`	7	A money component.
`Divider`	8	A divider component.
`EmptySpace`	9	A empty state component.

^ Back to top

`ContainerExportState`

Describes the container/company current state.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Active`	0	The Active state.
`Inactive`	1	The Inactive state.
`Deleted`	2	The Deleted state.

^ Back to top

`CustomMetadataType`

Identifies a metadata type.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Text`	0	Identifies a text metadata type.
`Integer`	1	Identifies a integer metadata type.
`Decimal`	2	Identifies a decimal metadata type.
`DateTime`	3	Identifies a datetime metadata type.
`Date`	4	Identifies a date metadata type.
`Boolean`	5	Identifies a boolean metadata type.
`List`	6	Identifies a list of values metadata type.
`Calculated`	7	Identifies a calculated metadata type.
`Money`	8	Identifies a date metadata type.

^ Back to top

`CustomStateIndicator`

Defines a document state indicator.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Blue`	0	The document state information indicator.
`Red`	1	The document state error indicator.
`Orange`	2	The document state warning indicator.
`Grey`	3	The document state neutral indicator.
`Green`	4	The document state sucess indicator.

^ Back to top

`DeletedEntityType`

Defines a deleted entity type.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Document`	0	Defines a entity type of document.
`Container`	1	Defines a entity type of container.

^ Back to top

`EventLevel`

The event log entry type.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Information`	0	An information type event.
`Warning`	1	A warning type event.
`Error`	2	An error type event.

^ Back to top

`ExportCsvType`

Defines the type of CSV export.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Container`	0	Export a container list.
`Document`	1	Export a document list.

^ Back to top

`ExpressionReturnValueType`

The expression return value type.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`String`	0	The string type (default).
`Number`	1	The number type (int, decimal, float, double).
`Bool`	2	The boolean type.
`Date`	3	The date or date and time type.
`Array`	4	The array type.

^ Back to top

`FavoriteOperationType`

Enumeration that represents the two options on a favourite opeartion.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Mark`	0	Mark entity as favourite.
`Unmark`	1	Unmarks entity as favourite.

^ Back to top

`ProvisioningState`

The existing provisioning states.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Starting`	0	Provisioning is starting.
`Finished`	4	Provisioning is complete.
`Error`	5	An error has ocurred.

^ Back to top

`SmartFolderFieldType`

Indicates the type of field.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`CustomField`	0	The custom field.
`Divider`	1	The divider.
`EmptySpace`	2	The empty state.

^ Back to top

`SourceSchemaEntity`

The request source.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Archives`	0	From arquives.
`Contacts`	1	From contacts.
`Containers`	2	From containers.
`ContainerAccess`	3	Form containers access.
`Activities`	4	From activities.
`Users`	5	From users.
`Apps`	6	From apps.
`Other`	7	Other source.
`RecycleBin`	8	The recycle bin source schema entity.
`CustomStates`	9	The custom states source schema entity.
`CustomMetadata`	10	The custom metadata source schema entity.
`CustomCategories`	11	The custom categories source schema entity.
`SmartFolders`	12	The smart folders source schema entity.

^ Back to top

`SourceType`

A document source type enumerator.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`QrCode`	0	The QrCode type.
`EFatura`	1	The eFatura type.
`EArrendamento`	2	The eArrendamento type.
`RecibosVerdes`	3	The Recibos Verdes type.

^ Back to top

`StorageSizeGroupOption`

Identifies a storage size 'group by' option.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`AppInstance`	0	Identifies an option to group by app instance.
`Container`	1	Identifies an option to group by container.
`SmartFolder`	2	Identifies an option to group by smart folder.

^ Back to top

`SubFolderType`

Identifies the subfolder type.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`MetadataField`	0	Identifies a subfolder grouped by a metadata field.
`State`	1	Identifies a subfolder grouped by state.
`Category`	2	Identifies a subfolder grouped by category.

^ Back to top

`TaskQueueStatus`

The task queue status.

Namespace: Cegid.Lithium.DigitalArchive.Client.Rest.Models

Members

Member	Value	Description
`Pending`	0	The task queue pending status.
`Success`	1	The task queue success state.
`Error`	2	The task queue error state.

^ Back to top