Applications Service (APPS) Client Library

The client library allows consuming the service REST API.

Index

Service Client

Class Description
ApplicationsClient The entry point of the Applications Service client library.

^ Back to top

Controllers

Class Description
Accesses Provides operations on accesses.
AppDefinitions The application definitions controller.
AppInstances The application instances controller.
Companies Provides operations on companies.
DataExports Provides operations on data exports: asynchronous jobs that stream catalog datasets from one database snapshot into gzip NDJSON part files, described by a manifest, for consumers that need a consistent copy of the data. Reserved for server-to-server consumers holding the data export scope with full access.
Organizations The organizations controller.
ResourceOperations Provides operations on the resource operations registry - a generic queue of operations to perform against resources, registered for later or immediate execution.
Resources Provides operations on resources.
Subjects Provides operations related to resources and subjects accesses management.
Workspaces The workspaces controller.

^ Back to top

Models

Class Description
AccessApplyResult Describes an access apply result.
AccessEntryRequest Describes an access entry request.
AccessEntryResponse Describes an access entry response.
AccessesApplyRequest Describes an accesses apply request.
AccessModelCopySummary Describes the outcome of an access model copy job, stored as the job result: the plan fingerprint, the number of report lines per section, action and reason, and where the line-by-line report is stored.
AccessModelCopySummaryCount Describes the number of report lines of an access model copy plan with a given section, action and reason.
ACLEntries Describes an acl entries.
ACLEntry Describes an ACL entry.
ACLResource Describes an acl resource.
ACLResourceAccessRequest Describes an acl resource access request.
ACLResourceAccessResponse Describes an ACL resource access.
ACLSubjectAccessRequest Describes an ACL resource access.
ACLSubjectAccessResponse Describes an ACL resource access.
AppDefinition Defines an application definition.
AppDefinitionApiRequiredScopesChanges Describes an app definition API required scopes changes.
AppDefinitionChanges Describes an app definition changes.
AppDefinitionChangesResult Describes an app definition changes result.
AppDefinitionDependenciesChanges Describes an app definition dependencies changes.
AppDefinitionDependency Describes an app definition dependency.
AppDefinitionFeature Defines an application definition feature.
AppDefinitionFeaturesChanges Describes an app definition features changes.
AppDefinitionResource Defines an application definition resource.
AppDefinitionResourcesChanges Describes an app definition resources changes.
AppDefinitionRolesChanges Describes an app definition roles changes.
AppDefinitionTranslation Describes an app definition translation.
AppInstance Defines an application instance.
AppInstanceCompany Describes an app instance company.
AppInstanceFeature Defines an application instance feature.
AppInstanceItems Represents a paginated result of application instances.
AppInstanceResource Defines an application instance resource.
AppInstanceStateChangedPayload Describes an app instance state changed payload.
AppRole Describes an app role.
AppRoleTranslation Describes an app role translation.
AuditableEntity Describes an auditable entity.
BaseACLResource Describes an ACL resource.
BaseACLResourceAccess Describes a base acl resource access.
BaseACLSubject Describes a base acl subject.
BaseACLSubjectAccess Describes a base acl subject access.
BaseAppDefinitionChanges Describes a base app definition changes.
BaseEntity Defines the base entity that has a key.
BaseResourceOperationEntity Describes a base resource operation entity.
BaseResourceSubjectRoles Describes a base resource subject roles.
BaseSubjectRoles Describes a base subject roles.
BasicAppDefinition Defines an application definition.
ChangeDefinitionBody Defines the move definition operation parameters.
ChangeOrganizationBody Defines the move instance operation parameters.
Company Describes a company.
CompanyProperty Describes a company property.
ConvertAppInstanceBody Defines the move definition operation parameters.
CreatedAppInstance Describes information about creation of an AppInstance.
CreatedEntity Describes a created entity.
DataExport Describes a data export: the asynchronous job that streams the requested datasets from one database snapshot into part files, and, once completed, its manifest.
DataExportBundleDefinition Describes a configured bundle: a named, versioned set of datasets (with their parameters) that are always exported together from one snapshot.
DataExportBundleReference Identifies the bundle an export was requested with.
DataExportCatalog Describes the data export catalog: the registered datasets and the configured bundles.
DataExportDataset Describes an exported dataset in the manifest: the version and effective parameters it was exported with, its parts and statistics. The effective parameters (a JSON object) are exposed by a hand-written partial, since the model designer cannot express a dictionary of typed JSON values.
DataExportDatasetDefinition Describes a dataset registered in the data export catalog: its name, version, parameters and the statistics it produces.
DataExportDatasetRequest Identifies a catalog dataset to export. The dataset parameters (a JSON object whose members are defined by the dataset) are exposed by a hand-written partial, since the model designer cannot express a dictionary of typed JSON values.
DataExportDatasetStatistics Describes the statistics a dataset produced while it was exported.
DataExportManifest Describes a completed data export: when and from which snapshot it was taken, and the files of every exported dataset. It is the last blob written by an export, so its existence means the export is complete.
DataExportParameterDefinition Describes a parameter accepted by a catalog dataset.
DataExportPart Describes one part file of an exported dataset.
DataExportRequest Describes a data export request: the datasets to export, named either through a configured bundle or as an explicit list, and the optional part size. Exactly one of Bundle or Datasets must be supplied.
DataExportStateChanged Describes a data export state change, the payload of the DataExport_Changed webhook. It carries no download addresses: the consumer reads the export through the API.
EffectiveAclDriftRepairAppInstanceCount Describes the drift of one application instance found or repaired by an effective acl drift repair job.
EffectiveAclDriftRepairSummary Describes the outcome of an effective acl drift repair job, stored as the job result: the drift counted by a preview or repaired by an apply (the entry counters of an apply are the entries it repaired), in total, per workspace and per application instance, and, on an apply, the remaining drift. A cancelled job stores the outcome of the batches it completed.
EffectiveAclDriftRepairWorkspaceCount Describes the drift of the application instances of one workspace found or repaired by an effective acl drift repair job.
EffectiveAclRebuildSummary Describes the outcome of an effective acl rebuild job, stored as the job result.
EntityDeletedPayload The payload to send on a entity deleted event.
ExpandableAppInstance Describes an expandable app instance.
ExpandableOrganization Describes an expandable organization.
ExpandableWorkspace Describes an expandable workspace.
FullAccessEntry Describes a full access entry.
LocalizablePropertyValue Describes a localizable property value.
Organization Defines an organization.
PaginatedItems Defines the base attributes for an entity with searchable paginated results.
PropertyChange Describes a property change.
ProvisioningOperationDependencyEntity Describes a dependency edge between two provisioning operations of the same batch: the dependent operation can only be dispatched after the operation it depends on finishes. Edges are persisted at plan time (deduplicated - a diamond in the definition tree produces a single operation per instance), so the dispatch order is immune to application definition changes made while a batch is in flight.
ProvisioningOperationEntity Describes a provisioning operation against an application instance - the orchestration backbone for the dependency-ordered provisioning flow. One row per application instance per batch; a filtered unique index guarantees at most one live (non-terminal) operation per application instance. The identifier doubles as the correlation stamp: it is sent to the Provisioning service as a custom operation parameter and echoed back in the webhook parameters.
ProvisioningResult Describes a provisioning result.
ResourceOperationApplyResult Describes a resource operation apply result.
ResourceOperationEntity Describes a resource operation entity.
ResourceOperationPreviewItem Describes one item of the computed projection that a registered resource operation would affect. The meaning of an item depends on the operation kind - for the CBMS migration handover, each item is a company eligible to be claimed by CBMS.
ResourceOperationRequest Describes a resource operation request.
ResourceOperationsApplyRequest Describes a resource operations apply request.
ResourceSubjectRolesRequest Describes a resource subject roles request.
ResourceSubjectRolesResponse Describes a resource subject roles response.
RoleApplyResult Describes a role apply result.
RoleEntryResponse Describes a role entry response. Intentionally standalone (does not inherit BaseACLSubject) so it does not share a base entity type with AccessEntryResponse in the accesses OData model; see RestApi/ODataModelsBuilder.AddRoleEntryResponse.
RolesApplyRequest Describes a roles apply request.
RolesAssignment Describes a Roles Assingment.
RolesAssignments Describes a roles assignments.
SubjectResourceRolesRequest Describes a subject resource roles request.
SubjectRolesRequest Describes a subject roles request.
SubjectRolesResponse Describes a subject roles response.
TransferAppInstanceBody Defines the move instance operation parameters.
Workspace Defines a workspace.
WorkspaceCompany Describes a workspace company.

The service includes custom models not described here.

^ Back to top

Enumerations

Enumeration Description
AccessChange Defines an access change.
AccessKind Defines how the access to a resource is obtained relatively to other resources.
AccessModelCopyAccessConflict Defines how a copied allow access (read only or read write) is reconciled with an explicit allow access the subject already holds on the same target resource. A denied access always wins, whichever side it comes from.
AccessModelCopyCompanyMatch Defines how a source company that is not in the explicit company map is matched against the companies of the target workspace.
AccessModelCopyCompanyOnlySubjects Defines what subjects that only hold company level accesses on the source application instance receive when companies are not copied.
AccessModelCopyCompanyProperties Defines how the properties of a source company are applied to a target company that already exists. Property names are compared case insensitively; properties that exist only on the target are always kept.
AccessModelCopyMode Defines the mode of an access model copy request.
AccessModelCopyMultipleRoleConflict Defines how copied company role assignments are reconciled with the roles the subject already holds on the same target company, when the application definition allows multiple roles.
AccessModelCopySingleRoleConflict Defines how a copied company role assignment is reconciled with a different role the subject already holds on the same target company, when the application definition allows a single role per company.
AccessModelCopyTopInheritedStrategy Defines how the accesses a subject inherits on the source application instance from its organization or workspace are copied.
AccessRight Defines the allowed access right.
AccessType Defines the type of the access.
AppDefinitionContext Defines the application definition context.
AppDefinitionRoleMode Defines the role modes of an application definition.
AppFeatureType Defines the type of an application feature.
AppInstanceState Defines the states of an application instance.
ApplyOperation Defines an apply operation.
EffectiveAclDriftRepairMode Defines the mode of an effective acl drift repair request.
EffectiveAclDriftRepairScope Defines the scope of an effective acl drift repair.
EffectiveAclRebuildMode Defines how far an effective acl rebuild recomputes each subject.
JobStatus Defines a job status.
JobType Defines a job type.
OrganizationState Defines the states of an organization.
ProvisioningOperationKind Defines the kind of a provisioning operation. Decided per application instance at plan time: an instance that was previously provisioned (Active, Failed or Suspended) is reprovisioned, any other instance goes through initial provisioning, and a provisioning run fired by an update of the instance configuration is a configuration update.
ProvisioningOperationStatus Defines the status of a provisioning operation. Transitions are monotonic: Planned, Sent, Started, then a terminal status (Finished, Failed or Canceled); Started may be skipped by fast operations. The numeric values are part of the persisted contract - the filtered unique index on live operations depends on them.
ResourceOperationApplyChange Defines the kind of change applied to a resource operation entry by an apply request.
ResourceOperationKind Defines the kind of operation registered against a resource. The kind determines the validation, the preview projection, and the execution behavior.
ResourceOperationState Defines the state of a registered resource operation in its queue lifecycle.
ResourceType Defines the type of the resource to provide access to.
RoleChange Defines a role change.
RoleOperation Defines a role operation.
SubjectType Defines the allowed subject types.
WorkspaceState Defines the states of a workspace.

^ Back to top

Authorization Policies

Policy Description Scope
DefaultScope Defines an authorization policy that requires the default scope. lithium-juice-apps
AccessAuth Policy that handles access authorization to service resources. N/A
AccessControlListAuth Policy that handles authorization to service resources. N/A
AccessesACLAuth Policy that handles accesses endpoints authorization based on subject's ACL. N/A
AccessTriggerProvisioning Trigger provisioning for the app instance. lithium-juice-apps-provisioning
AppDefinitionACLAuth Policy that handles AppDefinition endpoints authorization based on subject's ACL. N/A
AppInstanceACLAuth Policy that handles AppInstance endpoints authorization based on subject's ACL. N/A
CompanyACLAuth Policy that handles Company endpoints authorization based on subject's ACL. N/A
CreateTopLevelResourcesAuth Policy that handles access to creation of Workspaces and AppDefinitions. N/A
DataExportAuth Policy that handles the data exports endpoints authorization. Requires the default scope and the dedicated data export scope, and the requester must be a full-access subject. N/A
DefaultConfigurationAuth Policy that handles access to configuration operations. N/A
FullAccessAuth Policy that handles full access authorization to service resources. N/A
OrganizationACLAuth Policy that handles Organization endpoints authorization based on subject's ACL. N/A
ResourceACLAuth Policy that handles Resources endpoints authorization based on subject's ACL. N/A
ResourceOperationACLAuth Policy that handles the resource operations endpoints authorization. Requires the default and configuration scopes (fail fast); per-resource access validation happens in the application layer, since requests are multi-resource. N/A
SubjectACLAuth Policy that handles Subjects endpoints authorization based on subject's ACL. N/A
WorkspaceACLAuth Policy that handles workspace endpoints authorization based on subject's ACL. N/A
Webhooks Defines an authorization policy to access the webhooks endpoints. lithium-juice-apps-wh

