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
AppDefinitions The application definitions controller.
AppInstances The application instances controller.
Companies Provides operations on companies.
Organizations The organizations controller.
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
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.
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.
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.
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.
ProvisioningResult Describes a provisioning result.
ResourceSubjectRolesRequest Describes a resource subject roles request.
ResourceSubjectRolesResponse Describes a resource subject roles response.
RolesAssignment Describes a Roles Assingment.
RolesAssignments Describes a roles assignments.
SubjectRolesRequest Describes a subject roles request.
SubjectRolesResponse Describes a subject roles response.
TransferAppInstanceBody Defines the move instance operation parameters.
Workspace Defines a workspace.

The service includes custom models not described here.

^ Back to top

Enumerations

Enumeration Description
AccessKind Defines how the access to a resource is obtained relatively to other resources.
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.
OrganizationState Defines the states of an organization.
ResourceType Defines the type of the resource to provide access to.
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
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
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
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
ApiScopesNotFound Indicates that the API scopes were not found in Cegid Id.
AppDefinitionCannotBeChanged The appinstance associated appdefinition cannot be changed.
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.
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.
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.
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.
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.
MaxFileSizeExceeded Indicates that the maximum allowed size of a file was exceeded.
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.
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.
TargetSubjectHasFullAccess The target subject has full access.
TargetSubjectTypeMismatch The target subject type mismatch.
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

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.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.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, 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
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 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, 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.
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

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

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

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

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

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

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

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

ProvisioningResult

Describes a provisioning result.

Properties

The model has no properties.

^ 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

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

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

Enumerations

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

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.

^ 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

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

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.
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.

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

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

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