Cegid Docs Service (DAS) Client Library

The client library allows consuming the service REST API.

Index

Service Client

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

^ Back to top

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.
License Provides operations on license.
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.

^ Back to top

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.
CustomMetadataTimeConfiguration Describes a custom metadata time 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.
DocumentHighlightData Describes a document highlight.
DocumentLineData Describes a document line.
DocumentPaymentData Describes a document payment.
DocumentsBulkData Describes a documents bulk.
DocumentSearchData Describes a document search.
DocumentTagData Describes a document tag.
DocumentTotalData Describes a document total.
DuplicateData Describes a duplicate.
EntityBase Describes an entity.
EventLogData Describes an event log.
EventLogListResponse Describes an event log list response.
ExpressionReturnValue Describes an expression return value.
ExpressionValue Describes an expression 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.
InstanceClosedData Describes an instance closed.
InstanceMigrationData Describes an instance migration.
JournalData Describes a journal.
KeyValueData Describes a key value.
KeyValueDocument Describes a key value document.
License Describes a license.
LicenseLimitItem Describes a license limit item.
MessageInfo Describes a message.
MessageInfoDetails Describes a message info details.
PartyInformationData Describes a party information.
ProductData Describes a product.
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.
SmartFolderRevokedUserData Describes a smart folder revoked user.
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.

^ Back to top

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.
DistinctValueType Destinct value type.
DuplicatedOperationType Specifies the different document duplicated operation types.
DuplicatedState Specifies the different duplicated state types.
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.
InstanceMigrationState The intance migration process states.
InstanceMigrationStep The intance migration process steps.
LicenseLimit Describes license limits.
LicenseLimitSide Describes the types of license sides.
LicenseLimitType Describes the types of license limits.
MetadataTimeFormat Identifies a time format.
MetadataTimeInputMode Identifies a time input mode.
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.
TypeOfLicense Describes the types of license.

^ Back to top

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

^ Back to top

Reference

Service Client

DigitalArchiveClient

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

Error Codes

ErrorCodes