^ Back to top

Reference

Service Client

ApplicationsClient

Constructors
ApplicationsClient(Uri, BearerTokenCredential)
Parameter Type Description
serviceUri Uri The service URI.
credential BearerTokenCredential The credential that should be used to access the service.
ApplicationsClient(Uri, BearerTokenCredential, ApplicationsClientOptions)
Parameter Type Description
serviceUri Uri The service URI.
credential BearerTokenCredential The credential that should be used to access the service.
clientOptions ApplicationsClientOptions The client options.
Example
Uri address = new Uri("[service-address]");
Uri authorizationServer = new Uri("[authorization-server]");
string clientId = "[client-id]"
string clientSecret = "[client-secret]"

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

^ Back to top

Error Codes

ErrorCodes

Constants
Constants Description Remarks
AccessEntryNotFound Indicates that the subject has no access entry on the specified resource.
AccessModelCopyAppDefinitionMismatch Indicates that the source and target application instances of an access model copy do not share the same application definition.
AccessModelCopyPreviewAlreadyApplied Indicates that an apply was already registered for the referenced access model copy preview.
AccessModelCopyPreviewExpired Indicates that the access model copy preview referenced by an apply has expired; a new preview is needed.
AccessModelCopyPreviewNotApplicable Indicates that the job referenced by an access model copy apply is not a completed access model copy preview.
AccessModelCopySameWorkspace Indicates that the source and target application instances of an access model copy belong to the same workspace.
ApiScopesNotFound Indicates that the API scopes were not found in Cegid Id.
AppDefinitionCannotBeChanged The appinstance associated appdefinition cannot be changed.
AppDefinitionDependenciesWithDuplicatedGroups Indicates that there are dependencies with same group between them, which is not allowed.
AppDefinitionDependenciesWithNoGroup Indicates that there are dependencies with no group defined, which is not allowed to work with dependencies.
AppDefinitionDependencyWithSameGroupAsMain Indicates that there are dependencies with the same group as the dependent, which is not allowed.
AppDefinitionGroupCannotBeModified The application definition group cannot be modified.
AppDefinitionIsBeingUsedAsDependency The application definition is being used as dependency.
AppDefinitionKeysNotFound The AppDefinition keys were not found.
AppDefinitionNotFound The AppDefinition was not found.
AppDefinitionRoleIsInUse The application definition role is in use.
AppInstanceBaseKeyCannotBeChanged The appinstance base key cannot be changed.
AppInstanceClosed The application instance does not support companies.
AppInstanceCompaniesNotSupported The application instance does not support companies.
AppInstanceCompanyKeysNotFound The AppInstanceCompany keys were not found.
AppInstanceCompanyNotFound The AppInstance company association was not found.
AppInstanceHasActiveDependents Indicates that an Application Instance has instances dependent on it.
AppInstanceKeyCannotBeChanged The appinstance key cannot be changed.
AppInstanceKeysNotFound The AppInstance keys were not found.
AppInstanceNotFound The AppInstance was not found.
AppInstancePathInvalid The AppInstance path is invalid.
AssetNotFound The asset was not found.
DataExportInvalidParameters Indicates that the parameters supplied for a dataset in a data export request are invalid: unknown name, wrong type, value not allowed or required parameter missing.
DataExportUnknownBundle Indicates that the data export request names a bundle that is not configured.
DataExportUnknownDataset Indicates that the data export request names a dataset that is not registered in the catalog.
EffectiveAclDriftRepairApplyInProgress Indicates that another apply of the referenced effective acl drift repair preview is pending or running; wait for it to end (or cancel it) before applying the preview again.
EffectiveAclDriftRepairKeysNotInPreview Indicates that some application instance or workspace keys selected by an effective acl drift repair apply are not among the ones with drift the referenced preview found.
EffectiveAclDriftRepairPreviewExpired Indicates that the effective acl drift repair preview referenced by an apply has expired; a new preview is needed.
EffectiveAclDriftRepairPreviewNotApplicable Indicates that the job referenced by an effective acl drift repair apply is not a completed effective acl drift repair preview.
EnableCompaniesCannotBeModified The enable companies cannot be modified.
EntityKeyCannotBeModified The entity key cannot be modified.
EntityRelationshipViolation The entity relationship violation.
EntityRelationshipWithDuplicateKeys The entity relationship with duplicate keys.
EntityWithSpecifiedKeyAlreadyExists The entity with specified key already exists.
EntityWithSpecifiedKeyNotFound The entity with specified key not found.
InternalServerError An internal error occurred while processing your request.
InvalidAccesses The accesses are invalid.
InvalidAppDefinition The app definition is invalid.
InvalidAppInstanceCompanyKeyFormat The application instance company key format is invalid.
InvalidAppInstanceContextCreation The app instance context is invalid.
InvalidAppInstanceGroup The application instance group is invalid.
InvalidAppInstanceResources Invalid app instance resources.
InvalidAppInstanceState The app instance state is invalid.
InvalidCompanyCreation Indicates that the creation of a company is invalid.
InvalidDenyAccess The invalid deny access.
InvalidDuplicatedEntries Indicates that there are invalid duplicated entries in a request.
InvalidFileFormat Indicates that a file has an invalid format.
InvalidOrganization The organization is invalid.
InvalidParentState The parent state is invalid.
InvalidProvisioningState The provisioning state is invalid.
InvalidResourceCreation The resource creation is invalid.
InvalidResourceType The resource type is invalid.
InvalidResourceTypeForOperationKind Indicates that the resource type of an entry is not supported by the specified operation kind.
InvalidRoleMode The role mode is invalid.
InvalidRouteParameters The route parameters are invalid.
InvalidStateTransition The state transition is invalid.
InvalidSubjectRoles The subject roles are invalid.
InvalidSubjects The subjects are invalid.
JobNotCancellable Indicates that the job cannot be cancelled: only effective acl rebuild and drift repair jobs that are pending, running or failed can be cancelled.
JobNotRetryable Indicates that the job cannot be retried because it is not in the Failed status.
MaxApplyEntriesExceeded Indicates that the number of entries in an apply request exceeds the configured maximum allowed.
MaxFileSizeExceeded Indicates that the maximum allowed size of a file was exceeded.
NoAppInstancesWhereDeleted Inidicates that no AppInstances where deleted.
OrganizationKeysNotFound The Organization keys were not found.
OrganizationNotFound The Organization was not found.
RequestArgsInvalid The request arguments are invalid.
RequestSubjectInvalidAccesses The request subject has invalid accesses.
ResourceNotFound The resource was not found.
ResourceOperationAlreadyCompleted Indicates that the resource operation entry was already completed and cannot be updated. Delete the completed entry first to register the resource again.
ResourceOperationIsProcessing Indicates that the resource operation entry is currently being processed and cannot be updated or deleted.
ResourcesNotFound Indicates that there are resources that were not found.
ResourcesNotFoundInSubjectAccessList The resources were not found in subject's access list.
RoleModeCannotBeModified The role mode cannot be modified.
SubjectNotFound The subject was not found.
SubjectRolesNotFound The subject roles were not found.
SubjectsNotFound Indicates that there are subjects that were not found.
TargetSubjectHasFullAccess The target subject has full access.
TargetSubjectTypeMismatch The target subject type mismatch.
TrackingIdRequiredForOperationKind Indicates that the operation kind requires a tracking identifier and an entry does not specify one.
Validation One or more validation errors found.
WorkspaceKeysNotFound The Workspace keys were not found.
WorkspaceNotFound The Workspace was not found.
WriteProtectedFeatureCannotBeModified Indicates that an attempt to perform a write operation in a write protected feature was made by an unauthorized client.

Controllers

AccessesClientController

Provides operations on accesses.

Methods
ApplyAsync()

