Skip to Content
New release 12 available 🎉
API ReferenceSchemasOverview

Schemas

The request and response models of the API, grouped by area. Endpoint pages link to the model they use.

Pages

All Schemas

SchemaPage
Licensing.ActivateLicenseRequestLicensing
Licensing.ActivateLicenseResponseLicensing
Licensing.DeactivateLicenseRequestLicensing
Licensing.DeactivateLicenseResponseLicensing
Licensing.DeleteReleaseDownloadResponseProduct Releases
Licensing.DurationLicensing
Licensing.GetReleaseDownloadsResponseProduct Releases
Licensing.HeartbeatRequestLicensing
Licensing.HeartbeatResponseLicensing
Licensing.InsertReleaseDownloadRequestProduct Releases
Licensing.InsertReleaseDownloadResponseProduct Releases
Licensing.LicenseLicensing
Licensing.LicenseFormatLicensing
Licensing.LicenseInfoRequestLicensing
Licensing.LicenseInfoResponseLicensing
Licensing.LicenseTokenLicensing
Licensing.LicensingModeLicensing
Licensing.ReleaseDownloadDtoProduct Releases
Licensing.ReleaseLicenseRequestLicensing
Licensing.ReleaseLicenseResponseLicensing
Licensing.ReportLicensing
Licensing.RequestLicenseRequestLicensing
Licensing.RequestLicenseResponseLicensing
Licensing.SendReportRequestLicensing
Licensing.SendReportResponseLicensing
Licensing.TimestampLicensing
Licensing.UpdateReleaseDownloadRequestProduct Releases
Licensing.UpdateReleaseDownloadResponseProduct Releases
Licensing.ValidateLicenseRequestLicensing
Licensing.ValidateLicenseResponseLicensing
Licensing.VerifyReleaseDownloadsResponseProduct Releases
Management.AddUserToRoleRequestUsers, Roles and API Keys
Management.AddUserToRoleResponseUsers, Roles and API Keys
Management.ApiKeyUsers, Roles and API Keys
Management.ApplicationSettingReports, Log and Server
Management.AssemblyCustomers, Orders and Products
Management.ContactCustomers, Orders and Products
Management.CreateWebhookSubscriptionDtoWebhooks
Management.CreateWebhookSubscriptionRequestWebhooks
Management.CreateWebhookSubscriptionResponseWebhooks
Management.CustomerCustomers, Orders and Products
Management.DeleteApiKeyResponseUsers, Roles and API Keys
Management.DeleteAssemblyResponseCustomers, Orders and Products
Management.DeleteContactResponseCustomers, Orders and Products
Management.DeleteCustomerResponseCustomers, Orders and Products
Management.DeleteLicenseResponseLicenses
Management.DeleteLicenseTemplateResponseLicenses
Management.DeleteLicenseTokenResponseLicense Tokens
Management.DeleteLicenseTraceRequestLicenses
Management.DeleteLicenseTraceResponseLicenses
Management.DeleteOrderResponseCustomers, Orders and Products
Management.DeleteProductOrderResponseCustomers, Orders and Products
Management.DeleteProductReleaseAssemblyResponseProduct Releases
Management.DeleteProductReleaseResponseProduct Releases
Management.DeleteProductResponseCustomers, Orders and Products
Management.DeleteReportResponseReports, Log and Server
Management.DeleteResourceResponseCustomers, Orders and Products
Management.DeleteUserResponseUsers, Roles and API Keys
Management.DeleteUserSettingResponseUsers, Roles and API Keys
Management.DeleteWebhookEventResponseWebhooks
Management.DeleteWebhookSubscriptionResponseWebhooks
Management.EmailAttachmentReports, Log and Server
Management.EmailRecipientReports, Log and Server
Management.GetApiKeysResponseUsers, Roles and API Keys
Management.GetAssembliesResponseCustomers, Orders and Products
Management.GetContactsResponseCustomers, Orders and Products
Management.GetCustomerContactsResponseCustomers, Orders and Products
Management.GetCustomerLicensesResponseLicenses
Management.GetCustomerOrdersResponseCustomers, Orders and Products
Management.GetCustomersResponseCustomers, Orders and Products
Management.GetLicensesResponseLicenses
Management.GetLicenseTemplateLicensesResponseLicenses
Management.GetLicenseTemplatesResponseLicenses
Management.GetLicenseTokensResponseLicense Tokens
Management.GetLicenseTracesResponseLicenses
Management.GetLoggedInUserRequestAuthentication
Management.GetLoggedInUserResponseAuthentication
Management.GetLogLevelsResponseReports, Log and Server
Management.GetLogResponseReports, Log and Server
Management.GetOrderLicensesResponseLicenses
Management.GetOrderProductsResponseCustomers, Orders and Products
Management.GetOrdersResponseCustomers, Orders and Products
Management.GetProductOrdersResponseCustomers, Orders and Products
Management.GetProductReleaseAssembliesResponseProduct Releases
Management.GetProductReleaseLicenseTemplatesResponseProduct Releases
Management.GetProductReleasesResponseProduct Releases
Management.GetProductsResponseCustomers, Orders and Products
Management.GetReportResponseReports, Log and Server
Management.GetResourcesResponseCustomers, Orders and Products
Management.GetRolesResponseUsers, Roles and API Keys
Management.GetServerInfoResponseReports, Log and Server
Management.GetSessionResponseAuthentication
Management.GetSettingsRequestReports, Log and Server
Management.GetSettingsResponseReports, Log and Server
Management.GetUserRolesResponseUsers, Roles and API Keys
Management.GetUserSettingsResponseUsers, Roles and API Keys
Management.GetUsersResponseUsers, Roles and API Keys
Management.GetWebhookEventsResponseWebhooks
Management.GetWebhookEventTypesResponseWebhooks
Management.GetWebhookStatusResponseWebhooks
Management.GetWebhookSubscriptionResponseWebhooks
Management.GetWebhookSubscriptionsResponseWebhooks
Management.InsertApiKeyRequestUsers, Roles and API Keys
Management.InsertApiKeyResponseUsers, Roles and API Keys
Management.InsertAssemblyRequestCustomers, Orders and Products
Management.InsertAssemblyResponseCustomers, Orders and Products
Management.InsertContactRequestCustomers, Orders and Products
Management.InsertContactResponseCustomers, Orders and Products
Management.InsertCustomerRequestCustomers, Orders and Products
Management.InsertCustomerResponseCustomers, Orders and Products
Management.InsertLicenseRequestLicenses
Management.InsertLicenseResponseLicenses
Management.InsertLicenseTemplateRequestLicenses
Management.InsertLicenseTemplateResponseLicenses
Management.InsertLicenseTokenRequestLicense Tokens
Management.InsertLicenseTokenResponseLicense Tokens
Management.InsertOrderRequestCustomers, Orders and Products
Management.InsertOrderResponseCustomers, Orders and Products
Management.InsertProductOrderRequestCustomers, Orders and Products
Management.InsertProductOrderResponseCustomers, Orders and Products
Management.InsertProductReleaseAssemblyRequestProduct Releases
Management.InsertProductReleaseAssemblyResponseProduct Releases
Management.InsertProductReleaseRequestProduct Releases
Management.InsertProductReleaseResponseProduct Releases
Management.InsertProductRequestCustomers, Orders and Products
Management.InsertProductResponseCustomers, Orders and Products
Management.InsertResourceRequestCustomers, Orders and Products
Management.InsertResourceResponseCustomers, Orders and Products
Management.InsertUserRequestUsers, Roles and API Keys
Management.InsertUserResponseUsers, Roles and API Keys
Management.InsertUserSettingRequestUsers, Roles and API Keys
Management.InsertUserSettingResponseUsers, Roles and API Keys
Management.LicenseLicenses
Management.LicenseeLicenses
Management.LicenseFeatureLicenses
Management.LicenseFieldLicenses
Management.LicenseProductLicenses
Management.LicenseRestrictionLicenses
Management.LicenseTemplateLicenses
Management.LicenseTokenLicense Tokens
Management.LicenseTraceLicenses
Management.LicensingModeLicenses
Management.LogEntryReports, Log and Server
Management.LoginRequestAuthentication
Management.LoginResponseAuthentication
Management.LogLevelInfoReports, Log and Server
Management.LogoutRequestAuthentication
Management.LogoutResponseAuthentication
Management.OrderCustomers, Orders and Products
Management.ProductCustomers, Orders and Products
Management.ProductOrderCustomers, Orders and Products
Management.ReleaseProduct Releases
Management.RemoveUserFromRoleRequestUsers, Roles and API Keys
Management.RemoveUserFromRoleResponseUsers, Roles and API Keys
Management.ReportReports, Log and Server
Management.ReportPropertyReports, Log and Server
Management.ResolveLicenseTraceLocationsRequestLicenses
Management.ResolveLicenseTraceLocationsResponseLicenses
Management.ResolveReportLocationsRequestReports, Log and Server
Management.ResolveReportLocationsResponseReports, Log and Server
Management.ResourceCustomers, Orders and Products
Management.RoleUsers, Roles and API Keys
Management.SendEmailRequestReports, Log and Server
Management.SendEmailResponseReports, Log and Server
Management.SendLicenseEmailRequestReports, Log and Server
Management.SendLicenseEmailResponseReports, Log and Server
Management.SendWebhookTestEventRequestWebhooks
Management.SendWebhookTestEventResponseWebhooks
Management.UpdateApiKeyRequestUsers, Roles and API Keys
Management.UpdateApiKeyResponseUsers, Roles and API Keys
Management.UpdateAssemblyRequestCustomers, Orders and Products
Management.UpdateAssemblyResponseCustomers, Orders and Products
Management.UpdateContactRequestCustomers, Orders and Products
Management.UpdateContactResponseCustomers, Orders and Products
Management.UpdateCustomerRequestCustomers, Orders and Products
Management.UpdateCustomerResponseCustomers, Orders and Products
Management.UpdateLicenseRequestLicenses
Management.UpdateLicenseResponseLicenses
Management.UpdateLicenseTemplateRequestLicenses
Management.UpdateLicenseTemplateResponseLicenses
Management.UpdateOrderRequestCustomers, Orders and Products
Management.UpdateOrderResponseCustomers, Orders and Products
Management.UpdateProductOrderRequestCustomers, Orders and Products
Management.UpdateProductOrderResponseCustomers, Orders and Products
Management.UpdateProductReleaseAssemblyRequestProduct Releases
Management.UpdateProductReleaseAssemblyResponseProduct Releases
Management.UpdateProductReleaseRequestProduct Releases
Management.UpdateProductReleaseResponseProduct Releases
Management.UpdateProductRequestCustomers, Orders and Products
Management.UpdateProductResponseCustomers, Orders and Products
Management.UpdateResourceRequestCustomers, Orders and Products
Management.UpdateResourceResponseCustomers, Orders and Products
Management.UpdateSettingsRequestReports, Log and Server
Management.UpdateSettingsResponseReports, Log and Server
Management.UpdateUserRequestUsers, Roles and API Keys
Management.UpdateUserResponseUsers, Roles and API Keys
Management.UpdateUserSettingRequestUsers, Roles and API Keys
Management.UpdateUserSettingResponseUsers, Roles and API Keys
Management.UpdateUserSettingsRequestAuthentication
Management.UpdateUserSettingsResponseAuthentication
Management.UpdateWebhookSubscriptionDtoWebhooks
Management.UpdateWebhookSubscriptionRequestWebhooks
Management.UpdateWebhookSubscriptionResponseWebhooks
Management.UserUsers, Roles and API Keys
Management.UserSettingUsers, Roles and API Keys
Management.WebhookEventWebhooks
Management.WebhookEventTypeWebhooks
Management.WebhookSubscriptionWebhooks
Last updated on