Constants
Constants Description Remarks
AccessDeleted The access control is deleted.
AccessNotFound The access control is not found.
AccessPermissionNotAllowed The access is not allowed.
AppInstanceResourceNotFound The app instance resource not found.
AppInstancesInfoNotFound The app instances info does not exist.
AppsCompanyNotFound The Apps company does not exist.
AppsCreateSubjectAccessesException Exception thrown in setting Apps subject accesses.
AppsCreateSubjectRolesException Exception thrown in setting Apps subject roles.
AppsDeleteSubjectRolesException Exception thrown in removing Apps subject roles.
AppsGetResourceSubjectRolesException Exception thrown in retrieving Apps resource subject roles.
AppsGetSubjectAccessesException Exception thrown in retrieving Apps subject accesses.
AppsGetSubjectRolesException Exception thrown in retrieving Apps subject roles.
AppsSubjectRolesNotFound The Apps subject company roles do not exist.
ArchiveExportEntryAlreadyExists The archive export entry already exist.
ArchiveExportEntryNotFound The archive export entry does not exist.
ArchiveExportUrlExpired The archive export url expired.
ArchiveIsLocked The archive is locked.
ArchiveNotFound The archive is not found.
ArchivesChangeStatusInvalidAccountinginformation An archive change status accounting information validation error.
ArchivesChangeStatusInvalidCategory An archive change status category validation error.
ArchivesChangeStatusInvalidDocumentDate An archive change status document date validation error.
ArchivesChangeStatusInvalidTaxRelevant An archive change status Is Tax Relevant validation error.
ArchivesExportDocumentsValidation An archive export document validation error.
ArchivesGetDocumentsEndDateInvalid The start date is invalid.
ArchivesGetDocumentsIvalidDates The dates are invalid.
ArchivesGetDocumentsStartDateInvalid The start date is invalid.
ArchivesUpdateCategoryUnknown An archive update category validation error.
AuthorizationHandler An authorization handler error or exception.
CallbackReferenceNotFound The callback reference does not exist in REDIS cache.
CategoryDuplicated The category is duplicated.
CategoryNotAllowed The category is not allowed.
CategoryStateNotAllowed The category state is not allowed.
ChangeMetadataNotAllowed The change of metadata is not allowed.
ContactInvalid The contact is invalid.
ContactNotFound The contact is not found.
ContainerAccessAlreadyExists The container access already exists.
ContainerAccesses An error was found in setting container accesses.
ContainerAccessNotAllowed The user has not container access.
ContainerAlreadyExists The container alreadyExists.
ContainerInactive The container inactive error code.
ContainerNotFound The container does not exist.
ContainersNotFound Containers not found error.
ContainerUpdate A container update raised and error or exception.
CreateCompanyException The create of an Apps company thrown an exception.
CreatingAdminUser The error creating the administrator user.
CustomMetadataDefaultValueFormat Cannot cast the custom metadata default value.
CustomMetadataEmptyDefaultValue Custom metadata field has an empty default value.
CustomMetadataTypeComponentTypeInvalid The custom metadata type and component type do not match.
DataCatalogService The data catalog raised an error.
DeleteCompanyException The delete of an Apps company thrown an exception.
DigitalArchiveUpgrade A Digital Archive upgrade raised an error.
DocumentCategoryAlreadyExists The document category already exists error.
DocumentCategoryCannotDeleteExternalManaged The custom category rouping cannot delete external managed entity error.
DocumentCategoryCannotDeleteInUse The document category cannot delete in use by smart folder.
DocumentCategoryCannotDeleteSystemEntity The document category cannot delete system entity error.
DocumentCategoryNotFound The document category not found error.
DocumentMetadataAlreadyExists The document metadata already exists error.
DocumentMetadataCannotDeleteExternalManaged The custom field cannot delete external managed entity error.
DocumentMetadataCannotDeleteInUse The document field cannot delete in use by smart folder.
DocumentMetadataCannotDeleteSystemEntity The document metadata cannot delete system entity error.
DocumentMetadataCannotUpdateKey The document metadata cannot update key error.
DocumentMetadataCannotUpdateType The document metadata cannot update type error.
DocumentMetadataFormatTimeInvalid The document metadata key not allowed.
DocumentMetadataKeyNotAllowed The document metadata key not allowed.
DocumentMetadataNotFound The document metadata not found error.
DocumentNotIndexed The document is not indexed in Elastic Search.
DocumentNotUpdated The document was not updated in Elastic Search.
DocumentRemovalNotAllowed The document removal is not allowed.
DocumentStateAlreadyExists The document state already exists error.
DocumentStateCannotDeleteExternalManaged The custom state cannot delete external managed entity error.
DocumentStateCannotDeleteInUse The document state cannot delete in use by smart folder.
DocumentStateCannotDeleteSystemEntity The document state cannot delete system entity error.
DocumentStateNotFound The document state not found error.
DuplicatedInvalidOperation An error was found while applying duplicated logic.
DuplicatedIsDeleted An error was found while applying duplicated logic to a deleted document.
DuplicatedNotOriginal An error was found while applying duplicated logic to a non original duplicated document.
DuplicatedTransactionID The duplicated transaction ID.
EmailErrorCode The email error code.
EmptyRecycleBinNotAllowed The empty recycle bin not allowed.
EntityIsLocked The entity is locked by an operation.
EventLogEntryNotFound The event log entry does not exist.
ExportObjectNotFound An error was found while getting file from cache to export.
ExpressionValidation An expression returned an exception.
FailedCreateUser Cant create the user.
FailedSendInvitation Cant send a user invitation.
FailedToAddAppInstance Failed to add to app instance.
FileNotFound The file not found.
FileSizeExceeded The file size limit error.
FileSizeMinimum The file size minimum error.
FileUpload The file upload error.
FileWrongType The file has a wrong type.
FiscalIrrelevantStateWrong The fiscal irrelant state is wrong.
FiscallyArchiveNotAllowedInZip The fiscally archive not allowed.
FiscalRelevantStateWrong The fiscal relevant state is wrong.
FolderStructureAlreadyExists The container folder structure already exists.
FolderStructureNotFound The container folder structure not found.
FolderTreeDataNotFound The folder tree data not found error.
GetUserBadRequest An Get user bad request error code.
GetUsersByContainerBadRequest An Get users by container bad request error code.
GroupingAlreadyExists The Grouping already exists error.
GroupingCannotDeleteExternalManagedEntity The Grouping cannot delete external managed entity error.
GroupingCannotDeleteInUse The grouping cannot delete in use by smart folder.
GroupingCannotDeleteSystemEntity The Grouping cannot delete system entity error.
GroupingCannotUpdateKey The Grouping cannot update key error.
GroupingCannotUpdateType The Grouping cannot update type error.
GroupingNotFound The Grouping not found error.
IdArchiveNotAllowedInZip The ID archive is not allowed in zip.
IdentityUserNotFound The identity user does not exist.
IncorrectFileNumber The incorrect file number.
IncorrectZipFile The the zip file is incorrect.
Initialization The initialization error.
InstanceMigration A migration returned an exception.
InternalServerError An internal error occurred while processing your request.
InvalidColor Invalid color.
InvalidContainers Invalid containers requet.
InvalidCountryCode The country code is invalid.
InvalidDocumentId The document ID is invalid.
InvalidFilter One or more filters are invalid.
InvalidJson The json file is invalid.
InvalidLanguages One or more languages are invalid.
InvalidMetadataField The invalid metadata field.
InvalidNIF The NIF is invalid.
InvalidState The invalid state.
InvalidVatNumber The VAT number is invalid.
License License error.
LicenseLimitExceeded A license limit was exceeded.
ListValueOverflow A list value exceeds the length limit.
LockedArchiveNotAllowedInZip The locked archive is not allowed in zip.
LockedFiscalrelevantArchiveNotAllowed The lock of fiscal relevant archive is not allowed.
ManageTaxRelevantIsLocked ManageTaxRelevant Is Locked.
MissingDocArchivalNumber The missing doc archival number.
MissingDocumentID The missing document ID.
MissingDocumentType The missing document type.
MissingIsFiscalRelevant The missing fiscal relevant.
MissingJournalID The missing journal ID.
MissingPeriod The missing doc archival number.
MissingSubscriptionAlias Missing subscription alias.
MissingSubscriptionInfos Missing subscription infos.
MissingTransactionID The transaction ID s missing.
MissingUserIdForInvitation Missing user id for invitation.
MoveOperationNotAllowed The move operation is not allowed.
MultipleDefaultCategoriesFound Multiple default categories found.
MultipleDefaultStatesFound Multiple default states found.
MultipleDistinctByFields Multiple fields found in distinct clause.
NoConnectionString No connection string in app instance.
NoDocumentsToExport The no documents to export error.
OutOfRange An out of range error was raised.
OwnerDeleteNotAllowed The container must have at least one owner.
Probe The probe request thrown an error.
ProfileListNotFound The profile list not found.
ProfileNotAllowed The profile is not allowed.
ProfileNotFound The profile is not found.
PushNotificationService Push notifications error.
RegisterAppsWebhooksFailed The registration of the AppInstance webhooks has failed.
RegisterIdentityWebhooksFailed The registration of the Identity webhooks has failed.
RelevantArchiveCantDeleted The relevant archive can´t be deleted.
RequestArgsInvalid The request arguments are invalid.
RouteKeyNotFound The route key is not found.
ServiceDependency The contact is invalid.
SmartFolderAlreadyExists The smart folder already exists.
SmartFolderCannotDeleteDocuments System smart folder cannot be deleted because has documents error.
SmartFolderCannotDeleteExternalManagedEntity External Managed Smart folder cannot be deleted error.
SmartFolderCannotDeleteSystemEntity System smart folder cannot be deleted error.
SmartFolderCannotUpdateEntity System smart folder cannot be updated error.
SmartFolderCannotUpdateSystemEntity System smart folder cannot be updated error.
SmartFolderCategoryNotFound The smart folder category not found.
SmartFolderContainerNotFound The smart folder not found for container.
SmartFolderDefaultCategoryNotFound The smart folder category not found.
SmartFolderDefaultStateNotFound The smart folder state not found.
SmartFolderNotFound The smart folder not found error.
SmartFolderStateNotFound The smart folder state not found.
SmartFolderUpdateAccess The update of a smart folder access raised an error or exception.
SmartFolderUserPermission The smart folder permissions erros.
SmartFolderUsersNotCreated The smart folder users problem.
SmartFolderUsersNotFound The smart folder users problem.
SmartFolderUsersNotRemoved The smart folder users problem.
StartHigherThanEnd The start value is higher than the end one.
StateLockFilesActive The state lock files flag is active.
StateNotAllowed The state is not allowed.
SubscriptionInvalid The subscription is invalid.
SystemReservedFilters The filter ate reserved for system operations.
TaskQueue The task queue raised an error.
TaskQueueNotFound The task queue not found error.
TokenExchangeFailed The user token exchange failed.
UnauthorizedAccessException A 401 exception was thrown.
UnlockedFiscalrelevantArchiveNotAllowed The unlock of fiscal relevant archive is not allowed.
UpdateByProperty The update documents by property request raised an error.
UpdateNotAllowed The update is not allowed.
UpgradeRequired Cegid Docs upgrade is required.
UserAlreadyExists The user already exists.
UserAlreadyInAppInstance The user is already registered in the app instance.
UserBulkDelete The user bulk delete operation failed.
UserNotFound The user does not exist.
WaitingForInvitationConfirmation Waiting for user confirmation for invitation.
ZipUploadOnSmartFolder The zip upload on smartfolder error code.