Applies an access operation (AddOrUpdate or Delete) over a batch of access entries as a single atomic unit. The explicit access changes are persisted synchronously; the effective (inherited) access is recomputed asynchronously.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AccessApplyResult>>> ApplyAsync(Cegid.Lithium.Applications.Client.Rest.Models.AccessesApplyRequest accessesOperation, bool propagateAccesses = true, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
accessesOperation Cegid.Lithium.Applications.Client.Rest.Models.AccessesApplyRequest The accesses operation. Includes a collection of entries to be affected, and the operation to be executed for that entries, that may be AddOrUpdate (0) or Delete (1). Required.
propagateAccesses bool The propagate accesses flag. When true (default), the application instance and application instance company entries are also applied to the dependent application instances, according to the application definitions dependency tree. When set to false, only the sent entries are applied. Required.
Returns
Return Type Description
System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AccessApplyResult> A collection of the affected explicit access entries and the change applied to each. This is not a 1-to-1 mapping of the request: inheritance rules may cascade changes to additional entries, and entries that end up unchanged are omitted as no-ops. For example, a request with 10 changes may return fewer or more than 10 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

ApplyRolesAsync()

Applies a roles operation (Set or Delete) over a batch of subject-and-resource role entries as a single atomic unit. Set is declarative: it reconciles the subject's roles on a resource to exactly the roles supplied, adding the missing ones and removing any not listed, so each entry must carry the full desired set of roles. Delete removes all of the subject's roles on the resource and ignores the roles list. Entries must target an application instance or an application-instance company; any other resource type is rejected, as roles only exist at those grains.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.RoleApplyResult>>> ApplyRolesAsync(Cegid.Lithium.Applications.Client.Rest.Models.RolesApplyRequest rolesOperation, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
rolesOperation Cegid.Lithium.Applications.Client.Rest.Models.RolesApplyRequest The roles operation. Includes a collection of entries grouped by resource + subject, with a set of roles to be affected; and the operation to be executed for that entries, that may be Set (0) or Delete (1). Required.
Returns
Return Type Description
System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.RoleApplyResult> A flat collection of the affected role assignments and the change applied to each (Created or Deleted), one row per role added or removed. Because Set reconciles to the desired set, the result is not a 1-to-1 mapping of the request: a single entry may both create and delete rows, and roles already in the desired state are omitted as no-ops.
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

ReadEntryAsync()

Reads the access entry of a specific subject on a specific resource. Unlike the OData searches, this read considers full access: a full-access subject is reported with a synthesized read-write explicit entry on the resource, even though it holds no materialized access entries.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.AccessEntryResponse>> ReadEntryAsync(string subjectId, Cegid.Lithium.Applications.Client.Rest.Models.ResourceType resourceType, string resourceKey, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
subjectId string The subject id. Required.
resourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType The resource type. Required.
resourceKey string The resource key. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.AccessEntryResponse The subject's access entry on the resource, including a denied entry when the access is explicitly denied. Full-access subjects are reported as read-write and explicit. Returns not found when the resource does not exist, when the subject does not exist, or when the subject has no access entry on the resource (also when the entry exists but is outside the requester's visibility).
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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()

Searches access entries using OData query options. Full-access subjects, which hold no materialized access entries, are only listed when the optional X-APPS-IncludeFullAccesses request header is true: each one then comes with a synthesized read-write explicit entry on every visible resource, and the filter must narrow the search by subject identifier, resource identifier or resource key (equality, in, or a non-empty starts-with on the resource key). The header is read by hand-written code because the designer does not allow parameters on OData actions; the client library exposes it through a SearchAsync overload with an includeFullAccesses argument.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.AccessEntryResponse>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.AccessEntryResponse> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.AccessEntryResponse> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.AccessEntryResponse> The access entries matching the supplied OData criteria, restricted to the resources the requester subject can access. Entries for resources outside the requester's visibility are never returned. Full-access subjects are only included when requested, reported as read-write and explicit on every visible resource.
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

SearchRolesAsync()

Searches subject role assignments using OData query options.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.RoleEntryResponse>>> SearchRolesAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.RoleEntryResponse> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.RoleEntryResponse> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.RoleEntryResponse> The subject role assignments matching the supplied OData criteria, one row per assigned role, restricted to the resources the requester subject can access. Role assignments only exist on application instances and application-instance companies.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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

AppDefinitionsClientController

The application definitions controller.

Methods
AddOrUpdateIconAsync()

Adds or updates the AppDefinition icon.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> AddOrUpdateIconAsync(string key, Cegid.Hydrogen.Rest.Client.MultipartItem file, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The AppDefinition key. Required.
file Cegid.Hydrogen.Rest.Client.MultipartItem The logo file. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

AddOrUpdateLogoAsync()

Adds or updates the AppDefinition logo.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> AddOrUpdateLogoAsync(string key, Cegid.Hydrogen.Rest.Client.MultipartItem file, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The AppDefinition key. Required.
file Cegid.Hydrogen.Rest.Client.MultipartItem The logo file. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

CreateAsync()

Creates an application definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.CreatedEntity>> CreateAsync(Cegid.Lithium.Applications.Client.Rest.Models.AppDefinition appDefinition, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
appDefinition Cegid.Lithium.Applications.Client.Rest.Models.AppDefinition The application definition. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.CreatedEntity The created application definition.
Status Codes
Status Code Description
HttpStatusCode.Created 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

DeleteAsync()

Deletes an application definition through the specified key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string key, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The application definition key. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

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

DeleteIconAsync()

Deletes the icon of the specified AppDefinition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteIconAsync(string key, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The AppDefinition key. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

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

DeleteLogoAsync()

Deletes the logo of the specified AppDefinition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteLogoAsync(string key, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The AppDefinition key. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

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

ReadAsync()

Gets an application definition through the specified key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinition>> ReadAsync(string key, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The application definition key. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.AppDefinition The application definition that matches the specified key. If not found, returns no content.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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

ReadIconAsync()

Read the logo of the specified AppDefinition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<byte[]>> ReadIconAsync(string key, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The AppDefinition key. Required.
Returns
Return Type Description
byte[] The icon of the specified AppDefinition as a byte array.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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

ReadLogoAsync()

Read the logo of the specified AppDefinition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<byte[]>> ReadLogoAsync(string key, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The AppDefinition key. Required.
Returns
Return Type Description
byte[] The logo of the specified AppDefinition as a byte array.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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()

Search using odata for application definitions that the authenticated subject has access to.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinition>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinition> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinition> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinition> The found AppDefinitions that match with received OData criteria.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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()

Updates an application definition through the specified key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(string key, Cegid.Lithium.Applications.Client.Rest.Models.AppDefinition appDefinition, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The application definition key. Required.
appDefinition Cegid.Lithium.Applications.Client.Rest.Models.AppDefinition The application definition. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

AppInstancesClientController

The application instances controller.

Methods
ChangeDefinitionAsync()

Creates a copy of the specified application instance with the new application definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<string>> ChangeDefinitionAsync(string key, Cegid.Lithium.Applications.Client.Rest.Models.ChangeDefinitionBody parameters, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The application instance key. Required.
parameters Cegid.Lithium.Applications.Client.Rest.Models.ChangeDefinitionBody The aplication definition move operation arguments. Required.
Returns
Return Type Description
string The created application instance 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

ChangeOrganizationAsync()

Creates a copy of the specified application instance within the new organization.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<string>> ChangeOrganizationAsync(string key, Cegid.Lithium.Applications.Client.Rest.Models.ChangeOrganizationBody parameters, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The application instance key. Required.
parameters Cegid.Lithium.Applications.Client.Rest.Models.ChangeOrganizationBody The aplication definition move operation arguments. Required.
Returns
Return Type Description
string The created application instance 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

ConvertAsync()

Creates a copy of the specified application instance with the new application definition.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.CreatedEntity>> ConvertAsync(string workspace, string organization, string key, Cegid.Lithium.Applications.Client.Rest.Models.ConvertAppInstanceBody parameters, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
organization string The organization key. Required.
key string The application instance key. Required.
parameters Cegid.Lithium.Applications.Client.Rest.Models.ConvertAppInstanceBody The convert operation arguments. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.CreatedEntity The created application instance 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

CreateAsync()

Creates an application instance.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.CreatedAppInstance>> CreateAsync(string workspace, string organization, Cegid.Lithium.Applications.Client.Rest.Models.AppInstance appInstance, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
organization string The organization key. Required.
appInstance Cegid.Lithium.Applications.Client.Rest.Models.AppInstance The application instance. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.CreatedAppInstance The created application instance with details about dependencies, if any.
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

DeleteAsync()

Deletes an application instance through the specified key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string workspace, string organization, string key, bool? force = false, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
organization string The organization key. Required.
key string The application instance key. Required.
force bool? A value indicating whether to force the delete in some conditions, for example, trying to delete the instance when it has active dependents. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

ReadAsync()

Gets an application instance through the specified key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.AppInstance>> ReadAsync(string workspace, string organization, string key, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
organization string The organization key. Required.
key string The application instance key. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.AppInstance The application instance that matches the specified key. If not found, returns no content.
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

ReadHistoryAsync()

Gets an application instance history through the specified key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.AppInstanceItems>> ReadHistoryAsync(string workspace, string organization, string key, int pageNumber, int pageSize, System.DateTime startDate, System.DateTime endDate, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
organization string The organization key. Required.
key string The application instance key. Required.
pageNumber int The page number. Required.> 0.
pageSize int The page size. Required.> 0.
startDate System.DateTime The history start date. Required.
endDate System.DateTime The history end date. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.AppInstanceItems The application instance history that matches the specified key. If not found, returns no content.
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

SearchAsync()

Search using odata for application instances that the authenticated subject has access to.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableAppInstance>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableAppInstance> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableAppInstance> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableAppInstance> The found AppInstances that match with received OData criteria.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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

TransferAsync()

Creates a copy of the specified application instance within the new organization.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.CreatedEntity>> TransferAsync(string workspace, string organization, string key, Cegid.Lithium.Applications.Client.Rest.Models.TransferAppInstanceBody parameters, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
organization string The organization key. Required.
key string The application instance key. Required.
parameters Cegid.Lithium.Applications.Client.Rest.Models.TransferAppInstanceBody The aplication definition move operation arguments. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.CreatedEntity The created application instance 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

TriggerProvisioningAsync()

Trigger provisioning for the app instance.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.ProvisioningResult>> TriggerProvisioningAsync(string workspace, string organization, string key, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
organization string The organization key. Required.
key string The key of the app instance. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.ProvisioningResult A result of provisioning with details of dependencies, if any.
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()

Updates an application instance through the specified key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(string workspace, string organization, string key, Cegid.Lithium.Applications.Client.Rest.Models.AppInstance appInstance, bool? force = false, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
organization string The organization key. Required.
key string The app instance key. Required.
appInstance Cegid.Lithium.Applications.Client.Rest.Models.AppInstance The application instance. Required.
force bool? A value indicating whether to force the update in some conditions, for example, trying to close the instance when it has active dependents. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

CompaniesClientController

Provides operations on companies.

Methods
AddOrUpdateAsync()

Register a company to the application instance.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.CreatedEntity>> AddOrUpdateAsync(string workspace, string organization, string appInstance, Cegid.Lithium.Applications.Client.Rest.Models.Company company, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace. Required.
organization string The organization. Required.
appInstance string The app instance. Required.
company Cegid.Lithium.Applications.Client.Rest.Models.Company The company. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.CreatedEntity The registered association key.
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

DeleteAsync()

Unregister a company from an application instance.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string workspace, string organization, string appInstance, string companyKey, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace. Required.
organization string The organization. Required.
appInstance string The app instance. Required.
companyKey string The company key. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

DataExportsClientController

Provides operations on data exports: asynchronous jobs that stream catalog datasets from one database snapshot into gzip NDJSON part files, described by a manifest, for consumers that need a consistent copy of the data. Reserved for server-to-server consumers holding the data export scope with full access.

Methods
CreateAsync()

Requests a data export. The request names a configured bundle or lists the datasets explicitly (exactly one of the two); every dataset name is validated against the catalog and every parameter against the dataset definition, with defaults filled in. The export runs asynchronously as a job that reads all datasets from one database snapshot.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.DataExport>> CreateAsync(Cegid.Lithium.Applications.Client.Rest.Models.DataExportRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Lithium.Applications.Client.Rest.Models.DataExportRequest The data export request. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.DataExport The registered export, in the Pending status (or the export already active), with its identifier.
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

DeleteAsync()

Deletes a data export: cancels it when it is still pending or running (the job stops at the next part boundary and ends in the Cancelled status) and removes its part files and manifest from storage. The export record itself is kept for audit.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(System.Guid id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id System.Guid The export identifier. Required.Not empty.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

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

ReadAsync()

Reads a data export by its identifier, including the manifest once the export completed.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.DataExport>> ReadAsync(System.Guid id, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
id System.Guid The export identifier. Required.Not empty.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.DataExport The data export. The manifest is present only when the status is Completed; the error is present only when the status is Failed.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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

ReadCatalogAsync()

Reads the data export catalog: the registered datasets (name, version, parameters, statistics) and the configured bundles (name, version, datasets with their parameters).

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.DataExportCatalog>> ReadCatalogAsync(CancellationToken cancellationToken = default);
Parameters

The operation has no parameters.

Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.DataExportCatalog The data export catalog.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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()

Searches data exports using OData query options.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.DataExport>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.DataExport> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.DataExport> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.DataExport> The data exports matching the supplied OData criteria, without manifests (read one export to get its manifest).
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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

OrganizationsClientController

The organizations controller.

Methods
CreateAsync()

Creates an organization.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.CreatedEntity>> CreateAsync(string workspace, Cegid.Lithium.Applications.Client.Rest.Models.Organization organization, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
organization Cegid.Lithium.Applications.Client.Rest.Models.Organization The organization. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.CreatedEntity The created organization.
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

DeleteAsync()

Deletes an organization through the specified key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string workspace, string key, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
key string The organization key. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

ReadAsync()

Gets organization through the specified key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.Organization>> ReadAsync(string workspace, string key, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
key string The organization key. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.Organization The organization that matches the specified key. If not found, returns no content.
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()

Search using odata for organizations that the authenticated subject has access to.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableOrganization>>> SearchAsync(string workspace, Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableOrganization> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableOrganization> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableOrganization> The found Organizations that match with received OData criteria.
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()

Updates an organization.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(string workspace, string key, Cegid.Lithium.Applications.Client.Rest.Models.Organization organization, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace string The workspace key. Required.
key string The organization key. Required.
organization Cegid.Lithium.Applications.Client.Rest.Models.Organization The organization. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

ResourceOperationsClientController

Provides operations on the resource operations registry - a generic queue of operations to perform against resources, registered for later or immediate execution.

Methods
ApplyAsync()

Applies an operation (AddOrUpdate or Delete) over a batch of resource operation entries as a single atomic unit. AddOrUpdate registers (or updates) the entries in the Pending state and is idempotent - resending the same request is a no-op, not a duplicate. Delete cancels registered entries that were not executed yet. Each entry is validated according to its operation kind (for example, the CBMS migration handover only accepts application definition resources).

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationApplyResult>>> ApplyAsync(Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationsApplyRequest operation, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
operation Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationsApplyRequest The operation. Required.
Returns
Return Type Description
System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationApplyResult> A collection of the affected entries and the change applied to each (Created, Updated, or Deleted). Entries that end up unchanged are omitted as no-ops.
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

PreviewAsync()

Previews, using OData query options, the computed projection of what the registered resource operations would affect. Filter by operationKind (and optionally trackingId, to narrow to one registration batch such as a product's handover) to preview a specific set. The projection is computed on demand from the current data, so it always reflects the present state and may change between calls. For the CBMS migration handover, it returns the companies eligible to be claimed by CBMS - those whose application instance associations all belong to the handed-over application definitions.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationPreviewItem>>> PreviewAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationPreviewItem> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationPreviewItem> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationPreviewItem> The page of preview items matching the supplied OData criteria. Returns an empty collection when nothing is affected or nothing is registered for the given criteria.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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()

Searches for resource operations that match OData query criteria.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationEntity>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationEntity> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationEntity> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationEntity> The collection of the found resource operations.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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

ResourcesClientController

Provides operations on resources.

Methods
AddOrUpdateAccessesAsync()

Save accesses to the specified resource for one or more subjects that should be specified in the request body.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> AddOrUpdateAccessesAsync(Cegid.Lithium.Applications.Client.Rest.Models.ResourceType resourceType, string resourceKey, System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.ACLSubjectAccessRequest> accesses, bool propagateAccesses = true, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
resourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType The resource type.
resourceKey string The resource key. Required.
accesses System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.ACLSubjectAccessRequest> The accesses. Required.
propagateAccesses bool The propagate accesses flag. When set to false, the accesses propagation behavior configured in the AppDefinition will be overriden. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

AddSubjectRolesAsync()

Adds subject roles for the specified resource to one or more subjects that should be specified in the request body.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> AddSubjectRolesAsync(Cegid.Lithium.Applications.Client.Rest.Models.ResourceType resourceType, string resourceKey, System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.ResourceSubjectRolesRequest> subjectsRoles, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
resourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType The resource type.
resourceKey string The resource key. Required.
subjectsRoles System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.ResourceSubjectRolesRequest> The subjects roles. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

RemoveAccessesAsync()

Removes accesses to a specific resource for the specified subjects in the payload.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> RemoveAccessesAsync(Cegid.Lithium.Applications.Client.Rest.Models.ResourceType resourceType, string resourceKey, System.Collections.Generic.IEnumerable<string> subjectIds, bool propagateAccesses = true, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
resourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType The resource type.
resourceKey string The resource key. Required.
subjectIds System.Collections.Generic.IEnumerable<string> The subject ids. Required.Not empty.
propagateAccesses bool The propagate accesses flag. When set to false, the accesses propagation behavior configured in the AppDefinition will be overriden. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

RemoveSubjectRolesAsync()

Removes subject roles from the specified resource from one or more subjects that should be specified in the request body.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> RemoveSubjectRolesAsync(Cegid.Lithium.Applications.Client.Rest.Models.ResourceType resourceType, string resourceKey, System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.ResourceSubjectRolesRequest> subjectsRoles, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
resourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType The resource type.
resourceKey string The resource key. Required.
subjectsRoles System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.ResourceSubjectRolesRequest> The subjects roles. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

SearchAccessesAsync()

Search using odata for subject accesses in a specific resource.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ACLSubjectAccessResponse>>> SearchAccessesAsync(Cegid.Lithium.Applications.Client.Rest.Models.ResourceType resourceType, string resourceKey, Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ACLSubjectAccessResponse> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
resourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType The resource type.
resourceKey string The resource key. Required.
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ACLSubjectAccessResponse> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ACLSubjectAccessResponse> The found ACLSubjectAccess that match with received OData criteria.
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

SearchSubjectRolesAsync()

Search using odata for subject roles in a resource that match the odata query options.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ResourceSubjectRolesResponse>>> SearchSubjectRolesAsync(Cegid.Lithium.Applications.Client.Rest.Models.ResourceType resourceType, string resourceKey, Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ResourceSubjectRolesResponse> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
resourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType The resource type.
resourceKey string The resource key. Required.
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ResourceSubjectRolesResponse> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ResourceSubjectRolesResponse> The resource subject roles.
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

SubjectsClientController

Provides operations related to resources and subjects accesses management.

Methods
AddOrUpdateAccessesAsync()

Adds or updates accesses for the specified subject to one or more resources that should be specified in the request body.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> AddOrUpdateAccessesAsync(string subjectId, System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.ACLResourceAccessRequest> accesses, bool propagateAccesses = true, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
subjectId string The subject id. Required.
accesses System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.ACLResourceAccessRequest> The accesses. Required.
propagateAccesses bool The propagate accesses flag. When set to false, the accesses propagation behavior configured in the AppDefinition will be overriden. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

AddSubjectRolesAsync()

Adds subject roles for the specified subject to one or more resources that should be specified in the request body.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> AddSubjectRolesAsync(string subjectId, System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.SubjectRolesRequest> subjectRoles, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
subjectId string The subject id. Required.
subjectRoles System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.SubjectRolesRequest> The subject roles. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

RemoveAccessesAsync()

Removes accesses for the specified subject to one or more resources that should be specified in the request body.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> RemoveAccessesAsync(string subjectId, System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.ACLResource> resources, bool propagateAccesses = true, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
subjectId string The subject id. Required.
resources System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.ACLResource> The resources. Required.
propagateAccesses bool The propagate accesses flag. When set to false, the accesses propagation behavior configured in the AppDefinition will be overriden. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

RemoveSubjectRolesAsync()

Removes subject roles from the specified subject from one or more resources that should be specified in the request body.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> RemoveSubjectRolesAsync(string subjectId, System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.SubjectRolesRequest> subjectRoles, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
subjectId string The subject id. Required.
subjectRoles System.Collections.Generic.IEnumerable<Cegid.Lithium.Applications.Client.Rest.Models.SubjectRolesRequest> The subject roles. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

SearchAccessesAsync()

Search using odata for a specific subject resource accesses.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ACLResourceAccessResponse>>> SearchAccessesAsync(string subjectId, Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ACLResourceAccessResponse> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
subjectId string The subject id. Required.
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ACLResourceAccessResponse> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ACLResourceAccessResponse> The found ACLResourceAccess that match with received OData criteria.
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

SearchSubjectRolesAsync()

Search using odata for a specific subject roles.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.SubjectRolesResponse>>> SearchSubjectRolesAsync(string subjectId, Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.SubjectRolesResponse> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
subjectId string The subject id. Required.
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.SubjectRolesResponse> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.SubjectRolesResponse> The found subject roles that match with received OData criteria.
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

WorkspacesClientController

The workspaces controller.

Methods
CreateAsync()

Creates a workspace.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.CreatedEntity>> CreateAsync(Cegid.Lithium.Applications.Client.Rest.Models.Workspace workspace, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
workspace Cegid.Lithium.Applications.Client.Rest.Models.Workspace The workspace. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.CreatedEntity The created workspace.
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

DeleteAsync()

Deletes a workspace through the specified key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteAsync(string key, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The workspace key. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.

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

ReadAsync()

Gets workspace through the specified key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Lithium.Applications.Client.Rest.Models.Workspace>> ReadAsync(string key, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The workspace key. Required.
Returns
Return Type Description
Cegid.Lithium.Applications.Client.Rest.Models.Workspace The workspace that matches the specified key. If not found, returns no content.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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()

Search using odata for workspaces that the authenticated subject has access to.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableWorkspace>>> SearchAsync(Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableWorkspace> queryOptions, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
queryOptions Cegid.Hydrogen.Rest.Client.OData.ODataQueryOptions<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableWorkspace> The OData query options. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.ODataResult<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableWorkspace> The found Workspaces that match with received OData criteria.
Status Codes
Status Code Description
HttpStatusCode.OK Success.

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()

Updates a workspace through the specified key.

public async Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateAsync(string key, Cegid.Lithium.Applications.Client.Rest.Models.Workspace workspace, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
key string The workspace key. Required.
workspace Cegid.Lithium.Applications.Client.Rest.Models.Workspace The workspace. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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

AccessApplyResult

Describes an access apply result.

Properties
Property Type Description Rules
Change Cegid.Lithium.Applications.Client.Rest.Models.AccessChange Gets or sets the change. Required.

^ Back to top

AccessEntryRequest

Describes an access entry request.

Properties

The model has no properties.

^ Back to top

AccessEntryResponse

Describes an access entry response.

Properties
Property Type Description Rules
ResourceId long Gets or sets the resource identifier. Only used for opaque pagination/identity. Required.
ResourcePath string Gets or sets the resource path. Required.
AccessKind Cegid.Lithium.Applications.Client.Rest.Models.AccessKind Gets or sets the access kind. Required.

^ Back to top

AccessesApplyRequest

Describes an accesses apply request.

Properties
Property Type Description Rules
Entries System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AccessEntryRequest> Gets or sets the entries. Required.
Operation Cegid.Lithium.Applications.Client.Rest.Models.ApplyOperation Gets or sets the operation. Required.

^ Back to top

AccessModelCopySummary

Describes the outcome of an access model copy job, stored as the job result: the plan fingerprint, the number of report lines per section, action and reason, and where the line-by-line report is stored.

Properties
Property Type Description Rules
Mode Cegid.Lithium.Applications.Client.Rest.Models.AccessModelCopyMode Gets or sets the job mode. Required.
PreviewJobId System.Guid? Gets or sets the identifier of the preview an apply executed. Null on a preview. Not empty.
Fingerprint string Gets or sets the SHA-256 fingerprint (hexadecimal) of the plan: the hash of its canonical, ordered report lines. An apply compares the fingerprint of the recomputed plan with the preview one and fails on any difference. Required.
LineCount int Gets or sets the number of lines of the plan (and of the report). Required.
ReportBlobName string Gets or sets the name of the gzip NDJSON report blob in the access model copy container. Required.
Isolation string Gets or sets the transaction isolation the plan was read under: Snapshot, or ReadCommitted when snapshot isolation is not allowed on the database. Required.
ExpiresOn System.DateTime? Gets or sets when the preview can no longer be applied (UTC). Null on an apply.
Counts System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AccessModelCopySummaryCount> Gets or sets the number of report lines per section, action and reason. Required.

^ Back to top

AccessModelCopySummaryCount

Describes the number of report lines of an access model copy plan with a given section, action and reason.

Properties
Property Type Description Rules
Section string Gets or sets the plan section (for example, Company, CompanyProperty or Association). Required.
Action string Gets or sets the planned action (for example, Create, Match, Add, Update or Skip). Required.
Reason string? Gets or sets why the action was planned (for example, the matching rule or why an item is skipped). Null when the action needs no explanation.
Count int Gets or sets the number of lines. Required.

^ Back to top

ACLEntries

Describes an acl entries.

Properties
Property Type Description Rules
Entries System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.ACLEntry> Gets or sets the ACL entries. Required.

^ Back to top

ACLEntry

Describes an ACL entry.

Properties
Property Type Description Rules
ResourceKey string Gets or sets the resource key. Required.
ResourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType Gets or sets the resource type. Required.

^ Back to top

ACLResource

Describes an acl resource.

Properties

The model has no properties.

^ Back to top

ACLResourceAccessRequest

Describes an acl resource access request.

Properties

The model has no properties.

^ Back to top

ACLResourceAccessResponse

Describes an ACL resource access.

Properties
Property Type Description Rules
AccessKind Cegid.Lithium.Applications.Client.Rest.Models.AccessKind? Gets or sets the access kind.
ResourcePath string Gets or sets the resource path. Required.

^ Back to top

ACLSubjectAccessRequest

Describes an ACL resource access.

Properties

The model has no properties.

^ Back to top

ACLSubjectAccessResponse

Describes an ACL resource access.

Properties
Property Type Description Rules
AccessKind Cegid.Lithium.Applications.Client.Rest.Models.AccessKind? Gets or sets the access kind.

^ Back to top

AppDefinition

Defines an application definition.

Properties
Property Type Description Rules
Resources System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionResource> The collection of application definition resources. Required.
Features System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionFeature> The application definition features. Required.
Roles System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppRole>? Gets or sets the roles.
Dependencies System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionDependency>? Gets or sets the dependencies.
DescriptionTranslations System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionTranslation>? Gets or sets the description translations.

^ Back to top

AppDefinitionApiRequiredScopesChanges

Describes an app definition API required scopes changes.

Properties
Property Type Description Rules
OriginalValues string? Gets or sets the original values.
CurrentValues string? Gets or sets the current values.

^ Back to top

AppDefinitionChanges

Describes an app definition changes.

Properties
Property Type Description Rules
OriginalValues Cegid.Lithium.Applications.Client.Rest.Models.BasicAppDefinition? Gets or sets the original values.
CurrentValues Cegid.Lithium.Applications.Client.Rest.Models.BasicAppDefinition? Gets or sets the current values.

^ Back to top

AppDefinitionChangesResult

Describes an app definition changes result.

Properties
Property Type Description Rules
AppDefinitionChanges Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionChanges? Gets or sets the app definition changes.
ApiRequiredScopesChanges Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionApiRequiredScopesChanges Gets or sets the API required scopes changes. Required.
DependenciesChanges Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionDependenciesChanges Gets or sets the dependencies changes. Required.
RolesChanges Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionRolesChanges Gets or sets the roles changes. Required.
ResourcesChanges Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionResourcesChanges Gets or sets the resources changes. Required.
FeaturesChanges Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionFeaturesChanges Gets or sets the features changes. Required.

^ Back to top

AppDefinitionDependenciesChanges

Describes an app definition dependencies changes.

Properties
Property Type Description Rules
OriginalValues System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionDependency> Gets or sets the original values. Required.
CurrentValues System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionDependency> Gets or sets the current values. Required.

^ Back to top

AppDefinitionDependency

Describes an app definition dependency.

Properties
Property Type Description Rules
AppDefinitionDependencyKey string Gets or sets the app definition dependency key. Required.
Description string? Gets or sets the description.

^ Back to top

AppDefinitionFeature

Defines an application definition feature.

Properties
Property Type Description Rules
Value string The feature value. Required.
Class string The feature class. Required.
Type Cegid.Lithium.Applications.Client.Rest.Models.AppFeatureType The application definition feature type. Required.
IsWriteProtected bool Gets or sets a value indicating whether the feature is write protected. Required.

^ Back to top

AppDefinitionFeaturesChanges

Describes an app definition features changes.

Properties
Property Type Description Rules
OriginalValues System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionFeature> Gets or sets the original values. Required.
CurrentValues System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionFeature> Gets or sets the current values. Required.

^ Back to top

AppDefinitionResource

Defines an application definition resource.

Properties
Property Type Description Rules
Description string The application definition resource description. Required.
Order int The application definition resource provisioning order. Required.> -1.
ProvisioningTask string? The application definition resource provisioning task. Should be executed when provisioning an application instance.
SuspensionTask string? The application definition resource suspension task. Should be executed when suspending an application instance.
DeprovisioningTask string? The application definition resource deprovisioning task. Should be executed when deprovisioning an application instance.
Type Cegid.Lithium.Applications.Client.Rest.Models.AppFeatureType The application definition resource feature type. Required.

^ Back to top

AppDefinitionResourcesChanges

Describes an app definition resources changes.

Properties
Property Type Description Rules
OriginalValues System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionResource> Gets or sets the original values. Required.
CurrentValues System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionResource> Gets or sets the current values. Required.

^ Back to top

AppDefinitionRolesChanges

Describes an app definition roles changes.

Properties
Property Type Description Rules
OriginalValues System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppRole> Gets or sets the original values. Required.
CurrentValues System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppRole> Gets or sets the current values. Required.

^ Back to top

AppDefinitionTranslation

Describes an app definition translation.

Properties

The model has no properties.

^ Back to top

AppInstance

Defines an application instance.

Properties
Property Type Description Rules
BaseKey string? The application instance base key. MinLen(3).
SharedKey string? The application instance shared key. MinLen(3).
TrackingId string? The application instance tracking identifier. Provides full tracking throughout the infrastructure stack.
Description string? The application instance description.
Name string? The application instance name.
AppDefinitionKey string The key of the application definition associated to the application instance. Required.
Group string? The application definition group that the application instance belongs to.
WorkspaceKey string? Gets or sets the workspace key.
OrganizationKey string The key of the organization associated with the app instance. Required.
Version string? The application version used by the application instance.
StartDate System.DateTime The application instance start date. Required.
EndDate System.DateTime The application instance end date. Required.
State Cegid.Lithium.Applications.Client.Rest.Models.AppInstanceState? The application instance current state.
StateReason string? The application instance state reason. Contains the metadata associated with the current state.
Resources System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppInstanceResource> The application instance resources. Required.
Features System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppInstanceFeature> The application instance features. Required.
AccessTags string? The application instance access tags.

^ Back to top

AppInstanceCompany

Describes an app instance company.

Properties
Property Type Description Rules
AssociationKey string Gets or sets the association key. Required.
AppInstance Cegid.Lithium.Applications.Client.Rest.Models.AppInstance Gets or sets the app instance. Required.
Company Cegid.Lithium.Applications.Client.Rest.Models.Company Gets or sets the company. Required.

^ Back to top

AppInstanceFeature

Defines an application instance feature.

Properties
Property Type Description Rules
Value string The application instance feature value. Required.
Class string The application instance feature class. Required.
Type Cegid.Lithium.Applications.Client.Rest.Models.AppFeatureType The application instance feature type. Required.

^ Back to top

AppInstanceItems

Represents a paginated result of application instances.

Properties
Property Type Description Rules
Items System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppInstance> The search result items. Required.

^ Back to top

AppInstanceResource

Defines an application instance resource.

Properties
Property Type Description Rules
Value string The application instance resource value (i.e. connection string, URL, etc.). Required.
IsProtected bool Defines whether the value should be available thought a key-vault. If so, the value of the resource points to the respective key-vault secret. Required.

^ Back to top

AppInstanceStateChangedPayload

Describes an app instance state changed payload.

Properties
Property Type Description Rules
Key string Gets or sets the key. Required.
PreviousState Cegid.Lithium.Applications.Client.Rest.Models.AppInstanceState Gets or sets the previous state. Required.
PreviousStateReason string? Gets or sets the previous state reason.
NewStateReason string? Gets or sets the new state reason.
ChangedAt System.DateTime Gets or sets the changed at. Required.
WorkspaceKey string Gets or sets the workspace key. Required.
OrganizationKey string Gets or sets the organization key. Required.
AppDefinitionKey string Gets or sets the app definition key. Required.
Group string Gets or sets the group. Required.

^ Back to top

AppRole

Describes an app role.

Properties
Property Type Description Rules
Key string Gets or sets the key. Required.MinLen(3).
IsDefault bool Indicates that the role is default. Required.
NameValues System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.AppRoleTranslation> Gets or sets the name values. Required.

^ Back to top

AppRoleTranslation

Describes an app role translation.

Properties

The model has no properties.

^ Back to top

AuditableEntity

Describes an auditable entity.

Properties
Property Type Description Rules
CreatedOn System.DateTime Gets or sets the created on. Required.
UpdatedOn System.DateTime? Gets or sets the updated on.
CreatedBy string? Gets or sets the created by.
UpdatedBy string? Gets or sets the updated by.

^ Back to top

BaseACLResource

Describes an ACL resource.

Properties
Property Type Description Rules
ResourceKey string Gets or sets the resource key. Required.
ResourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType? Gets or sets the resource type.

^ Back to top

BaseACLResourceAccess

Describes a base acl resource access.

Properties
Property Type Description Rules
AccessRight Cegid.Lithium.Applications.Client.Rest.Models.AccessRight? Gets or sets the access right.

^ Back to top

BaseACLSubject

Describes a base acl subject.

Properties
Property Type Description Rules
SubjectId string Gets or sets the subject id. Required.RegEx (^(?!\s).*(?<!\s)$).
SubjectType Cegid.Lithium.Applications.Client.Rest.Models.SubjectType? Gets or sets the subject type.

^ Back to top

BaseACLSubjectAccess

Describes a base acl subject access.

Properties
Property Type Description Rules
AccessRight Cegid.Lithium.Applications.Client.Rest.Models.AccessRight? Gets or sets the access right.

^ Back to top

BaseAppDefinitionChanges

Describes a base app definition changes.

Properties
Property Type Description Rules
AppDefinitionKey string Gets or sets the app definition key. Required.

^ Back to top

BaseEntity

Defines the base entity that has a key.

Properties
Property Type Description Rules
Key string The entity key. Required.MinLen(3).

^ Back to top

BaseResourceOperationEntity

Describes a base resource operation entity.

Properties
Property Type Description Rules
Id System.Guid Gets or sets the identifier. Required.Not empty.
OperationKind Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationKind Gets or sets the operation kind. Required.
ResourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType Gets or sets the resource type. Required.
ResourceKey string Gets or sets the resource key. Required.
State Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationState Gets or sets the state. Required.
TrackingId string? Gets or sets the tracking identifier.
ContextMetadata string? Gets or sets the context metadata.

^ Back to top

BaseResourceSubjectRoles

Describes a base resource subject roles.

Properties
Property Type Description Rules
SubjectId string Gets or sets the subject id. Required.RegEx (^(?!\s).*(?<!\s)$).
Roles System.Collections.Generic.IList<string> Gets or sets the roles. Required.Not empty.

^ Back to top

BaseSubjectRoles

Describes a base subject roles.

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

^ Back to top

BasicAppDefinition

Defines an application definition.

Properties
Property Type Description Rules
BaseKey string? The application definition base key. MinLen(3).
TrackingId string? The application definition tracking identifier.
Description string? The application definition description.
Group string? The application definition group (i.e. generic application).
DefaultVersion string The application definition default version. Used when a new application instance is created. Required.
Lifetime System.TimeSpan The application definition lifetime period. Used only when the application instance is not requested by billing. Required.
LifetimeExtension System.TimeSpan The application definition lifetime maximum extension period. Required.
RoleMode Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionRoleMode Gets or sets the role mode. Required.
EnableCompanies bool Gets or sets the enable companies value. If enabled, companies can be associated to related application instances. Required.
Context Cegid.Lithium.Applications.Client.Rest.Models.AppDefinitionContext? Gets or sets the application definition context.
PropagateCompanies bool Gets or sets whether the companies will be propagated to the dependencies. Required.
PropagateAccesses bool Gets or sets whether the accesses will be propagated to the dependencies. Required.
ApiRequiredScopes string? Gets or sets the required scopes to be used instance owners and connected services. RegEx (^[a-zA-Z0-9_-]{2,50}(?: [a-zA-Z0-9_-]{2,50})*$).
BaseUrl string? Gets or sets the base URL.
ApiBaseUrl string? Gets or sets the API base URL.
Name string? Gets or sets the name.

^ Back to top

ChangeDefinitionBody

Defines the move definition operation parameters.

Properties
Property Type Description Rules
AppDefinitionKey string The destination application definition key. Required.

^ Back to top

ChangeOrganizationBody

Defines the move instance operation parameters.

Properties
Property Type Description Rules
OrganizationKey string The application instance organizatiion key. Required.

^ Back to top

Company

Describes a company.

Properties
Property Type Description Rules
Key string Gets or sets the company unique key. Required.
Name string Gets or sets the company name. Required.
VatNumber string Gets or sets the company vat number. Required.RegEx (^(?i)[A-Z]{1}[A-Z0-9]{9,15}$).
Properties System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.CompanyProperty> Gets or sets the company properties. Required.

^ Back to top

CompanyProperty

Describes a company property.

Properties
Property Type Description Rules
Name string Gets or sets the name. Required.
Value string? Gets or sets the value.

^ Back to top

ConvertAppInstanceBody

Defines the move definition operation parameters.

Properties
Property Type Description Rules
AppDefinitionKey string The destination application definition key. Required.

^ Back to top

CreatedAppInstance

Describes information about creation of an AppInstance.

Properties
Property Type Description Rules
State Cegid.Lithium.Applications.Client.Rest.Models.AppInstanceState Gets or sets the state. Required.
AppDefinitionKey string Gets or sets the app definition key. Required.
Dependencies System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.CreatedAppInstance>? Gets or sets the dependencies.
OrganizationKey string Gets or sets the organization key. Required.
Group string? Gets or sets the group.
BaseUrl string? Gets or sets the base URL.
ApiBaseUrl string? Gets or sets the API base URL.
Name string Gets or sets the name. Required.
Description string? Gets or sets the description.

^ Back to top

CreatedEntity

Describes a created entity.

Properties

The model has no properties.

^ Back to top

DataExport

Describes a data export: the asynchronous job that streams the requested datasets from one database snapshot into part files, and, once completed, its manifest.

Properties
Property Type Description Rules
Id System.Guid Gets or sets the export identifier (the job identifier). Required.Not empty.
Status Cegid.Lithium.Applications.Client.Rest.Models.JobStatus Gets or sets the export status. Required.
RequestedOn System.DateTime Gets or sets when the export was requested (UTC). Required.
SnapshotUtc System.DateTime? Gets or sets the snapshot instant of the export (UTC). Only available on the read endpoint once the export completed.
CompletedOn System.DateTime? Gets or sets when the export completed or failed (UTC).
Error string? Gets or sets the failure description when the export failed, including the dataset and part being written.
Manifest Cegid.Lithium.Applications.Client.Rest.Models.DataExportManifest? Gets or sets the manifest. Present only on the read endpoint and only when the export completed.

^ Back to top

DataExportBundleDefinition

Describes a configured bundle: a named, versioned set of datasets (with their parameters) that are always exported together from one snapshot.

Properties
Property Type Description Rules
Name string Gets or sets the bundle name (for example, access-model). Required.
Version int Gets or sets the bundle version. It is bumped when the bundle composition or parameters change. Required.
Datasets System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.DataExportDatasetRequest> Gets or sets the datasets of the bundle, in export order, each with its parameters. Required.

^ Back to top

DataExportBundleReference

Identifies the bundle an export was requested with.

Properties
Property Type Description Rules
Name string Gets or sets the bundle name. Required.
Version int Gets or sets the bundle version. Required.

^ Back to top

DataExportCatalog

Describes the data export catalog: the registered datasets and the configured bundles.

Properties
Property Type Description Rules
Datasets System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.DataExportDatasetDefinition> Gets or sets the registered dataset definitions. Required.
Bundles System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.DataExportBundleDefinition> Gets or sets the configured bundles. Required.

^ Back to top

DataExportDataset

Describes an exported dataset in the manifest: the version and effective parameters it was exported with, its parts and statistics. The effective parameters (a JSON object) are exposed by a hand-written partial, since the model designer cannot express a dictionary of typed JSON values.

Properties
Property Type Description Rules
Name string Gets or sets the catalog name of the dataset. Required.
Version int Gets or sets the dataset version the rows were exported with. Required.
RowCount long Gets or sets the total number of exported rows (the sum of the parts). Required.
Parts System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.DataExportPart> Gets or sets the part files, in index order. Required.
Statistics Cegid.Lithium.Applications.Client.Rest.Models.DataExportDatasetStatistics? Gets or sets the statistics produced while streaming, when the dataset declares any.

^ Back to top

DataExportDatasetDefinition

Describes a dataset registered in the data export catalog: its name, version, parameters and the statistics it produces.

Properties
Property Type Description Rules
Name string Gets or sets the catalog name of the dataset. Required.
Version int Gets or sets the dataset version. It is bumped on any change to the row shape or semantics, so consumers can pin the version they understand. Required.
Description string Gets or sets the description of the rows the dataset exports. Required.
Parameters System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.DataExportParameterDefinition> Gets or sets the parameters accepted by the dataset. Required.
RequiresSnapshot bool Gets or sets a value indicating whether the dataset must be read inside the export snapshot transaction. Required.
Statistics System.Collections.Generic.IList<string> Gets or sets the names of the statistics the dataset produces while streaming (for example, rowsByWorkspace). Required.

^ Back to top

DataExportDatasetRequest

Identifies a catalog dataset to export. The dataset parameters (a JSON object whose members are defined by the dataset) are exposed by a hand-written partial, since the model designer cannot express a dictionary of typed JSON values.

Properties
Property Type Description Rules
Name string Gets or sets the catalog name of the dataset (for example, effectiveAcl). Required.

^ Back to top

DataExportDatasetStatistics

Describes the statistics a dataset produced while it was exported.

Properties
Property Type Description Rules
RowsByWorkspace System.Collections.Generic.IDictionary<string, long>? Gets or sets the number of exported rows per workspace key, for the datasets that declare this statistic. Not empty.

^ Back to top

DataExportManifest

Describes a completed data export: when and from which snapshot it was taken, and the files of every exported dataset. It is the last blob written by an export, so its existence means the export is complete.

Properties
Property Type Description Rules
SchemaVersion int Gets or sets the manifest schema version. Required.
ExportId System.Guid Gets or sets the export identifier (the job identifier), the correlation key shared with consumers. Required.Not empty.
RequestedBy string? Gets or sets the subject that requested the export.
RequestedOn System.DateTime Gets or sets when the export was requested (UTC). Required.
SnapshotUtc System.DateTime Gets or sets the database time at the start of the export transaction (UTC). Every dataset was read as of this instant; it is the watermark consumers compare later changes against. Required.
SourceVersion string? Gets or sets the source version of the snapshot. Reserved for a future change-tracking version; always null for now.
Isolation string Gets or sets the transaction isolation the export actually achieved: Snapshot, or ReadCommitted when snapshot isolation was unavailable. Required.
CompletedOn System.DateTime? Gets or sets when the export completed (UTC).
Bundle Cegid.Lithium.Applications.Client.Rest.Models.DataExportBundleReference? Gets or sets the bundle the export was requested with. Null when the request listed the datasets explicitly.
Datasets System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.DataExportDataset> Gets or sets the exported datasets, in export order. Required.

^ Back to top

DataExportParameterDefinition

Describes a parameter accepted by a catalog dataset.

Properties
Property Type Description Rules
Name string Gets or sets the parameter name, as it appears in a dataset request. Required.
Type string Gets or sets the parameter type (for example, bool, int[], string[]). Required.
Required bool Gets or sets a value indicating whether the parameter must be supplied. Required.
Default string? Gets or sets the default value applied when the parameter is omitted, as a JSON literal (for example, true or [4]). Null when the parameter has no default.
AllowedValues System.Collections.Generic.IList<string>? Gets or sets the allowed values, as JSON literals, when the parameter is restricted to a fixed set. Null when any value of the type is accepted.

^ Back to top

DataExportPart

Describes one part file of an exported dataset.

Properties
Property Type Description Rules
Index int Gets or sets the one-based index of the part within its dataset. Required.
BlobName string Gets or sets the blob name of the part, informational (internal storage layout). Parts are fetched through the parts endpoint, never by blob name. Required.
RowCount long Gets or sets the number of rows in the part. Required.
Bytes long Gets or sets the size of the part in bytes (gzip). Required.
Sha256 string Gets or sets the SHA-256 hash of the part bytes, hex encoded. Required.

^ Back to top

DataExportRequest

Describes a data export request: the datasets to export, named either through a configured bundle or as an explicit list, and the optional part size. Exactly one of Bundle or Datasets must be supplied.

Properties
Property Type Description Rules
Bundle string? Gets or sets the name of the configured bundle to export. Mutually exclusive with Datasets.
Datasets System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.DataExportDatasetRequest>? Gets or sets the explicit list of datasets to export, each with its parameters. Mutually exclusive with Bundle.
PartSize int? Gets or sets the number of rows per part file. Defaults to the configured default part size and is capped by the configured maximum.

^ Back to top

DataExportStateChanged

Describes a data export state change, the payload of the DataExport_Changed webhook. It carries no download addresses: the consumer reads the export through the API.

Properties
Property Type Description Rules
Id System.Guid Gets or sets the export identifier. Required.Not empty.
Status Cegid.Lithium.Applications.Client.Rest.Models.JobStatus Gets or sets the new export status. Required.
SnapshotUtc System.DateTime? Gets or sets the snapshot instant of the export (UTC), when already known.
CompletedOn System.DateTime? Gets or sets when the export completed or failed (UTC), when already known.
Error string? Gets or sets the failure description when the export failed.

^ Back to top

EffectiveAclDriftRepairAppInstanceCount

Describes the drift of one application instance found or repaired by an effective acl drift repair job.

Properties
Property Type Description Rules
AppInstanceKey string Gets or sets the application instance key. Required.
WorkspaceKey string Gets or sets the key of the workspace of the application instance. Required.
MissingEntries int Gets or sets the number of missing entries. Required.
DivergentEntries int Gets or sets the number of divergent entries. Required.
StaleEntries int Gets or sets the number of stale entries. Required.

^ Back to top

EffectiveAclDriftRepairSummary

Describes the outcome of an effective acl drift repair job, stored as the job result: the drift counted by a preview or repaired by an apply (the entry counters of an apply are the entries it repaired), in total, per workspace and per application instance, and, on an apply, the remaining drift. A cancelled job stores the outcome of the batches it completed.

Properties
Property Type Description Rules
Mode Cegid.Lithium.Applications.Client.Rest.Models.EffectiveAclDriftRepairMode Gets or sets the job mode. Required.
PreviewJobId System.Guid? Gets or sets the identifier of the preview an apply repaired. Null on a preview. Not empty.
Scope Cegid.Lithium.Applications.Client.Rest.Models.EffectiveAclDriftRepairScope Gets or sets the scope. Required.
ScopeKey string? Gets or sets the workspace or application instance key of the scope. Null for the Global scope.
AppInstancesScanned int Gets or sets the number of application instances scanned: the application instances of the scope on a preview, the selected application instances of the preview that still exist on an apply. Required.
AppInstancesWithDrift int Gets or sets the number of application instances with at least one drifted entry. Required.
MissingEntries int Gets or sets the number of missing application instance company entries: a subject allowed on the application instance has no entry on one of its companies. Required.
DivergentEntries int Gets or sets the number of inherited application instance company entries whose access right differs from the one the subject holds on the application instance. Required.
StaleEntries int Gets or sets the number of inherited application instance company entries of subjects that are no longer allowed on the application instance. Required.
AppInstancesWithRemainingDrift int? Gets or sets, on an apply, the number of application instances with remaining drift. An apply of the whole preview counts the application instances it repaired again right after each batch (normally none: a concurrent access write or rebuild can leave some). An apply of a selection (workspace by workspace, for example) reports the application instances of the preview that no completed apply of it has covered yet. Null on a preview.
RemainingEntries int? Gets or sets, on an apply, the number of remaining drifted entries (missing, divergent and stale). An apply of the whole preview reports the drift still found when the repaired application instances are counted again (zero proves the apply converged). An apply of a selection reports the preview entries of the application instances no completed apply of the preview has covered yet (what is left to apply). Null on a preview.
ExpiresOn System.DateTime? Gets or sets when the preview can no longer be applied (UTC). Null on an apply.
AppInstances System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.EffectiveAclDriftRepairAppInstanceCount> Gets or sets the drift of every application instance with at least one drifted entry, with its workspace, the ones with the most drift first. An apply can select some of them by key. Required.
Workspaces System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.EffectiveAclDriftRepairWorkspaceCount> Gets or sets the drift of every workspace with at least one drifted application instance, the ones with the most drift first. An apply can select some of them by key. Required.

^ Back to top

EffectiveAclDriftRepairWorkspaceCount

Describes the drift of the application instances of one workspace found or repaired by an effective acl drift repair job.

Properties
Property Type Description Rules
WorkspaceKey string Gets or sets the workspace key. Required.
AppInstances int Gets or sets the number of application instances of the workspace with at least one drifted entry. Required.
MissingEntries int Gets or sets the number of missing entries. Required.
DivergentEntries int Gets or sets the number of divergent entries. Required.
StaleEntries int Gets or sets the number of stale entries. Required.

^ Back to top

EffectiveAclRebuildSummary

Describes the outcome of an effective acl rebuild job, stored as the job result.

Properties
Property Type Description Rules
Mode Cegid.Lithium.Applications.Client.Rest.Models.EffectiveAclRebuildMode Gets or sets the rebuild mode. Required.
Subjects int Gets or sets the number of subjects resolved for the scope. Required.
Rebuilt int Gets or sets the number of subjects whose effective access entries were recomputed successfully. Required.
Failed int Gets or sets the number of subjects whose recomputation failed; each one was handed to an effective acl recovery job. Required.
Skipped int Gets or sets the number of subjects that were being rebuilt by another process during every attempt of the job and were left to that process. Required.

^ Back to top

EntityDeletedPayload

The payload to send on a entity deleted event.

Properties
Property Type Description Rules
Key string The deleted entity key. Required.

^ Back to top

ExpandableAppInstance

Describes an expandable app instance.

Properties
Property Type Description Rules
Organization Cegid.Lithium.Applications.Client.Rest.Models.Organization Gets or sets the organization. Required.
Workspace Cegid.Lithium.Applications.Client.Rest.Models.Workspace Gets or sets the workspace. Required.
AppDefinition Cegid.Lithium.Applications.Client.Rest.Models.BasicAppDefinition Gets or sets the app definition. Required.
Companies System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.Company>? Gets or sets the companies.

^ Back to top

ExpandableOrganization

Describes an expandable organization.

Properties
Property Type Description Rules
AppInstances System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableAppInstance> Gets or sets the app instances. Required.
Workspace Cegid.Lithium.Applications.Client.Rest.Models.Workspace Gets or sets the workspace. Required.

^ Back to top

ExpandableWorkspace

Describes an expandable workspace.

Properties
Property Type Description Rules
Organizations System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.ExpandableOrganization> Gets or sets the organizations. Required.

^ Back to top

FullAccessEntry

Describes a full access entry.

Properties
Property Type Description Rules
CreatedOn System.DateTime Gets or sets the created on. Required.
CreatedBy string Gets or sets the created by. Required.

^ Back to top

LocalizablePropertyValue

Describes a localizable property value.

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

^ Back to top

Organization

Defines an organization.

Properties
Property Type Description Rules
BaseKey string? The organization base key. MinLen(3).
TrackingId string? The organization tracking identifier.
Name string The organization name. Required.
WorkspaceKey string The key of the workspace associated to the organization. Required.
State Cegid.Lithium.Applications.Client.Rest.Models.OrganizationState? The organization current state.
StateReason string? The organization state reason. Contains the metadata associated with the current state.

^ Back to top

PaginatedItems

Defines the base attributes for an entity with searchable paginated results.

Properties
Property Type Description Rules
CurrentPage int The current page number. Required.
PageCount int The page count. Required.
PageSize int The page size. Required.
RowCount int The row count. Required.

^ Back to top

PropertyChange

Describes a property change.

Properties
Property Type Description Rules
PropertyName string Gets or sets the property name. Required.
OldValue string? Gets or sets the old value.
NewValue string Gets or sets the new value. Required.

^ Back to top

ProvisioningOperationDependencyEntity

Describes a dependency edge between two provisioning operations of the same batch: the dependent operation can only be dispatched after the operation it depends on finishes. Edges are persisted at plan time (deduplicated - a diamond in the definition tree produces a single operation per instance), so the dispatch order is immune to application definition changes made while a batch is in flight.

Properties
Property Type Description Rules
OperationId System.Guid Gets or sets the identifier of the dependent operation. Required.Not empty.
DependsOnOperationId System.Guid Gets or sets the identifier of the operation that must finish first. Required.Not empty.

^ Back to top

ProvisioningOperationEntity

Describes a provisioning operation against an application instance - the orchestration backbone for the dependency-ordered provisioning flow. One row per application instance per batch; a filtered unique index guarantees at most one live (non-terminal) operation per application instance. The identifier doubles as the correlation stamp: it is sent to the Provisioning service as a custom operation parameter and echoed back in the webhook parameters.

Properties
Property Type Description Rules
Id System.Guid Gets or sets the identifier. Also the correlation stamp sent to the Provisioning service. Required.Not empty.
BatchId System.Guid Gets or sets the batch identifier, shared by every operation planned in the same trigger/create request (the whole dependency tree). Required.Not empty.
AppInstanceKey string Gets or sets the key of the target application instance. Required.
AppDefinitionKey string Gets or sets the key of the application definition of the target application instance. Required.
Kind Cegid.Lithium.Applications.Client.Rest.Models.ProvisioningOperationKind Gets or sets the operation kind. Required.
Status Cegid.Lithium.Applications.Client.Rest.Models.ProvisioningOperationStatus Gets or sets the operation status. Required.
PriorState Cegid.Lithium.Applications.Client.Rest.Models.AppInstanceState? Gets or sets the application instance state captured at plan time. Reprovisioning operations keep the instance in this state while planned/queued, and revert to it on cancellation or on a failure that happens before the operation started executing.
SendAttempts int Gets or sets the number of dispatch attempts (sends to the Provisioning service). Required.
SentOn System.DateTime? Gets or sets the moment the operation was last sent to the Provisioning service.
StartedOn System.DateTime? Gets or sets the moment the Provisioning service reported the operation started executing.
CompletedOn System.DateTime? Gets or sets the moment the operation reached a terminal status.
StatusDetail string? Gets or sets the free-text detail for the current status (provisioning error, cascade reason, reconciliation verdict).
ProviderOperationId string? Gets or sets the identifier of the operation created on the Provisioning service, captured when the operation was sent. It lets the reconciliation ask the service for the real outcome of an operation whose webhook never arrived.
RowVersion byte[] Gets or sets the row version (optimistic concurrency; guards the dispatch claim and the webhook status transitions). Required.

^ Back to top

ProvisioningResult

Describes a provisioning result.

Properties

The model has no properties.

^ Back to top

ResourceOperationApplyResult

Describes a resource operation apply result.

Properties
Property Type Description Rules
Change Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationApplyChange Gets or sets the change. Required.

^ Back to top

ResourceOperationEntity

Describes a resource operation entity.

Properties
Property Type Description Rules
RowVersion byte[] Gets or sets the row version. Required.

^ Back to top

ResourceOperationPreviewItem

Describes one item of the computed projection that a registered resource operation would affect. The meaning of an item depends on the operation kind - for the CBMS migration handover, each item is a company eligible to be claimed by CBMS.

Properties
Property Type Description Rules
OperationKind Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationKind Gets or sets the operation kind whose registered resource operations produced this item. Filter by this field to preview a specific kind. Required.
TrackingId string? Gets or sets the tracking identifier of the resource operations that produced this item (for example, one product's handover). Filter by this field to narrow the preview.
Key string Gets or sets the key of the affected item (for example, the company key for the CBMS migration handover). Required.
WorkspaceKey string? Gets or sets the workspace key that scopes the affected item, when the item is workspace-scoped.
Type string Gets or sets the label describing what the affected item is (for example, Company). This is a free-form label defined by the operation kind, not a resource type. Required.
Metadata string? Gets or sets optional metadata about the affected item, specific to the operation kind.

^ Back to top

ResourceOperationRequest

Describes a resource operation request.

Properties
Property Type Description Rules
OperationKind Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationKind Gets or sets the operation kind. Required.
ResourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType Gets or sets the resource type. Required.
ResourceKey string Gets or sets the resource key. Required.
TrackingId string? Gets or sets the tracking identifier.
ContextMetadata string? Gets or sets the context metadata.

^ Back to top

ResourceOperationsApplyRequest

Describes a resource operations apply request.

Properties
Property Type Description Rules
Entries System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.ResourceOperationRequest> Gets or sets the entries. Required.
ApplyOperation Cegid.Lithium.Applications.Client.Rest.Models.ApplyOperation Gets or sets the apply operation. Required.

^ Back to top

ResourceSubjectRolesRequest

Describes a resource subject roles request.

Properties

The model has no properties.

^ Back to top

ResourceSubjectRolesResponse

Describes a resource subject roles response.

Properties
Property Type Description Rules
SubjectType Cegid.Lithium.Applications.Client.Rest.Models.SubjectType Gets or sets the subject type. Required.

^ Back to top

RoleApplyResult

Describes a role apply result.

Properties
Property Type Description Rules
SubjectId string Gets or sets the subject identifier. Required.
Role string Gets or sets the role. Required.
Change Cegid.Lithium.Applications.Client.Rest.Models.RoleChange Gets or sets the change. Required.

^ Back to top

RoleEntryResponse

Describes a role entry response. Intentionally standalone (does not inherit BaseACLSubject) so it does not share a base entity type with AccessEntryResponse in the accesses OData model; see RestApi/ODataModelsBuilder.AddRoleEntryResponse.

Properties
Property Type Description Rules
SubjectId string Gets or sets the subject id. Required.RegEx (^(?!\s).*(?<!\s)$).
SubjectType Cegid.Lithium.Applications.Client.Rest.Models.SubjectType? Gets or sets the subject type.
ResourceKey string Gets or sets the resource key. Required.
ResourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType Gets or sets the resource type. Required.
Role string Gets or sets the role. Required.

^ Back to top

RolesApplyRequest

Describes a roles apply request.

Properties
Property Type Description Rules
Entries System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.SubjectResourceRolesRequest> Gets or sets the entries. Required.
Operation Cegid.Lithium.Applications.Client.Rest.Models.RoleOperation Gets or sets the operation. Required.

^ Back to top

RolesAssignment

Describes a Roles Assingment.

Properties
Property Type Description Rules
ResourceKey string Gets or sets the resource key. Required.
ResourceType Cegid.Lithium.Applications.Client.Rest.Models.ResourceType Gets or sets the resource type. Required.

^ Back to top

RolesAssignments

Describes a roles assignments.

Properties
Property Type Description Rules
Assignments System.Collections.Generic.IList<Cegid.Lithium.Applications.Client.Rest.Models.RolesAssignment> Gets or sets the assignments. Required.

^ Back to top

SubjectResourceRolesRequest

Describes a subject resource roles request.

Properties
Property Type Description Rules
SubjectId string Gets or sets the subject identifier. Required.
Roles System.Collections.Generic.IList<string>? Gets or sets the roles.

^ Back to top

SubjectRolesRequest

Describes a subject roles request.

Properties

The model has no properties.

^ Back to top

SubjectRolesResponse

Describes a subject roles response.

Properties

The model has no properties.

^ Back to top

TransferAppInstanceBody

Defines the move instance operation parameters.

Properties
Property Type Description Rules
OrganizationKey string The application instance organization key. Required.

^ Back to top

Workspace

Defines a workspace.

Properties
Property Type Description Rules
BaseKey string? The workspace base key. MinLen(3).
TrackingId string? The workspace tracking identifier.
Description string? The workspaces description.
Name string The workspace name. Required.
State Cegid.Lithium.Applications.Client.Rest.Models.WorkspaceState? The workspace current state.
StateReason string? The workspace state reason. Contains the metadata associated with the current state.

^ Back to top

WorkspaceCompany

Describes a workspace company.

Properties
Property Type Description Rules
WorkspaceKey string Gets or sets the workspace key. Required.
Company Cegid.Lithium.Applications.Client.Rest.Models.Company Gets or sets the company. Required.

^ Back to top

Enumerations

AccessChange

Defines an access change.

Members
Member Value Description
Granted 0 The granted.
Updated 1 The updated.
Revoked 2 The revoked.

^ Back to top

AccessKind

Defines how the access to a resource is obtained relatively to other resources.

Members
Member Value Description
Explicit 0 The access is explicit in the AccessList.
BottomInherited 1 The access is inherited from the bottom, that is, from a child resource.
TopInherited 2 The access is inherited from the top, that is, from a parent resource.

^ Back to top

AccessModelCopyMode

Defines the mode of an access model copy request.

Members
Member Value Description
Preview 0 Computes the copy plan without writing anything and stores its summary, fingerprint and detailed report.
Apply 1 Executes the plan of a previous preview: the plan is recomputed with the preview parameters and the job fails when it differs from the preview.

^ Back to top

AccessRight

Defines the allowed access right.

Members
Member Value Description
ReadOnly 0 Read only access.
ReadWrite 1 Read and write access.
Denied 2 Access denied.

^ Back to top

AppDefinitionContext

Defines the application definition context.

Members
Member Value Description
None 0 No context. Indicates that the application definition has no context.
Workspace 1 Workspace context. Indicates that some parameters of the application definition are used at workspace level.
Organization 2 Organization context. Indicates that some parameters of the application definition are used at organization level.

^ Back to top

AppDefinitionRoleMode

Defines the role modes of an application definition.

Members
Member Value Description
None 0 Application definition none mode. Application definition does not support roles.
SingleRoleAtAppInstanceLevel 1 Application definition single role mode at application instance level. One role per user and application instance.
MultipleRolesAtAppInstanceLevel 2 Application definition multiple role mode at application instance level. Multiple roles per user and application instance.
SingleRoleAtCompanyLevel 3 Application definition single role mode at application instance company level. One role per user and application instance company.
MultipleRolesAtCompanyLevel 4 Application definition multiple role mode at application instance company level. Multiple roles per user and application instance company.

^ Back to top

AppFeatureType

Defines the type of an application feature.

Members
Member Value Description
Standard 0 Application definition feature is standard.
Additional 1 Application definition feature is additional.

^ Back to top

AppInstanceState

Defines the states of an application instance.

Members
Member Value Description
Active 0 Application instance is active.
Suspended 1 Application instance is suspended.
Closed 2 Application instance is closed.
Preparing 3 Application instance is preparing (being provisioned, updated, etc.).
Failed 4 Application instance preparation failed.
Pending 5 Application instance is pending on other dependencies provisioning.
Deleting 6 The deleting.

^ Back to top

ApplyOperation

Defines an apply operation.

Members
Member Value Description
AddOrUpdate 0 The add or update.
Delete 1 The delete.

^ Back to top

EffectiveAclDriftRepairMode

Defines the mode of an effective acl drift repair request.

Members
Member Value Description
Preview 0 Counts the drift in the requested scope without writing anything and stores the counts as the job result.
Apply 1 Repairs the drift found, at execution time, in the scope of a previous preview.

^ Back to top

EffectiveAclDriftRepairScope

Defines the scope of an effective acl drift repair.

Members
Member Value Description
Global 0 Every application instance, processed workspace by workspace in bounded batches.
Workspace 1 The application instances of one workspace.
AppInstance 2 A single application instance.

^ Back to top

EffectiveAclRebuildMode

Defines how far an effective acl rebuild recomputes each subject.

Members
Member Value Description
Scoped 0 Recomputes only the requested workspace or application instance subtree (and its ancestors) of each subject. Ignored when the subjects are given explicitly: they are always rebuilt in full.
Full 1 Recomputes every effective access entry of each subject, across all workspaces.

^ Back to top

JobStatus

Defines a job status.

Members
Member Value Description
Pending 0 The pending.
Running 1 The running.
Failed 2 The failed.
Completed 3 The completed.
Cancelled 4 The cancelled: the job was cancelled by request before it completed. Terminal, never retried.

^ Back to top

OrganizationState

Defines the states of an organization.

Members
Member Value Description
Active 0 Organization is active.
Suspended 1 Organization is suspended.
Closed 2 Organization is closed.

^ Back to top

ProvisioningOperationKind

Defines the kind of a provisioning operation. Decided per application instance at plan time: an instance that was previously provisioned (Active, Failed or Suspended) is reprovisioned, any other instance goes through initial provisioning, and a provisioning run fired by an update of the instance configuration is a configuration update.

Members
Member Value Description
InitialProvisioning 0 The first provisioning of an application instance. The instance is not usable until the operation finishes, so it stays in Pending/Preparing while waiting.
Reprovisioning 1 The reprovisioning of an already-provisioned application instance. The instance keeps its prior state while the operation is planned or queued, and only transitions to Preparing when the Provisioning service reports the operation started executing.
ConfigurationUpdate 2 A provisioning run fired by an update of the application instance configuration. An Active instance stays Active while the operation is queued and only transitions to Preparing when the Provisioning service reports the operation started executing; an instance that was not usable before the update (Failed, Suspended, Closed or a Preparing left behind) transitions to Preparing immediately. When the operation ends before it started executing, the instance returns to its prior state when that state was Active, Failed or Suspended, and is failed otherwise.

^ Back to top

ProvisioningOperationStatus

Defines the status of a provisioning operation. Transitions are monotonic: Planned, Sent, Started, then a terminal status (Finished, Failed or Canceled); Started may be skipped by fast operations. The numeric values are part of the persisted contract - the filtered unique index on live operations depends on them.

Members
Member Value Description
Planned 0 The operation is planned and waiting for its dependency operations to finish.
Sent 1 The operation was sent to the Provisioning service and is queued or about to execute there.
Started 2 The Provisioning service reported that the operation started executing.
Finished 3 The operation finished successfully (terminal).
Failed 4 The operation failed (terminal).
Canceled 5 The operation was canceled (terminal).

^ Back to top

ResourceOperationApplyChange

Defines the kind of change applied to a resource operation entry by an apply request.

Members
Member Value Description
Created 0 The entry was registered.
Updated 1 The existing entry was updated.
Deleted 2 The entry was cancelled or removed.

^ Back to top

ResourceOperationKind

Defines the kind of operation registered against a resource. The kind determines the validation, the preview projection, and the execution behavior.

Members
Member Value Description
CbmsMigrationHandover 0 The handover of application definitions to CBMS - CBMS becomes the owner of the related role definitions and the registered entries mark what APPS may later clean up.

^ Back to top

ResourceOperationState

Defines the state of a registered resource operation in its queue lifecycle.

Members
Member Value Description
Pending 0 The operation is registered and waiting for execution.
Processing 1 The operation was claimed and is being executed.
Completed 2 The operation was executed successfully.
Cancelled 3 The operation was cancelled before being executed.
Failed 4 The operation execution failed with a non-transient error.

^ Back to top

ResourceType

Defines the type of the resource to provide access to.

Members
Member Value Description
ApplicationDefinition 0 The application definition resource type.
Workspace 1 The workspace resource type.
Organization 2 The organization resource type.
ApplicationInstance 3 The application instance resource type.
ApplicationInstanceCompany 4 The application instance company association resource type.

^ Back to top

RoleChange

Defines a role change.

Members
Member Value Description
Created 0 The created.
Deleted 1 The deleted.

^ Back to top

RoleOperation

Defines a role operation.

Members
Member Value Description
Set 0 The set member.
Delete 1 The delete.

^ Back to top

SubjectType

Defines the allowed subject types.

Members
Member Value Description
Client 0 The client subject type.
User 1 The user subject type.

^ Back to top

WorkspaceState

Defines the states of a workspace.

Members
Member Value Description
Active 0 Workspace is active.
Suspended 1 Workspace is suspended.
Closed 2 Workspace is closed.

^ Back to top

Webhooks

Events

Event Description Payload Payload Description Remarks
Aclentries_Created Triggered after an ACL entries is created. ACLEntries The created ACL Entries.
Aclentries_Deleted Triggered after an ACL entries is deleted. ACLEntries The deleted ACL Entries.
Aclentries_Updated Triggered after an ACL entries is updated. ACLEntries The updated ACL Entries.
Appdefinition_Created Triggered after an application definition is created. AppDefinition The created application definition.
Appdefinition_Deleted Triggered after an application definition is deleted. EntityDeletedPayload The deleted application definition.
Appdefinition_Updated Triggered after an application definition is updated. AppDefinitionChanges The original and the current application definition values.
AppDefinitionApiRequiredScopes_Updated Triggered when the required scopes of an AppDefinition are modified. AppDefinitionApiRequiredScopesChanges The original and current required scopes values.
AppDefinitionDependencies_Updated Triggered when the dependencies of an AppDefinition are modified. AppDefinitionDependenciesChanges The original and current dependencies values.
AppDefinitionFeatures_Updated Triggered when the features of an AppDefinition are modified. AppDefinitionFeaturesChanges The original and current features values.
AppDefinitionResources_Updated Triggered when the resources of an AppDefinition are modified. AppDefinitionResourcesChanges The original and current resources values.
AppDefinitionRoles_Updated Triggered when the roles of an AppDefinition are modified. AppDefinitionRolesChanges The original and current roles values.
AppInstance_Activated Triggered after an application instance was activated. AppInstanceStateChangedPayload An entity that identifies the application instance by its key and aditional information about the state change.
AppInstance_Closed Triggered after an application instance was closed. AppInstanceStateChangedPayload An entity that identifies the application instance by its key and aditional information about the state change.
Appinstance_Created Triggered after an application instance is created. AppInstance The created application instance.
Appinstance_Deleted Triggered after an application instance is deleted. EntityDeletedPayload The deleted application instance.
AppInstance_Failed Triggered after an application instance provisioning has failed. AppInstanceStateChangedPayload An entity that identifies the application instance by its key and aditional information about the state change.
AppInstance_Suspended Triggered after an application instance was suspended. AppInstanceStateChangedPayload An entity that identifies the application instance by its key and aditional information about the state change.
Appinstance_Updated Triggered after an application instance is created. AppInstance The updated application instance.
AppInstanceCompany_Created Triggered after an application instance company association is created. AppInstanceCompany The created association data.
AppInstanceCompany_Deleted Triggered after an application instance company association is deleted. AppInstanceCompany The deleted association data.
AppInstanceCompany_Updated Triggered after an application instance company association is updated. AppInstanceCompany The updated association data.
DataExport_Changed Triggered when a data export changes state: when it starts running, completes or fails. DataExportStateChanged The export identifier, its new status and, when known, the snapshot instant, completion time and error.
Organization_Created Triggered after an organization is created. Organization The created organization.
Organization_Deleted Triggered after an organization is deleted. EntityDeletedPayload The deleted organization.
Organization_Updated Triggered after an organization is updated. Organization The updated organization.
Rolesassignments_Created Triggered after a roles are created. RolesAssignments The created roles.
Rolesassignments_Deleted Triggered after a roles are deleted. RolesAssignments The deleted roles.
Workspace_Created Triggered after a workspace is created. Workspace The created workspace.
Workspace_Deleted Triggered after a workspace is deleted. EntityDeletedPayload The deleted workspace.
Workspace_Updated Triggered after a workspace is updated. Workspace The updated workspace.
WorkspaceCompany_Created Triggered after a company is created in the workspace. WorkspaceCompany The created company.
WorkspaceCompany_Deleted Triggered after a company is deleted from the workspace. WorkspaceCompany The deleted company.
WorkspaceCompany_Updated Triggered after a company is updated in the workspace. WorkspaceCompany The updated company.

Payloads

ACLEntries

Describes an acl entries.

Property Description
Entries Gets or sets the ACL entries.

^ Back to top

AppDefinition

Defines an application definition.

Property Description
Resources The collection of application definition resources.
Features The application definition features.
Roles Gets or sets the roles.
Dependencies Gets or sets the dependencies.
DescriptionTranslations Gets or sets the description translations.

^ Back to top

AppDefinitionApiRequiredScopesChanges

Describes an app definition API required scopes changes.

Property Description
OriginalValues Gets or sets the original values.
CurrentValues Gets or sets the current values.

^ Back to top

AppDefinitionChanges

Describes an app definition changes.

Property Description
OriginalValues Gets or sets the original values.
CurrentValues Gets or sets the current values.

^ Back to top

AppDefinitionDependenciesChanges

Describes an app definition dependencies changes.

Property Description
OriginalValues Gets or sets the original values.
CurrentValues Gets or sets the current values.

^ Back to top

AppDefinitionFeaturesChanges

Describes an app definition features changes.

Property Description
OriginalValues Gets or sets the original values.
CurrentValues Gets or sets the current values.

^ Back to top

AppDefinitionResourcesChanges

Describes an app definition resources changes.

Property Description
OriginalValues Gets or sets the original values.
CurrentValues Gets or sets the current values.

^ Back to top

AppDefinitionRolesChanges

Describes an app definition roles changes.

Property Description
OriginalValues Gets or sets the original values.
CurrentValues Gets or sets the current values.

^ Back to top

AppInstance

Defines an application instance.

Property Description
BaseKey The application instance base key.
SharedKey The application instance shared key.
TrackingId The application instance tracking identifier. Provides full tracking throughout the infrastructure stack.
Description The application instance description.
Name The application instance name.
AppDefinitionKey The key of the application definition associated to the application instance.
Group The application definition group that the application instance belongs to.
WorkspaceKey Gets or sets the workspace key.
OrganizationKey The key of the organization associated with the app instance.
Version The application version used by the application instance.
StartDate The application instance start date.
EndDate The application instance end date.
State The application instance current state.
StateReason The application instance state reason. Contains the metadata associated with the current state.
Resources The application instance resources.
Features The application instance features.
AccessTags The application instance access tags.

^ Back to top

AppInstanceCompany

Describes an app instance company.

Property Description
AssociationKey Gets or sets the association key.
AppInstance Gets or sets the app instance.
Company Gets or sets the company.

^ Back to top

AppInstanceStateChangedPayload

Describes an app instance state changed payload.

Property Description
Key Gets or sets the key.
PreviousState Gets or sets the previous state.
PreviousStateReason Gets or sets the previous state reason.
NewStateReason Gets or sets the new state reason.
ChangedAt Gets or sets the changed at.
WorkspaceKey Gets or sets the workspace key.
OrganizationKey Gets or sets the organization key.
AppDefinitionKey Gets or sets the app definition key.
Group Gets or sets the group.

^ Back to top

DataExportStateChanged

Describes a data export state change, the payload of the DataExport_Changed webhook. It carries no download addresses: the consumer reads the export through the API.

Property Description
Id Gets or sets the export identifier.
Status Gets or sets the new export status.
SnapshotUtc Gets or sets the snapshot instant of the export (UTC), when already known.
CompletedOn Gets or sets when the export completed or failed (UTC), when already known.
Error Gets or sets the failure description when the export failed.

^ Back to top

EntityDeletedPayload

The payload to send on a entity deleted event.

Property Description
Key The deleted entity key.

^ Back to top

Organization

Defines an organization.

Property Description
BaseKey The organization base key.
TrackingId The organization tracking identifier.
Name The organization name.
WorkspaceKey The key of the workspace associated to the organization.
State The organization current state.
StateReason The organization state reason. Contains the metadata associated with the current state.

^ Back to top

RolesAssignments

Describes a roles assignments.

Property Description
Assignments Gets or sets the assignments.

^ Back to top

Workspace

Defines a workspace.

Property Description
BaseKey The workspace base key.
TrackingId The workspace tracking identifier.
Description The workspaces description.
Name The workspace name.
State The workspace current state.
StateReason The workspace state reason. Contains the metadata associated with the current state.

^ Back to top

WorkspaceCompany

Describes a workspace company.

Property Description
WorkspaceKey Gets or sets the workspace key.
Company Gets or sets the company.

^ Back to top

Controllers

WebhooksClientController

Allows managing webhooks.

Methods
ActivateSubscriptionAsync()

Activates the specified webhook subscription.

Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<bool>> ActivateSubscriptionAsync(string clientId, string subscriptionId, CancellationToken cancellationToken = default);
Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<bool>> ActivateSubscriptionAsync(string clientId, System.Collections.Generic.IList<string> eventNames, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
clientId string The client identifier. Required.
subscriptionId string The subscription identifier. Required.
eventNames System.Collections.Generic.IList<string> The names of the events subscribed. Required.
Returns
Return Type Description
bool A value indicating whether the subscription was activated.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.NotFound Failure: the subscription does not exist.
HttpStatusCode.BadRequest Failure: the request is invalid.

^ Back to top

CreateSubscriptionAsync()

Creates the specified webhook subscription.

Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<string>> CreateSubscriptionAsync(Cegid.Hydrogen.Rest.Webhooks.CreateWebhookSubscriptionRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Hydrogen.Rest.Webhooks.CreateWebhookSubscriptionRequest The request. Required.
Returns
Return Type Description
string The identifier of the new subscription.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.Conflict Failure: the subscription could not be created.
HttpStatusCode.BadRequest Failure: the request is invalid.

^ Back to top

DeleteSubscriptionAsync()

Deletes the specified webhook subscription.

Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteSubscriptionAsync(string clientId, string subscriptionId, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
clientId string The client identifier. Required.
subscriptionId string The subscription identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.NotFound Failure: the subscription does not exist.
HttpStatusCode.BadRequest Failure: the request is invalid.

^ Back to top

DeleteSubscriptionIfExistsAsync()

Deletes the specified webhook subscription if it exists.

Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<bool>> DeleteSubscriptionIfExistsAsync(string clientId, string subscriptionId, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
clientId string The client identifier. Required.
subscriptionId string The subscription identifier. Required.
Returns
Return Type Description
bool A value indicating whether the subscription was deleted.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

^ Back to top

DeleteSubscriptionsAsync()

Deletes all the webhooks subscriptions for the specified client application.

Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> DeleteSubscriptionsAsync(string clientId, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
clientId string The client identifier. Required.
subscriptionId string The subscription identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.NotFound Failure: no subscriptions exist.
HttpStatusCode.BadRequest Failure: the request is invalid.

^ Back to top

DeleteSubscriptionsIfExistAsync()

Deletes all the webhooks subscriptions for the specified client application if they exist.

Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<bool>> DeleteSubscriptionsIfExistAsync(string clientId, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
clientId string The client identifier. Required.
subscriptionId string The subscription identifier. Required.
Returns
Return Type Description
bool A value indicating whether any subscription was deleted.
Status Codes
Status Code Description
HttpStatusCode.NoContent Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

^ Back to top

GetWebhooksMetadataAsync()

Retrieves information about the webhooks available.

Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<Cegid.Hydrogen.Rest.Webhooks.WebhookMetadata>>> GetWebhooksMetadataAsync(CancellationToken cancellationToken = default);
Returns
Return Type Description
System.Collections.Generic.IList<Cegid.Hydrogen.Rest.Webhooks.WebhookMetadata> A list containing the information about the webhooks available.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

^ Back to top

GetSubscriptionAsync()

Retrieves the specified webhook subscription.

Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.Webhooks.WebhookSubscription>> GetSubscriptionAsync(string clientId, string subscriptionId, CancellationToken cancellationToken = default);
Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<Cegid.Hydrogen.Rest.Webhooks.WebhookSubscription>> GetSubscriptionAsync(string clientId, System.Collections.Generic.IList<string> eventNames, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
clientId string The client identifier. Required.
subscriptionId string The subscription identifier. Required.
eventNames System.Collections.Generic.IList<string> The names of the events subscribed. Required.
Returns
Return Type Description
Cegid.Hydrogen.Rest.Webhooks.WebhookSubscription The webhook subscription.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.NotFound Failure: the subscription does not exist.
HttpStatusCode.BadRequest Failure: the request is invalid.

^ Back to top

GetSubscriptionsAsync()

Retrieves all the subscriptions for the specified client application.

Task<Cegid.Hydrogen.Rest.Client.RestServiceResult<System.Collections.Generic.IList<Cegid.Hydrogen.Rest.Webhooks.WebhookSubscription>>> GetSubscriptionsAsync(string clientId, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
clientId string The client identifier. Required.
subscriptionId string The subscription identifier. Required.
Returns
Return Type Description
System.Collections.Generic.IList<Cegid.Hydrogen.Rest.Webhooks.WebhookSubscription> A list containing the webhooks subscriptions.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.NotFound Failure: no subscriptions exist.
HttpStatusCode.BadRequest Failure: the request is invalid.

^ Back to top

PingSubscriptionAsync()

Pings the specified webhook subscription (to check if the callback is working correctly, for example).

Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> PingSubscriptionAsync(string clientId, string subscriptionId, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
clientId string The client identifier. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.NotFound Failure: the subscription does not exist.
HttpStatusCode.BadRequest Failure: the request is invalid.

^ Back to top

UpdateSubscriptionAsync()

Updates the specified webhook subscription.

Task<Cegid.Hydrogen.Rest.Client.RestServiceResult> UpdateSubscriptionAsync(Cegid.Hydrogen.Rest.Webhooks.UpdateWebhookSubscriptionRequest request, CancellationToken cancellationToken = default);
Parameters
Parameter Type Description Rules
request Cegid.Hydrogen.Rest.Webhooks.UpdateWebhookSubscriptionRequest The request. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.OK Success.
HttpStatusCode.NotFound Failure: the subscription does not exist.
HttpStatusCode.Conflict Failure: the subscription could not be updated.
HttpStatusCode.BadRequest Failure: the request is invalid.

^ Back to top