Controllers

ArchivesClientController

Provides operations on archives.

Methods
ChangeStatusAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

ChangeStatusWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

DeleteAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

DeleteWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

ExportAsync()

Action responsible for exporting container documents.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAsync()

Action responsible for returning a document with metadata information.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentData>> GetAsync(string workspace, string organization, string appInstance, string containerKey, string id, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAllAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetFavoritesAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetFileAsync()

Action responsible for returning a document file.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.File>> GetFileAsync(string workspace, string organization, string appInstance, string containerKey, string id, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

ManageDuplicatesWithTaskAsync()

Action responsible for managing duplicate files using a background service. If list of duplicates is null or empty, all duplicated documents of the selected company are deleted.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Guid>> ManageDuplicatesWithTaskAsync(string workspace, string organization, string appInstance, string containerKey, Cegid.Lithium.DigitalArchive.Client.Rest.Models.DuplicatedOperationType operationType, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DuplicateData> duplicateList, CancellationToken cancellationToken = default);
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.
operationType Cegid.Lithium.DigitalArchive.Client.Rest.Models.DuplicatedOperationType The operation type. Required.
duplicateList System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DuplicateData> The list of duplicates. If null or empty, all duplicated documents of the selected company are 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.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

MoveDocumentsAsync()

Action responsible to move documents between folders.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

MoveDocumentsWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

SearchAsync()

Action responsible for returning a list of documents based on a filter.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentSearchData>>> SearchAsync(string workspace, string organization, string appInstance, string? containerKey, string? filter, string? orderBy, string? distinctBy, string? select, int skip, int top, string? value, CancellationToken cancellationToken = default);
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.
value string? The select filter. Required.
Returns
Return Type Description
System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentSearchData> A list of documents with metadata.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

SetFavoriteDocumentsAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

SetFavoriteDocumentsWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateAsync()

Action responsible for updating properties of a list of documents.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.

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

^ Back to top

UpdateByPropertyAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateByPropertyAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.KeyValueDocument> documents, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateByPropertyWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.

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

^ Back to top

UploadAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkUploadMessage>> UploadAsync(string workspace, string organization, string appInstance, string containerKey, string? smartFolderKey, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

The class includes custom methods not described here.

ContactsClientController

Provides operations on contacts.

Methods
CreateAsync()

Action responsible for adding whitelist contacts to containers.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> CreateAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkContact> contacts, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

CreateWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

DeleteAsync()

Action responsible for deleting containers whitelist contacts.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkDeleteContact> contacts, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

DeleteWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAllAsync()

Action responsible for returning a list of whitelist contacts.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAllByContainerAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

ContainersClientController

Provides operations on containers.

Methods
CreateWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

DeleteAsync()

Action responsible for deleting a list of containers.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

DeleteWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Guid>> DeleteWithTaskAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> containers, bool? soft = true, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAsync()

Action responsible for returning a container.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ContainerInfo>> GetAsync(string workspace, string organization, string appInstance, string containerKey, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAllAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateAsync()

Action responsible for updating a list of containers.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

CustomCategoriesClientController

Provides operations on custom categories.

Methods
CreateAsync()

Action responsible for creating a list of custom categories.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

DeleteAsync()

Action responsible for deleting a list of custom categories.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> categories, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAsync()

Action responsible for returning a custom category.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomCategoryData>> GetAsync(string workspace, string organization, string appInstance, string key, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAllAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateAsync()

Action responsible for updating a list of custom categories.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

CustomMetadataClientController

Provides operations on custom metadata.

Methods
CreateAsync()

Action responsible for creating a list of custom metadata.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

DeleteAsync()

Action responsible for updating a list of custom metadata.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> metadata, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAsync()

Action responsible for returning a custom metadata.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataData>> GetAsync(string workspace, string organization, string appInstance, string key, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAllAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateAsync()

Action responsible for updating the provided metadata by id.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

CustomStatesClientController

Provides operations to manage document custom states.

Methods
CreateAsync()

Action responsible for creating a list of custom states.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

DeleteAsync()

Action responsible for deleting a list of custom states.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<int> states, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAsync()

Action responsible for returning a custom state.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomStateData>> GetAsync(string workspace, string organization, string appInstance, int key, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAllAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetNextKeyAsync()

Action responsible for returning the next custom state key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<int>> GetNextKeyAsync(string workspace, string organization, string appInstance, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateAsync()

Action responsible for updating a list of custom states.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

EventsLogClientController

Provides operations on events log.

Methods
GetAllNonSystemAsync()

Action responsible for returning a list of event log entries.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetByGroupAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.EventLogListResponse>> GetByGroupAsync(string workspace, string organization, string appInstance, string groupId, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

ExportsClientController

Provides operations on exports.

Methods
BulkGetExportsFileAsync()

Action responsible for sending a ZIP file with archives exports.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.File>> BulkGetExportsFileAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<int> ids, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

BulkResendExportUrlAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> BulkResendExportUrlAsync(string workspace, string organization, string appInstance, Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkResendExportUrlData resendExportUrlOptions, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAsync()

Action responsible for returning an archive export for a container.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportData>> GetAsync(string workspace, string organization, string appInstance, string containerKey, int id, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAllAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetExportUrlAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ArchiveExportUrlBulkData>> GetExportUrlAsync(string workspace, string organization, string appInstance, string containerKey, int id, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

ResendExportUrlAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> ResendExportUrlAsync(string workspace, string organization, string appInstance, int id, System.Collections.Generic.IEnumerable<string> emails, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

ExpressionsClientController

Provides operations on expressions.

Methods
EvaluateAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ExpressionReturnValue>> EvaluateAsync(string workspace, string organization, string appInstance, Cegid.Lithium.DigitalArchive.Client.Rest.Models.ExpressionValue expression, string? id, CancellationToken cancellationToken = default);
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 Cegid.Lithium.DigitalArchive.Client.Rest.Models.ExpressionValue The expression. 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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

ValidateAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> ValidateAsync(string workspace, string organization, string appInstance, Cegid.Lithium.DigitalArchive.Client.Rest.Models.ExpressionValue expression, CancellationToken cancellationToken = default);
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 Cegid.Lithium.DigitalArchive.Client.Rest.Models.ExpressionValue 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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GroupingsClientController

Provides operations on groupings.

Methods
CreateAsync()

Action responsible to create a grouping data.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

DeleteAsync()

Action responsible for deleting a list of groupings.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> groupings, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAsync()

Action responsible for returning a grouping based on its key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.GroupingData>> GetAsync(string workspace, string organization, string appInstance, string key, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAllAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateAsync()

Action responsible to update the provided groupings.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

LicenseClientController

Provides operations on license.

Methods
GetLicenseAsync()

Returns the subscription's type of license.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.License>> GetLicenseAsync(string workspace, string organization, string appInstance, CancellationToken cancellationToken = default);
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
Cegid.Lithium.DigitalArchive.Client.Rest.Models.License The subscription's type of license.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

ProvisioningClientController

Provides operations on provisioning.

Methods
CheckUpgradeAsync()

Action responsible for checking if upgrades are pending.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<bool>> CheckUpgradeAsync(string workspace, string organization, string appInstance, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

InitializeTenantAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.ProvisioningStateData>> InitializeTenantAsync(string workspace, string organization, string appInstance, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

RecycleBinClientController

Provides operations on recycle bin.

Methods
EmptyAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> EmptyAsync(string workspace, string organization, string appInstance, bool documents = true, bool containers = false, CancellationToken cancellationToken = default);
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.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

EmptyWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Guid>> EmptyWithTaskAsync(string workspace, string organization, string appInstance, bool documents = true, bool containers = false, CancellationToken cancellationToken = default);
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.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAllContainersAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAllDocumentsAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.UnprocessableEntity Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

RestoreContainersAsync()

Action responsible for restoring containers.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

RestoreContainersWithTaskAsync()

Action responsible for restoring containers using a background service.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Guid>> RestoreContainersWithTaskAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> containers, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

RestoreDocumentsAsync()

Action responsible for restoring documents.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

RestoreDocumentsWithTaskAsync()

Action responsible for restoring documents using a background service.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

SmartFoldersClientController

Provides operations on smart folders.

Methods
CreateAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

CreateWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

DeleteAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.BulkOperationResponse>> DeleteAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> folderKeys, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

DeleteWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Guid>> DeleteWithTaskAsync(string workspace, string organization, string appInstance, System.Collections.Generic.IEnumerable<string> folderKeys, CancellationToken cancellationToken = default);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAsync()

Action responsible for returning a container smart folder.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderData>> GetAsync(string workspace, string organization, string appInstance, string key, bool? withImplicitAccesses, CancellationToken cancellationToken = default);
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.
withImplicitAccesses bool? The with implicit accesses. 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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

GetAllAsync()

Action responsible for returning a list of smart folders.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateAccessAsync()

Action responsible to update accesses in a smart folder.

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateAccessWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

UpdateWithTaskAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

StorageManagementClientController

Provides operations on storage management.

Methods
GetStorageSizeAsync()

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

public async Task<Cegid.Hydrogen.Rest.Client.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);
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.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

TaskQueueClientController

Provides operations for managing background tasks.

Methods
GetTaskAsync()

Action responsible for returning a task.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.DigitalArchive.Client.Rest.Models.TaskQueueData>> GetTaskAsync(string workspace, string organization, string appInstance, System.Guid id, CancellationToken cancellationToken = default);
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.
HttpStatusCode.Conflict Failure: conflict.

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

^ Back to top

Models

AccessControl

Describes an access control.

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

AccountingDocumentData

Describes an accounting document.

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

Archive

Describes an archive.

Properties
Property Type Description Rules
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.

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.

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.

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.

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.

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.

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

^ Back to top

BaseCustomCategory

Describes a base custom category.

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.

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.
TimeConfiguration Cegid.Lithium.DigitalArchive.Client.Rest.Models.CustomMetadataTimeConfiguration? Gets or sets the time configuration.

^ Back to top

BaseCustomState

Describes a base custom state.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

CompanyData

Describes a company.

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.
Color string? Gets or sets the color.
Tag string? Gets or sets an optional tag.
TaxCountryRegion string? Gets or sets the tax country region.

^ Back to top

Contact

Describes a contact.

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

ContainerInfo

Describes a container.

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

ContainerSmartFolder

Describes a container smart folder.

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

CreditorData

Describes a creditor.

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.

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

CustomFieldData

Describes a custom field.

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.
ValueTime System.TimeSpan? Gets or sets the value time.

^ Back to top

CustomMetadataBooleanConfiguration

Describes a custom metadata boolean configuration.

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

^ Back to top

CustomMetadataData

Describes a custom metadata.

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.

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.

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.

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.

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

^ Back to top

CustomMetadataTimeConfiguration

Describes a custom metadata time configuration.

Properties
Property Type Description Rules
InputModeTime Cegid.Lithium.DigitalArchive.Client.Rest.Models.MetadataTimeInputMode? Gets or sets the input mode time.
TimeFormat Cegid.Lithium.DigitalArchive.Client.Rest.Models.MetadataTimeFormat? Gets or sets the time format.

^ Back to top

CustomStateData

Describes a custom state.

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.

Properties
Property Type Description Rules
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.

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

DocumentBaseData

Describes a document base.

Properties
Property Type Description Rules
AtCud string? Gets or sets the at cud.
BankAccountEntry Cegid.Lithium.DigitalArchive.Client.Rest.Models.BankAccountData? Gets or sets the bank account entry.
CertificateNumber string? Gets or sets the certificate number.
CompanyName string? Gets or sets the company name.
CompanyTaxId string? Gets or sets the company tax id.
CurrencyCode string? Gets or sets the currency code.
CustomerInfo Cegid.Lithium.DigitalArchive.Client.Rest.Models.PartyInformationData? Gets or sets the customer.
DocumentDate System.DateTime? Gets or sets the document date.
DocumentNo string? Gets or sets the document number.
DocumentStatus string? Gets or sets the document status.
DocumentTotals Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentTotalData? Gets or sets the document totals.
DocumentUrl string? Gets or sets the document url.
DocumentType string? Gets or sets the document type.
DueDate System.DateTime? Gets or sets the due date.
GeneralLedgerEntry Cegid.Lithium.DigitalArchive.Client.Rest.Models.GeneralLedgerEntryData? Gets or sets the general ledger entry.
HashControl string? Gets or sets the hash control.
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.
PaymentTerms int? Gets or sets the payment terms.
SettlementPercentage decimal? Gets or sets the settlement percentage.
SupplierInfo Cegid.Lithium.DigitalArchive.Client.Rest.Models.PartyInformationData? Gets or sets the supplier.
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.

^ Back to top

DocumentData

Describes a document.

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

^ Back to top

DocumentGenericData

Describes a document generic.

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

DocumentHighlightData

Describes a document highlight.

Properties
Property Type Description Rules
Highlight System.Collections.Generic.IList<string> Gets or sets the highlight. Required.Not empty.

^ Back to top

DocumentLineData

Describes a document line.

Properties
Property Type Description Rules
Amount decimal? Gets or sets the amount.
DebitCreditIndicator string? Gets or sets the debit credit indicator.
LineNumber long? Gets or sets the line number.
Product Cegid.Lithium.DigitalArchive.Client.Rest.Models.ProductData? Gets or sets the product.
Quantity decimal? Gets or sets the quantity.
SettlementAmount decimal? Gets or sets the settlement amount.
SettlementPercentage decimal? Gets or sets the settlement percentage.
Tax System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.TaxInformationData> Gets or sets the tax. Required.
TaxAmount decimal? Gets or sets the tax amount.
TaxBase decimal? Gets or sets the tax base.
UnitOfMeasure string? Gets or sets the unit of measure.
UnitPrice decimal? Gets or sets the unit price.

^ Back to top

DocumentPaymentData

Describes a document payment.

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

^ Back to top

DocumentsBulkData

Describes a documents bulk.

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

DocumentSearchData

Describes a document search.

Properties
Property Type Description Rules
Highlights System.Collections.Generic.IDictionary<string, Cegid.Lithium.DigitalArchive.Client.Rest.Models.DocumentHighlightData> Gets or sets the highlights. Required.

^ Back to top

DocumentTagData

Describes a document tag.

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.

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

^ Back to top

DuplicateData

Describes a duplicate.

Properties
Property Type Description Rules
OriginalDocument string Gets or sets the original document. Required.
DuplicatedDocuments System.Collections.Generic.IList<string>? Gets or sets the duplicated documents. Not empty.

^ Back to top

EntityBase

Describes an entity.

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

^ Back to top

EventLogData

Describes an event log.

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.

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.

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

ExpressionValue

Describes an expression value.

Properties
Property Type Description Rules
Value string Gets or sets the return value. Required.

^ Back to top

FavoriteEntry

Describes a favorite entry.

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

^ Back to top

File

Describes a file.

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.

Properties
Property Type Description Rules
CostCenterDescription string? Gets or sets the cost center description.
CostCenterId string? Gets or sets the cost center id.
Journal Cegid.Lithium.DigitalArchive.Client.Rest.Models.JournalData? Gets or sets the journal.
SubscriptionId string? Gets or sets the subscription id.
Transaction Cegid.Lithium.DigitalArchive.Client.Rest.Models.TransactionData? Gets or sets the transaction.
TransactionUrl string? Gets or sets the transaction url.
DataHubId string? Gets or sets the data hub identifier.

^ Back to top

GroupingData

Describes a grouping.

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.

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

InstanceClosedData

Describes an instance closed.

Properties
Property Type Description Rules
Id string Gets or sets the identifier. Required.
Key string Gets or sets the key. Required.
Date System.DateTime Gets or sets the date. Required.
IsPending bool Indicates if app instance was permanently deleted from cegidDocs. Required.

^ Back to top

InstanceMigrationData

Describes an instance migration.

Properties
Property Type Description Rules
RowKey string Gets or sets the row key. Required.
PartitionKey string Gets or sets the partition key. Required.
SourceContainer string Gets or sets the source container. Required.
TargetContainer string Gets or sets the target container. Required.
LastId string Gets or sets the last identifier. Required.
Date System.DateTime Gets or sets the date. Required.
Step Cegid.Lithium.DigitalArchive.Client.Rest.Models.InstanceMigrationStep Gets or sets the step. Required.
State Cegid.Lithium.DigitalArchive.Client.Rest.Models.InstanceMigrationState Gets or sets the state. Required.

^ Back to top

JournalData

Describes a journal.

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

^ Back to top

KeyValueData

Describes a key value.

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.

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

License

Describes a license.

Properties
Property Type Description Rules
TypeAsString string Gets or sets the type of license as a string. Required.
Type Cegid.Lithium.DigitalArchive.Client.Rest.Models.TypeOfLicense Gets or sets the type of license. Required.
Limits System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.LicenseLimitItem>? Gets or sets a list of limits (if any).

^ Back to top

LicenseLimitItem

Describes a license limit item.

Properties
Property Type Description Rules
Limit Cegid.Lithium.DigitalArchive.Client.Rest.Models.LicenseLimit Gets or sets the license limit. Required.
Side Cegid.Lithium.DigitalArchive.Client.Rest.Models.LicenseLimitSide Gets or sets the license limit side. Required.
Type Cegid.Lithium.DigitalArchive.Client.Rest.Models.LicenseLimitType Gets or sets the license limit type. Required.
Key string? Gets or sets the optional limit key. Used, for example, in controller license limits.
Values System.Collections.Generic.IList<string> Gets or sets the limit value based on the type. Required.Not empty.

^ Back to top

MessageInfo

Describes a message.

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.

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.

Properties
Property Type Description Rules
AccountId string? Gets or sets the account identifier.
BaseCurrencyCode string? Gets or sets the base currency code.
CountryCode string? Gets or sets the country code.
Name string? Gets or sets the name.
PartyId string? Gets or sets the party identifier.
PaymentTerms int? Gets or sets the payment terms.
TaxNumber string? Gets or sets the tax number.
TaxCountryRegion string? Gets or sets the tax country region.

^ Back to top

ProductData

Describes a product.

Properties
Property Type Description Rules
AccountId string? Gets or sets the account identifier.
Code string? Gets or sets the code.
Description string? Gets or sets the description.
TaxCode string? Gets or sets the tax code.
TaxType string? Gets or sets the tax type.
Type string? Gets or sets the type.
UnitOfMeasure string? Gets or sets the unit of measure.
UnitPrice decimal? Gets or sets the unit price.
ExemptionReason string? Gets or sets the exemption reason.

^ Back to top

ProvisioningStateData

Describes a provisioning state.

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.

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.
AutoDeletionDate System.DateTime? Gets or sets the auto deletion 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.

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.

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.

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.

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.
RevokedUsers System.Collections.Generic.IList<Cegid.Lithium.DigitalArchive.Client.Rest.Models.SmartFolderRevokedUserData>? Gets or sets the revoked 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.
InheritPermissions bool Gets or sets a value indicating whether the company inherit permissions should be inherited. Required.
Color string? Gets or sets the color.
Tag string? Gets or sets the tag.
ManageTaxRelevant bool Gets or sets a value indicating whether the folder manage tax relevant. Required.

^ Back to top

SmartFolderFieldData

Describes a smart folder field.

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.
Formula string? Gets or sets the formula.

^ Back to top

SmartFolderRevokedUserData

Describes a smart folder revoked user.

Properties
Property Type Description Rules
Identity string Gets or sets the user identity. Required.
ContainerKeys System.Collections.Generic.IList<string> Gets or sets the container keys. Required.Not empty.

^ Back to top

SmartFolderStateData

Describes a smart folder state.

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.

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.

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.
Color string? Gets or sets the color.
Tag string? Gets or sets the tag.
ManageTaxRelevant bool Gets or sets a value indicating whether the folder manage tax relevant. Required.

^ Back to top

SmartFolderTreeCategory

Describes a smart folder tree category.

Properties

The model has no properties.

^ Back to top

SmartFolderTreeMetadataField

Describes a smart folder tree metadata field.

Properties
Property Type Description Rules
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.

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.

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.

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.

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.

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.

Properties
Property Type Description Rules
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.

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.

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

^ Back to top

TransactionData

Describes a transaction.

Properties
Property Type Description Rules
CurrencyCode string? Gets or sets the currency code.
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.
Period int? Gets or sets the period.
PeriodYear int? Gets or sets the period year.
SystemEntryDate System.DateTime? Gets or sets the system entry date.
SystemId string? Gets or sets the system id.
TransactionDate System.DateTime? Gets or sets the transaction date.
TransactionId string? Gets or sets the transaction id.
TransactionType string? Gets or sets the transaction type.

^ Back to top

TranslationData

Describes a translation.

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.

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.

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. Required.
IsInactive bool? Indicates if the container is flagged as inactive.
Color string? Gets or sets the color.
Tag string? Gets or sets an optional tag.
TaxCountryRegion string? Gets or sets the tax country region.

^ Back to top

UploadArchiveMessage

Describes an upload archive message.

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.

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

WithholdingData

Describes a withholding.

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

^ Back to top

WithholdingTaxData

Describes a withholding tax.

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

^ Back to top

Enumerations

ArchiveExportState

Defines an archive export state.

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.

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

^ Back to top

ComponentType

Identifies a component type.

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.
TimeInput 10 A time input component.
DateTimePicker 11 A date and time input component.

^ Back to top

ContainerExportState

Describes the container/company current state.

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.

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.
Time 9 Identifies a time metadata type.

^ Back to top

CustomStateIndicator

Defines a document state indicator.

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.

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

^ Back to top

DuplicatedOperationType

Specifies the different document duplicated operation types.

Members
Member Value Description
KeepOriginal 0 All duplicates will be eliminated and only the original document will be kept.
KeepCopy 1 The original will be deleted and the copy will be kept.
KeepBoth 2 Both original and copies will be kept.

^ Back to top

DuplicatedState

Specifies the different duplicated state types.

Members
Member Value Description
None 0 The document has no duplicates.
Duplicated 1 The document has duplicates and this is one of the copies.
Original 2 The document has duplicates and this is the original.
ManagedOriginal 3 The document has duplicates and this is the original, but already managed by responsible.
ManagedDuplicated 4 The document has duplicates and this is one of the copies, but already managed by responsible.

^ Back to top

EventLevel

The event log entry type.

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

ExpressionReturnValueType

The expression return value type.

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.

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

^ Back to top

InstanceMigrationState

The intance migration process states.

Members
Member Value Description
Pending 0 Opearation is waiting to start.
Executing 1 Operation is executing.
Completed 2 Operation ended with success.
Failed 3 Operation has failed.

^ Back to top

InstanceMigrationStep

The intance migration process steps.

Members
Member Value Description
Locking 0 When the container is beeing locked.
CopyStorage 1 When table and blob storage data migration starts.
CopyElasticSearch 2 When elastic search data migration starts.
Unlocking 3 When the container is beeing unlocked.

^ Back to top

LicenseLimit

Describes license limits.

Members
Member Value Description
Users 0 A users limit.
Companies 1 A companies feature limit.
SmartFolders 2 A smart folders feature limit.
Storage 3 A storage limit.
Requests 4 An API requests limit.
Tags 5 A tags feature limit.
Colors 6 A colors feature limit.
CalculatedFields 7 A calculated fields feature limit.
Duplicates 8 A duplicates feature limit.
Endpoint 9 An endpoint limit. Usually paired with action limit type with controller name in key and actions in values.

^ Back to top

LicenseLimitSide

Describes the types of license sides.

Members
Member Value Description
Client 0 A limit only in client side.
Server 1 A limit in server API (affects client side behavior).

^ Back to top

LicenseLimitType

Describes the types of license limits.

Members
Member Value Description
Boolean 0 A boolean type of limit.
Number 1 A number type of license limit.
Menu 2 A menu type of license limit.
Action 3 An action type of license limit.

^ Back to top

MetadataTimeFormat

Identifies a time format.

Members
Member Value Description
DHMS 0 The format day hours minute and seconds.
HMS 1 The format hours minute and seconds.
HM 2 The format hours and minute.
MS 3 The format minute and seconds.

^ Back to top

MetadataTimeInputMode

Identifies a time input mode.

Members
Member Value Description
Time 0 The time mode.
Duration 1 The duration mode.

^ Back to top

ProvisioningState

The existing provisioning states.

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.

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.

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.

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.

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.

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.

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

TypeOfLicense

Describes the types of license.

Members
Member Value Description
Standard 0 The Standard license.
Premium 1 The Premium license.
Ultimate 2 The Ultimate license.
Partner 3 The license for Partners.
Integration 4 The license for third party integrations.

^ Back to top