{
"x-generator": "NSwag v14.6.3.0 (NJsonSchema v11.5.2.0 (Newtonsoft.Json v13.0.0.0))",
"openapi": "3.0.0",
"info": {
"title": "SLASCONE API",
"description": "Please visit our official [Documentation](https://support.slascone.com/hc/en-us/sections/360004685737-API) and/or our [GitHub repository](https://github.com/slascone/) and/or our [NuGet package](https://www.nuget.org/packages/Slascone.Client/). Always use Version 2 of this API (Version 1.3 is deprecated).",
"termsOfService": "https://slascone.com/terms/",
"contact": {
"name": "SLASCONE GmbH",
"url": "https://slascone.com/contact/"
},
"license": {
"name": "Run in Postman",
"url": "https://app.getpostman.com/run-collection/14554347-2158509b-e1b4-44ba-8068-d887780b9027?action=collection%2Ffork&collection-url=entityId%3D14554347-2158509b-e1b4-44ba-8068-d887780b9027%26entityType%3Dcollection%26workspaceId%3Dce013885-c3ae-4aa7-a17f-62a679f6483f"
},
"version": "v2"
},
"paths": {
"/api/v2/isv/{isv_id}/administration/slasconelicenseinfo": {
"get": {
"tags": [
"Administration"
],
"summary": "Retrieve Slascone licensing state and license info",
"operationId": "GetSlasconeLicenseInfo",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "forceSendHeartbeat",
"in": "query",
"schema": {
"type": "boolean"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SlasconeLicenseInfoDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/gatheranalytics": {
"put": {
"tags": [
"Administration"
],
"summary": "Gathers analytics by sending consumption heartbeats.",
"operationId": "GatherAnalytics",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/validatelicensesexpirationdate": {
"put": {
"tags": [
"Administration"
],
"summary": "Validates license expiration dates, feature expiration, and license start dates.",
"operationId": "ValidateLicenseExpirationDate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/validateheartbeatgroups": {
"put": {
"tags": [
"Administration"
],
"summary": "Validates heartbeat groups for the specified ISV.",
"operationId": "ValidateHeartbeatGroups",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/validatesoftwareversions": {
"put": {
"tags": [
"Administration"
],
"summary": "Validates software versions for the specified ISV.",
"operationId": "ValidateSoftwareVersions",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/customoperations": {
"put": {
"tags": [
"Administration"
],
"summary": "Executes custom operations for the specified ISV.",
"operationId": "CustomOperations",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/deleteinactivesessions": {
"put": {
"tags": [
"Administration"
],
"summary": "Deletes inactive sessions for the specified ISV.",
"operationId": "DeleteInactiveSessions",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/autounassign": {
"put": {
"tags": [
"Administration"
],
"summary": "Automatically unassigns tokens based on inactivity for all products.",
"operationId": "ValidateAssignments",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/alert": {
"put": {
"tags": [
"Administration"
],
"summary": "Validates and sends alerts for licenses based on alert configuration.",
"operationId": "ValidateAlerts",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/consumptionbalance": {
"put": {
"tags": [
"Administration"
],
"summary": "Validates and updates consumption balances for the specified ISV.",
"operationId": "ValidateConsumptionBalances",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/product/{product_id}/autounassign": {
"put": {
"tags": [
"Administration"
],
"summary": "Automatically unassigns tokens for a specific product based on inactivity.",
"operationId": "ValidateAssignmentsByProductId",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "aDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateAssignmentsDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/migratedatabase": {
"put": {
"tags": [
"Administration"
],
"summary": "Migrates the database for the specified ISV.",
"operationId": "MigrateDatabase",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MigrateDatabaseInfoDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MigrateDatabaseInfoDto"
}
}
}
},
"204": {
"description": "No Content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/licenseseats": {
"get": {
"tags": [
"Administration"
],
"summary": "Gets the number of license seats for the specified ISV and filter criteria.",
"operationId": "GetLicenseSeats",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "query",
"description": "The product identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "templateIds",
"in": "query",
"style": "form",
"explode": true,
"description": "The list of template identifiers.",
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"x-position": 3
},
{
"name": "customerTypeIds",
"in": "query",
"style": "form",
"explode": true,
"description": "The list of customer type identifiers.",
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"x-position": 4
},
{
"name": "licenseTypeIds",
"in": "query",
"style": "form",
"explode": true,
"description": "The list of license type identifiers.",
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"x-position": 5
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/configuration": {
"get": {
"tags": [
"Administration"
],
"summary": "Gets the configuration for the specified ISV.",
"operationId": "GetConfiguration",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
},
"patch": {
"tags": [
"Administration"
],
"summary": "Updates the configuration for the specified ISV.",
"operationId": "PatchConfiguration",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "configurationDto",
"description": "The configuration data transfer object.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/customlist": {
"get": {
"tags": [
"Administration"
],
"summary": "Gets all custom lists for the specified ISV.",
"operationId": "GetAllCustomLists",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomListDto"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
},
"post": {
"tags": [
"Administration"
],
"summary": "Adds a new custom list for the specified ISV.",
"operationId": "AddCustomList",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "custom_list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomListDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomListDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomListResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1015,
"message": "The Custom list cannot be deleted because it is in use.",
"help": ""
},
{
"id": 1016,
"message": "This element cannot be deleted because it is used in an edition or license.",
"help": ""
},
{
"id": 1017,
"message": "The custom list contains duplicate elements.",
"help": ""
},
{
"id": 1023,
"message": "Can not delete custom list element because it is in use.",
"help": "The custom list element that should be deleted is used in a edition or in a license."
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
},
"put": {
"tags": [
"Administration"
],
"summary": "Updates an existing custom list for the specified ISV.",
"operationId": "UpdateCustomList",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "custom_list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomListDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomListDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomListResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1015,
"message": "The Custom list cannot be deleted because it is in use.",
"help": ""
},
{
"id": 1016,
"message": "This element cannot be deleted because it is used in an edition or license.",
"help": ""
},
{
"id": 1017,
"message": "The custom list contains duplicate elements.",
"help": ""
},
{
"id": 1023,
"message": "Can not delete custom list element because it is in use.",
"help": "The custom list element that should be deleted is used in a edition or in a license."
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
},
"patch": {
"tags": [
"Administration"
],
"summary": "Partially updates an existing custom list for the specified ISV.",
"operationId": "PatchCustomList",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "custom_list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomListDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomListDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomListResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1015,
"message": "The Custom list cannot be deleted because it is in use.",
"help": ""
},
{
"id": 1016,
"message": "This element cannot be deleted because it is used in an edition or license.",
"help": ""
},
{
"id": 1017,
"message": "The custom list contains duplicate elements.",
"help": ""
},
{
"id": 1023,
"message": "Can not delete custom list element because it is in use.",
"help": "The custom list element that should be deleted is used in a edition or in a license."
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/customlist/{custom_list_id}": {
"get": {
"tags": [
"Administration"
],
"summary": "Gets a specific custom list by its ID for the specified ISV.",
"operationId": "GetCustomList",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "custom_list_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomListDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
},
"delete": {
"tags": [
"Administration"
],
"summary": "Deletes a custom list by its ID for the specified ISV.",
"operationId": "DeleteCustomList",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "custom_list_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomListResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1015,
"message": "The Custom list cannot be deleted because it is in use.",
"help": ""
},
{
"id": 1016,
"message": "This element cannot be deleted because it is used in an edition or license.",
"help": ""
},
{
"id": 1017,
"message": "The custom list contains duplicate elements.",
"help": ""
},
{
"id": 1023,
"message": "Can not delete custom list element because it is in use.",
"help": "The custom list element that should be deleted is used in a edition or in a license."
}
]
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/backupstorage": {
"get": {
"tags": [
"Administration"
],
"summary": "Gets the backup storage configuration for the specified ISV.",
"operationId": "GetBackupStorage",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackupStorageDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
},
"put": {
"tags": [
"Administration"
],
"summary": "Updates the backup storage configuration for the specified ISV.",
"operationId": "UpdateBackupStorage",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "backup_storage",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackupStorageDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackupStorageDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackupStorageResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1031,
"message": "Feature 'Cloud backup' is not active.",
"help": "Cloud backup configuration can not be set because the feature is not active in your SLASCONE license."
},
{
"id": 1033,
"message": "Unknown customer",
"help": "The customer does not exist."
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/backupstorage/init": {
"post": {
"tags": [
"Administration"
],
"summary": "Initializes backup storage for the specified ISV, optionally for a specific customer and including inactive licenses.",
"operationId": "InitBackupStorage",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_id",
"in": "query",
"description": "The customer identifier or customer number (optional).",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
},
{
"name": "include_inactive",
"in": "query",
"description": "Whether to include inactive licenses (optional).",
"schema": {
"type": "boolean",
"nullable": true
},
"x-position": 3
}
],
"responses": {
"200": {
"description": "Plain text",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "This function will return plain text."
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackupStorageResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1031,
"message": "Feature 'Cloud backup' is not active.",
"help": "Cloud backup configuration can not be set because the feature is not active in your SLASCONE license."
},
{
"id": 1033,
"message": "Unknown customer",
"help": "The customer does not exist."
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/backupstorage/access_token": {
"get": {
"tags": [
"Administration"
],
"summary": "Gets a shared access token for the backup storage of the specified ISV.",
"operationId": "GetBackupStorageAccessToken",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Plain text",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "This function will return plain text."
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackupStorageSasTokenCredentialsError"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/healthcheck": {
"get": {
"tags": [
"Administration"
],
"summary": "Performs a health check for the specified ISV, including product and user role validation and migration.",
"operationId": "HealthCheck",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Plain text",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "This function will return plain text."
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/healthcheck/signaturecheck": {
"post": {
"tags": [
"Administration"
],
"summary": "Checks the validity of a signature for the specified ISV.",
"operationId": "SignatureCheck",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "signature",
"description": "The signature to check.",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Plain text",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "This function will return plain text."
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/administration/resellerportal/globalsettings": {
"get": {
"tags": [
"Administration"
],
"summary": "Gets the reseller portal global settings for the specified ISV.",
"operationId": "GetResellerPortalGlobalSettings",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerPortalGlobalSettingsDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
},
"put": {
"tags": [
"Administration"
],
"summary": "Updates the reseller portal global settings for the specified ISV.",
"operationId": "UpdateResellerPortalGlobalSettings",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "reseller_portal_global_settings",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerPortalGlobalSettingsDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerPortalGlobalSettingsDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomListResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1015,
"message": "The Custom list cannot be deleted because it is in use.",
"help": ""
},
{
"id": 1016,
"message": "This element cannot be deleted because it is used in an edition or license.",
"help": ""
},
{
"id": 1017,
"message": "The custom list contains duplicate elements.",
"help": ""
},
{
"id": 1023,
"message": "Can not delete custom list element because it is in use.",
"help": "The custom list element that should be deleted is used in a edition or in a license."
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DaemonKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers": {
"get": {
"tags": [
"Customer"
],
"summary": "Returns all customers",
"operationId": "GetAllCustomers",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "name",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Customer"
],
"summary": "Creates a customer",
"operationId": "AddCustomer",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "customer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"patch": {
"tags": [
"Customer"
],
"summary": "Updates a customer",
"operationId": "UpdateCustomer",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "customer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/light": {
"get": {
"tags": [
"Customer"
],
"summary": "Returns all customers with reduced information",
"description": "Returns only Id, Name, CustomerNumber, and Email address.",
"operationId": "GetAllCustomersLight",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerLightDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/filtered": {
"post": {
"tags": [
"Customer"
],
"summary": "Returns all customers matching a filter",
"operationId": "GetFilteredCustomers",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "customerFilter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerFilterDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerLazyLoadDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/{customer_id}": {
"get": {
"tags": [
"Customer"
],
"summary": "Returns a specific customer",
"operationId": "GetCustomer",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Customer"
],
"summary": "Deletes a customer",
"operationId": "DeleteCustomer",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/number/{customer_number}": {
"get": {
"tags": [
"Customer"
],
"summary": "Returns a specific customer (deprecated; use api/v2/isv/{isv_id}/customers/by_number instead)",
"operationId": "Customer_GetCustomerByCustomerNumberDeprecated",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_number",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerDto"
}
}
}
}
},
"deprecated": true,
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/by_number": {
"get": {
"tags": [
"Customer"
],
"summary": "Returns a specific customer",
"operationId": "GetCustomerByNumber",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_number",
"in": "query",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/{customer_id}/contacts": {
"get": {
"tags": [
"Customer"
],
"summary": "Returns a customer's contacts",
"operationId": "GetCustomerContacts",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerContactDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Customer"
],
"summary": "Creates a customer contact",
"description": "Sends also an invitation email to the contact address",
"operationId": "AddCustomerContact",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "contact",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerContactDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerContactDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"patch": {
"tags": [
"Customer"
],
"summary": "Updates a customer contact",
"operationId": "UpdateCustomerContact",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "contact",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerContactDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerContactDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/{customer_id}/contacts/{contact_id}": {
"put": {
"tags": [
"Customer"
],
"summary": "Toggles a customer contact state",
"description": "Toggles 'isActive' state of a customer contact",
"operationId": "ToggleCustomerContactState",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "contact_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerContactDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Customer"
],
"summary": "Deletes a customer contact",
"operationId": "DeleteCustomerContact",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "contact_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
},
{
"name": "remove_identity",
"in": "query",
"schema": {
"type": "boolean",
"default": true
},
"x-position": 4
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerContactDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/{customer_id}/contacts/email/{contact_id}": {
"get": {
"tags": [
"Customer"
],
"summary": "Sends a new invitation email to a customer contact",
"description": "A first invitation is send during creation of a contact",
"operationId": "ResendCustomerContactInvitation",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "contact_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/contacts/by_user": {
"get": {
"tags": [
"Customer"
],
"summary": "Returns the customer contact matching the id of the logged in user",
"operationId": "GetCustomerContactByUserId",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerContactDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/contacts/language": {
"get": {
"tags": [
"Customer"
],
"summary": "Returns the available customer contact languages",
"operationId": "GetCustomerContactLanguages",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/types": {
"get": {
"tags": [
"Customer"
],
"summary": "Returns all customer types",
"description": "More information about custom types and tags.",
"operationId": "GetCustomerTypes",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "name",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerTypeDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Customer"
],
"summary": "Creates a customer type",
"description": "More information about custom types and tags.",
"operationId": "AddCustomerType",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "type",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTypeDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTypeDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"patch": {
"tags": [
"Customer"
],
"summary": "Updates a customer type",
"description": "More information about custom types and tags.",
"operationId": "UpdateCustomerType",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "type",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTypeDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTypeDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/types/{type_id}/new_type/{new_type_id}": {
"delete": {
"tags": [
"Customer"
],
"summary": "Deletes a customer type",
"description": "More information about custom types and tags.",
"operationId": "RemoveCustomerType",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "type_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "new_type_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTypeDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/count": {
"get": {
"tags": [
"Customer"
],
"summary": "Returns the number of customers",
"operationId": "GetCustomerCount",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customers/{customer_id}/tags": {
"get": {
"tags": [
"Customer"
],
"summary": "Returns all tags of a customer",
"operationId": "GetCustomerTagAssignments",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemTagAssignmentDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Customer"
],
"summary": "Updates the tags of a customer",
"operationId": "UpdateCustomerTagAssignments",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "tagAssignmentDtos",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemTagAssignmentDto"
}
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemTagAssignmentDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/customer_portal/customer/contact": {
"get": {
"tags": [
"CustomerPortal"
],
"summary": "Returns a customer portal user",
"operationId": "GetCustomerContactByUserIdCP",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerContactDto"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"deprecated": true,
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_exchange/customers": {
"post": {
"tags": [
"DataExchange"
],
"summary": "Creates a customer",
"description": "More Information",
"operationId": "AddCustomerAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "customerDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeAddCustomerDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeAddCustomerResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 4002,
"message": "A customer with this number already exists.",
"help": ""
},
{
"id": 9000,
"message": "Unknown country.",
"help": ""
},
{
"id": 9001,
"message": "Unknown customer type.",
"help": ""
},
{
"id": 9002,
"message": "Company name cannot be empty.",
"help": ""
},
{
"id": 9005,
"message": "A customer with this prospect number already exists.",
"help": ""
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DataExchangeAuthorize": []
}
]
},
"patch": {
"tags": [
"DataExchange"
],
"summary": "Updates a customer",
"description": "Based on customer_number More Information.",
"operationId": "UpdateCustomerAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "customerDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeUpdateCustomerDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeUpdateCustomerResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 4000,
"message": "Unknown customer.",
"help": ""
},
{
"id": 9000,
"message": "Unknown country.",
"help": ""
},
{
"id": 9001,
"message": "Unknown customer type.",
"help": ""
},
{
"id": 9005,
"message": "A customer with this prospect number already exists.",
"help": ""
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DataExchangeAuthorize": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_exchange/customers/contacts": {
"put": {
"tags": [
"DataExchange"
],
"summary": "Creates a customer contact",
"operationId": "AddOrUpdateCustomerContactAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "customerContactDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeAddOrUpdateCustomerContactDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerContactDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeAddOrUpdateCustomerContactErrorResponse"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 4000,
"message": "Unknown customer.",
"help": ""
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DataExchangeAuthorize": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_exchange/licenses/import_csv": {
"post": {
"tags": [
"DataExchange"
],
"summary": "Imports a csv license file",
"description": "More Information.",
"operationId": "ImportLicensesFromCsv",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "delimiter",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 3
},
{
"name": "resume_on_error",
"in": "query",
"schema": {
"type": "boolean"
},
"x-position": 4
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"nullable": true
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportResultDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DataExchangeAuthorize": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_exchange/customers/import_csv": {
"post": {
"tags": [
"DataExchange"
],
"summary": "Imports a csv customer file",
"description": "More Information.",
"operationId": "ImportCustomersFromCsv",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "delimiter",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
},
{
"name": "overwrite_existing",
"in": "query",
"schema": {
"type": "boolean"
},
"x-position": 3
},
{
"name": "resume_on_error",
"in": "query",
"schema": {
"type": "boolean"
},
"x-position": 4
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"nullable": true
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportResultDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DataExchangeAuthorize": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_exchange/customers/download_csv": {
"get": {
"tags": [
"DataExchange"
],
"summary": "Downloads a csv customer file template",
"operationId": "DownloadCustomerCsvTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DataExchangeAuthorize": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_exchange/licenses/download_csv": {
"get": {
"tags": [
"DataExchange"
],
"summary": "Downloads a csv license file template",
"operationId": "DownloadLicenseCsvTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DataExchangeAuthorize": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_exchange/licenses/by_template": {
"post": {
"tags": [
"DataExchange"
],
"summary": "Creates a license based on an edition (template)",
"description": "Check the documentation for more details.",
"operationId": "AddLicenseAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "licenseDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeAddLicenseDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "uuid"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeAddLicenseResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1004,
"message": "Unknown software release limitation. If you want to reset the productSoftwareReleaseLimitation, then use productSoftwareReleaseLimitation= 'none' or productSoftwareReleaseLimitation= ''.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
},
{
"id": 4000,
"message": "Unknown customer.",
"help": ""
},
{
"id": 8001,
"message": "Unknown template (edition) name.",
"help": ""
},
{
"id": 9003,
"message": "The expiration date is not valid. Supported formats: mm/dd/yyyy, dd.mm.yyyy, yyyy-mm-dd,yyyy-mm-dd, yyyy-MM-dd(THH:mm:ssZ)",
"help": ""
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DataExchangeAuthorize": []
}
]
},
"patch": {
"tags": [
"DataExchange"
],
"summary": "Updates a license based on an edition (template)",
"description": "Check the documentation for more details.",
"operationId": "UpdateLicenseAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "licenseDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeUpdateLicenseDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "uuid"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeUpdateLicenseResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1004,
"message": "Unknown software release limitation. If you want to reset the productSoftwareReleaseLimitation, then use productSoftwareReleaseLimitation= 'none' or productSoftwareReleaseLimitation= ''.",
"help": ""
},
{
"id": 2007,
"message": "Unknown legacy license key.",
"help": ""
},
{
"id": 2009,
"message": "Unknown license type.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
},
{
"id": 4000,
"message": "Unknown customer.",
"help": ""
},
{
"id": 8001,
"message": "Unknown template (edition) name.",
"help": ""
},
{
"id": 9003,
"message": "The expiration date is not valid. Supported formats: mm/dd/yyyy, dd.mm.yyyy, yyyy-mm-dd,yyyy-mm-dd, yyyy-MM-dd(THH:mm:ssZ)",
"help": ""
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DataExchangeAuthorize": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_exchange/licenses": {
"post": {
"tags": [
"DataExchange"
],
"summary": "Creates a license allowing to define all feature/variable/limitation values",
"description": "Check the documentation for more details.",
"operationId": "AddLicenseByDetailsAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "licenseDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseImportByDetailsDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "uuid"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeAddLicenseByDetailsResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1004,
"message": "Unknown software release limitation. If you want to reset the productSoftwareReleaseLimitation, then use productSoftwareReleaseLimitation= 'none' or productSoftwareReleaseLimitation= ''.",
"help": ""
},
{
"id": 1005,
"message": "A license with this legacy license key already exists.",
"help": ""
},
{
"id": 2009,
"message": "Unknown license type.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
},
{
"id": 3001,
"message": "Unknown product feature.",
"help": ""
},
{
"id": 3002,
"message": "Unknown product variable.",
"help": ""
},
{
"id": 3003,
"message": "Unknown product limitation.",
"help": ""
},
{
"id": 4000,
"message": "Unknown customer.",
"help": ""
},
{
"id": 8001,
"message": "Unknown template (edition) name.",
"help": ""
},
{
"id": 9003,
"message": "The expiration date is not valid. Supported formats: mm/dd/yyyy, dd.mm.yyyy, yyyy-mm-dd,yyyy-mm-dd, yyyy-MM-dd(THH:mm:ssZ)",
"help": ""
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DataExchangeAuthorize": []
}
]
},
"patch": {
"tags": [
"DataExchange"
],
"summary": "Updates a license allowing to define all feature/variable/limitation values",
"description": "Check the documentation for more details.",
"operationId": "PatchLicenseByDetailsAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "licenseDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseImportByDetailsPatchDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "uuid"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeUpdateLicenseByDetailsResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 1004,
"message": "Unknown software release limitation. If you want to reset the productSoftwareReleaseLimitation, then use productSoftwareReleaseLimitation= 'none' or productSoftwareReleaseLimitation= ''.",
"help": ""
},
{
"id": 1005,
"message": "A license with this legacy license key already exists.",
"help": ""
},
{
"id": 2009,
"message": "Unknown license type.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
},
{
"id": 3001,
"message": "Unknown product feature.",
"help": ""
},
{
"id": 3002,
"message": "Unknown product variable.",
"help": ""
},
{
"id": 3003,
"message": "Unknown product limitation.",
"help": ""
},
{
"id": 4000,
"message": "Unknown customer.",
"help": ""
},
{
"id": 8001,
"message": "Unknown template (edition) name.",
"help": ""
},
{
"id": 8002,
"message": "Switching to an edition with a different provisioning mode is not allowed.",
"help": ""
},
{
"id": 8003,
"message": "A non-temporary license cannot be converted to a temporary license, or vice-versa.",
"help": ""
},
{
"id": 9003,
"message": "The expiration date is not valid. Supported formats: mm/dd/yyyy, dd.mm.yyyy, yyyy-mm-dd,yyyy-mm-dd, yyyy-MM-dd(THH:mm:ssZ)",
"help": ""
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DataExchangeAuthorize": []
}
]
},
"put": {
"tags": [
"DataExchange"
],
"summary": "Updates a license allowing to define all feature/variable/limitation values",
"description": "Check the documentation for more details.",
"operationId": "UpdateLicenseByDetailsAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "licenseDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseImportByDetailsPutDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "uuid"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExchangeUpdateLicenseByDetailsResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 1004,
"message": "Unknown software release limitation. If you want to reset the productSoftwareReleaseLimitation, then use productSoftwareReleaseLimitation= 'none' or productSoftwareReleaseLimitation= ''.",
"help": ""
},
{
"id": 1005,
"message": "A license with this legacy license key already exists.",
"help": ""
},
{
"id": 2009,
"message": "Unknown license type.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
},
{
"id": 3001,
"message": "Unknown product feature.",
"help": ""
},
{
"id": 3002,
"message": "Unknown product variable.",
"help": ""
},
{
"id": 3003,
"message": "Unknown product limitation.",
"help": ""
},
{
"id": 4000,
"message": "Unknown customer.",
"help": ""
},
{
"id": 8001,
"message": "Unknown template (edition) name.",
"help": ""
},
{
"id": 8002,
"message": "Switching to an edition with a different provisioning mode is not allowed.",
"help": ""
},
{
"id": 8003,
"message": "A non-temporary license cannot be converted to a temporary license, or vice-versa.",
"help": ""
},
{
"id": 9003,
"message": "The expiration date is not valid. Supported formats: mm/dd/yyyy, dd.mm.yyyy, yyyy-mm-dd,yyyy-mm-dd, yyyy-MM-dd(THH:mm:ssZ)",
"help": ""
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"DataExchangeAuthorize": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_gathering/analytical_heartbeats": {
"post": {
"tags": [
"DataGathering"
],
"summary": "Creates an analytical heartbeat",
"description": "More Information.",
"operationId": "AddAnalyticalHeartbeat",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "analyticalHeartbeat",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticalHeartbeatDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": ""
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticalHeartbeatResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 2002,
"message": "This token is not assigned.",
"help": ""
},
{
"id": 2003,
"message": "Unknown token license key.",
"help": ""
},
{
"id": 2006,
"message": "Unknown client.",
"help": ""
},
{
"id": 2018,
"message": "This token is suspended.",
"help": ""
},
{
"id": 6000,
"message": "Unknown analytical field.",
"help": ""
},
{
"id": 6001,
"message": "Invalid value type error in Analytical Heartbeat value.",
"help": "The provided value resp. value array must fit the analytical field type."
},
{
"id": 6003,
"message": "At least one analytical field appears more than once in the array. Make sure it is used just once.",
"help": ""
},
{
"id": 6005,
"message": "A boolean field can only accept true or false as a value.",
"help": ""
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_gathering/usage_heartbeats": {
"post": {
"tags": [
"DataGathering"
],
"summary": "Creates a usage heartbeat",
"description": "More Information.",
"operationId": "AddUsageHeartbeat",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "usageHeartbeat",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FullUsageHeartbeatDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageHeartbeatResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 2002,
"message": "This token is not assigned.",
"help": ""
},
{
"id": 2003,
"message": "Unknown token license key.",
"help": ""
},
{
"id": 2006,
"message": "Unknown client.",
"help": ""
},
{
"id": 2018,
"message": "This token is suspended.",
"help": ""
},
{
"id": 6001,
"message": "Invalid value type error in Analytical Heartbeat value.",
"help": "The provided value resp. value array must fit the analytical field type."
},
{
"id": 6002,
"message": "Unknown usage feature.",
"help": ""
},
{
"id": 6004,
"message": "Unknown usage module.",
"help": ""
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_gathering/usage_heartbeats_by_name": {
"post": {
"tags": [
"DataGathering"
],
"summary": "Creates a usage heartbeat (alternative method based on the feature's name instead of its Id)",
"description": "More Information.",
"operationId": "AddUsageHeartbeatByName",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "usageHeartbeat",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FullUsageHeartbeatByNameDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageHeartbeatByFeatureNameResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 2002,
"message": "This token is not assigned.",
"help": ""
},
{
"id": 2003,
"message": "Unknown token license key.",
"help": ""
},
{
"id": 2006,
"message": "Unknown client.",
"help": ""
},
{
"id": 2018,
"message": "This token is suspended.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
},
{
"id": 6001,
"message": "Invalid value type error in Analytical Heartbeat value.",
"help": "The provided value resp. value array must fit the analytical field type."
},
{
"id": 6002,
"message": "Unknown usage feature.",
"help": ""
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_gathering/consumption_heartbeats": {
"post": {
"tags": [
"DataGathering"
],
"summary": "Creates a consumption heartbeat",
"description": "More Information.",
"operationId": "AddConsumptionHeartbeat",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "consumptionHeartbeat",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FullConsumptionHeartbeatDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsumptionDto"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsumptionHeartbeatResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1010,
"message": "Unknown license user.",
"help": ""
},
{
"id": 2002,
"message": "This token is not assigned.",
"help": ""
},
{
"id": 2003,
"message": "Unknown token license key.",
"help": ""
},
{
"id": 2006,
"message": "Unknown client.",
"help": ""
},
{
"id": 2018,
"message": "This token is suspended.",
"help": ""
},
{
"id": 6006,
"message": "Unknown license limitation.",
"help": ""
},
{
"id": 6007,
"message": "The consumption value must be higher than 0.",
"help": ""
},
{
"id": 6009,
"message": "The consumption mode is disabled.",
"help": ""
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/data_gathering/consumption_heartbeats/rollback": {
"post": {
"tags": [
"DataGathering"
],
"summary": "Rollbacks a consumption heartbeat",
"description": "More Information.",
"operationId": "RollbackConsumptionHeartbeat",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "rollbackDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsumptionTransactionDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsumptionDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsumptionRollbackResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 6006,
"message": "Unknown license limitation.",
"help": ""
},
{
"id": 6009,
"message": "The consumption mode is disabled.",
"help": ""
},
{
"id": 6022,
"message": "Unknown transaction",
"help": ""
},
{
"id": 6026,
"message": "Rollback is only allowed in the current period (not if the heartbeat was created earlier than the last reset day)",
"help": null
}
]
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licensebundles": {
"get": {
"tags": [
"LicenseBundle"
],
"operationId": "GetLicenseBundles",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "customer_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseBundleDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"LicenseBundle"
],
"operationId": "AddLicenseBundle",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "licenseBundle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseBundleDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseBundleDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"LicenseBundle"
],
"operationId": "UpdateLicenseBundle",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "licenseBundle",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseBundleDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseBundleDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licensebundles/{license_bundle_id}": {
"get": {
"tags": [
"LicenseBundle"
],
"operationId": "GetLicenseBundle",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_bundle_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseBundleDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"LicenseBundle"
],
"operationId": "DeleteLicenseBundle",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_bundle_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseBundleDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licensebundles/{license_bundle_id}/history": {
"get": {
"tags": [
"LicenseBundle"
],
"summary": "Returns the entire audit history of a license bundle",
"operationId": "GetLicenseBundleHistory",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_bundle_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licensebundles/{license_bundle_id}/history/{history_id}": {
"get": {
"tags": [
"LicenseBundle"
],
"summary": "Returns a specific license bundle audit history snapshot",
"operationId": "GetLicenseBundleHistoryDetail",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_bundle_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "history_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HistoryDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses": {
"post": {
"tags": [
"License"
],
"summary": "Creates a license",
"description": "Sample request:\n \n GET /api/customers/123",
"operationId": "AddLicense",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "licenseDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddOrUpdateLicenseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 1004,
"message": "Unknown software release limitation. If you want to reset the productSoftwareReleaseLimitation, then use productSoftwareReleaseLimitation= 'none' or productSoftwareReleaseLimitation= ''.",
"help": ""
},
{
"id": 1005,
"message": "A license with this legacy license key already exists.",
"help": ""
},
{
"id": 1009,
"message": "The maximum number of users () for this license has been reached.",
"help": ""
},
{
"id": 1030,
"message": "The maximum number of licenses for user for this product has been reached. Other licenses which contain this user: .",
"help": ""
},
{
"id": 2007,
"message": "Unknown legacy license key.",
"help": ""
},
{
"id": 2009,
"message": "Unknown license type.",
"help": ""
},
{
"id": 2017,
"message": "The start date must be earlier than the expiration date.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
},
{
"id": 3001,
"message": "Unknown product feature.",
"help": ""
},
{
"id": 3002,
"message": "Unknown product variable.",
"help": ""
},
{
"id": 3003,
"message": "Unknown product limitation.",
"help": ""
},
{
"id": 4000,
"message": "Unknown customer.",
"help": ""
},
{
"id": 6023,
"message": "The start date of an exception must be earlier than the end date.",
"help": null
},
{
"id": 8001,
"message": "Unknown template (edition) name.",
"help": ""
},
{
"id": 8002,
"message": "Switching to an edition with a different provisioning mode is not allowed.",
"help": ""
},
{
"id": 8003,
"message": "A non-temporary license cannot be converted to a temporary license, or vice-versa.",
"help": ""
},
{
"id": 9003,
"message": "The expiration date is not valid. Supported formats: mm/dd/yyyy, dd.mm.yyyy, yyyy-mm-dd,yyyy-mm-dd, yyyy-MM-dd(THH:mm:ssZ)",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"patch": {
"tags": [
"License"
],
"summary": "Updates a license",
"operationId": "UpdateLicense",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "apply_template_properties",
"in": "query",
"description": "Set to true to apply template values for any missing properties.",
"schema": {
"type": "boolean",
"nullable": true
},
"x-position": 3
}
],
"requestBody": {
"x-name": "licenseDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddOrUpdateLicenseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 1004,
"message": "Unknown software release limitation. If you want to reset the productSoftwareReleaseLimitation, then use productSoftwareReleaseLimitation= 'none' or productSoftwareReleaseLimitation= ''.",
"help": ""
},
{
"id": 1005,
"message": "A license with this legacy license key already exists.",
"help": ""
},
{
"id": 1009,
"message": "The maximum number of users () for this license has been reached.",
"help": ""
},
{
"id": 1030,
"message": "The maximum number of licenses for user for this product has been reached. Other licenses which contain this user: .",
"help": ""
},
{
"id": 2007,
"message": "Unknown legacy license key.",
"help": ""
},
{
"id": 2009,
"message": "Unknown license type.",
"help": ""
},
{
"id": 2017,
"message": "The start date must be earlier than the expiration date.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
},
{
"id": 3001,
"message": "Unknown product feature.",
"help": ""
},
{
"id": 3002,
"message": "Unknown product variable.",
"help": ""
},
{
"id": 3003,
"message": "Unknown product limitation.",
"help": ""
},
{
"id": 4000,
"message": "Unknown customer.",
"help": ""
},
{
"id": 6023,
"message": "The start date of an exception must be earlier than the end date.",
"help": null
},
{
"id": 8001,
"message": "Unknown template (edition) name.",
"help": ""
},
{
"id": 8002,
"message": "Switching to an edition with a different provisioning mode is not allowed.",
"help": ""
},
{
"id": 8003,
"message": "A non-temporary license cannot be converted to a temporary license, or vice-versa.",
"help": ""
},
{
"id": 9003,
"message": "The expiration date is not valid. Supported formats: mm/dd/yyyy, dd.mm.yyyy, yyyy-mm-dd,yyyy-mm-dd, yyyy-MM-dd(THH:mm:ssZ)",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}": {
"get": {
"tags": [
"License"
],
"summary": "Returns a license",
"operationId": "GetLicense",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
},
"delete": {
"tags": [
"License"
],
"summary": "Deletes a license",
"operationId": "DeleteLicense",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/toggle": {
"patch": {
"tags": [
"License"
],
"summary": "Toggles the state of a license",
"operationId": "ToggleLicenseStateAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/xml": {
"get": {
"tags": [
"License"
],
"summary": "Downloads an XML license file",
"operationId": "DownloadLicenseFileXml",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "token_key",
"in": "query",
"schema": {
"type": "string",
"format": "uuid",
"nullable": true
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Xml Document",
"content": {
"application/xml": {
"example": "This function will return a xml file."
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/opensessions": {
"get": {
"tags": [
"License"
],
"summary": "Returns all open sessions",
"operationId": "GetOpenSessionsAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/opensessions/close": {
"post": {
"tags": [
"License"
],
"summary": "Closes all open sessions for a license",
"operationId": "CloseAllSessionsAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "requestDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloseAllSessionsRequestDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/filtered": {
"post": {
"tags": [
"License"
],
"summary": "Returns all licenses matching a filter setting (light)",
"operationId": "GetLicensesByFilterSettings",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "filter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseFilterDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseLazyLoadDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/filtered/detailed": {
"post": {
"tags": [
"License"
],
"summary": "Returns all licenses matching a filter setting (detailed)",
"operationId": "GetLicensesByFilter",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "filter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseFilterDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/assignments": {
"get": {
"tags": [
"License"
],
"summary": "Returns all license assignments",
"operationId": "GetLicenseAssignments",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "sort_option",
"in": "query",
"schema": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/DevicesSortEnum"
}
]
},
"x-position": 3
},
{
"name": "descending",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
},
"x-position": 4
},
{
"name": "include_analytical_heartbeats",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
},
"x-position": 5
},
{
"name": "operating_systems",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"x-position": 6
},
{
"name": "version_number",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"x-position": 7
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
},
"x-position": 8
},
{
"name": "page_size",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"nullable": true
},
"x-position": 9
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceLicenseAssignmentDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
},
"put": {
"tags": [
"License"
],
"summary": "Updates a license assignment",
"operationId": "UpdateAssignmentAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "assignment",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceLicenseAssignmentDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceLicenseAssignmentDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/assignments/{assignment_id}": {
"get": {
"tags": [
"License"
],
"summary": "Returns a license assignment",
"operationId": "GetAssignmentAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "assignment_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceLicenseAssignmentDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"License"
],
"summary": "Deletes a license assignment",
"operationId": "DeleteLicenseAssignment",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "assignment_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceLicenseAssignmentDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/usergroups": {
"get": {
"tags": [
"License"
],
"summary": "Returns all user groups",
"operationId": "GetLicenseUserGroupsAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetLicenseUsersErrorExamples"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseUserGroupDto"
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"License"
],
"summary": "Creates a license user group",
"description": "More information about named user licenses",
"operationId": "AddLicenseUserGroupAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "licenseUserGroupDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUserGroupDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUserGroupDto"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"patch": {
"tags": [
"License"
],
"summary": "Updates a license user group",
"description": "More information about named user licenses",
"operationId": "UpdateLicenseUserGroupAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "licenseUserGroupDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUserGroupDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUserGroupDto"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/usergroups/{user_group_id}": {
"delete": {
"tags": [
"License"
],
"summary": "Deletes a license user group",
"description": "More information about named user licenses",
"operationId": "DeleteLicenseUserGroupAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "user_group_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
},
{
"name": "remove_users",
"in": "query",
"schema": {
"type": "boolean"
},
"x-position": 4
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUserGroupDto"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/users": {
"get": {
"tags": [
"License"
],
"summary": "Returns license users",
"description": "More information about named user licenses",
"operationId": "GetLicenseUsersAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetLicenseUsersErrorExamples"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseUserDto"
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"License"
],
"summary": "Creates a license user",
"description": "More information about named user licenses",
"operationId": "AddLicenseUserAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"x-position": 3
}
],
"requestBody": {
"x-name": "licenseUserDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUserDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddLicenseUserErrorExamples"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 1008,
"message": "A user with this user id already exists.",
"help": ""
},
{
"id": 1009,
"message": "The maximum number of users (0) for this license has been reached.",
"help": ""
},
{
"id": 1014,
"message": "Invalid User ID format",
"help": ""
},
{
"id": 1030,
"message": "The maximum number of licenses for user for this product has been reached. Other licenses which contain this user: .",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUserDto"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"patch": {
"tags": [
"License"
],
"summary": "Updates a license user",
"description": "More information about named user licenses",
"operationId": "UpdateLicenseUserAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"x-position": 3
}
],
"requestBody": {
"x-name": "licenseUserDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUserDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLicenseUserErrorExamples"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 1009,
"message": "The maximum number of users (0) for this license has been reached.",
"help": ""
},
{
"id": 1010,
"message": "Unknown license user.",
"help": ""
},
{
"id": 1030,
"message": "The maximum number of licenses for user for this product has been reached. Other licenses which contain this user: .",
"help": ""
},
{
"id": 12008,
"message": "Active Sessions detected",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUserDto"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/users/{user_id}": {
"delete": {
"tags": [
"License"
],
"summary": "Deletes a license user",
"description": "More information about named user licenses",
"operationId": "DeleteLicenseUserAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"x-position": 2
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemoveLicenseUsersErrorExamples"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 1010,
"message": "Unknown license user.",
"help": ""
},
{
"id": 12008,
"message": "Active Sessions detected",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUserDto"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated": true,
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/users/bulk-delete": {
"post": {
"tags": [
"License"
],
"summary": "Deletes many license users",
"description": "More information about named user licenses",
"operationId": "DeleteLicenseUsersAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "user_ids",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemoveLicenseUsersErrorExamples"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 1010,
"message": "Unknown license user.",
"help": ""
},
{
"id": 12008,
"message": "Active Sessions detected",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkDeleteUserResultDto"
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/types": {
"get": {
"tags": [
"License"
],
"summary": "Returns all license types",
"operationId": "GetLicenseTypes",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "name",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseTypeDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
},
"post": {
"tags": [
"License"
],
"summary": "Creates a license type",
"operationId": "AddLicenseType",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "type",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseTypeDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseTypeDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"patch": {
"tags": [
"License"
],
"summary": "Updates a license type",
"operationId": "UpdateLicenseType",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "type",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseTypeDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseTypeDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/types/{type_id}/new_type/{new_type_id}": {
"delete": {
"tags": [
"License"
],
"summary": "Deletes a license type",
"operationId": "RemoveLicenseType",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "type_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "new_type_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseTypeDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/tags": {
"get": {
"tags": [
"License"
],
"summary": "Returns all license tags",
"operationId": "GetLicenseTagAssignments",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemTagAssignmentDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
},
"put": {
"tags": [
"License"
],
"summary": "Updates the tags of a license",
"operationId": "UpdateLicenseTagAssignments",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "tagAssignmentDtos",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemTagAssignmentDto"
}
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemTagAssignmentDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/history": {
"get": {
"tags": [
"License"
],
"summary": "Returns the entire history of a license",
"operationId": "GetAllLicenseHistory",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/history/{history_id}": {
"get": {
"tags": [
"License"
],
"summary": "Returns a specific license snapshot",
"operationId": "GetLicenseHistory",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "history_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HistoryDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/consumption/heartbeats": {
"get": {
"tags": [
"License"
],
"summary": "Returns all consumption heartbeats",
"description": "More information about consumption based aspects",
"operationId": "GetConsumptionHeartbeats",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "transaction_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid",
"nullable": true
},
"x-position": 3
},
{
"name": "user_id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 4
},
{
"name": "client_id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 5
},
{
"name": "date_from",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
},
"x-position": 6
},
{
"name": "date_to",
"in": "query",
"schema": {
"type": "string",
"format": "date-time",
"nullable": true
},
"x-position": 7
},
{
"name": "limitations",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"x-position": 8
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsumptionHeartbeatLazyLoadDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/consumption/balance": {
"get": {
"tags": [
"License"
],
"summary": "Returns a consumption balance",
"description": "More information about consumption based aspects",
"operationId": "GetConsumptionBalance",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "include_last_transaction_id",
"x-originalName": "includeLastTransactionId",
"in": "query",
"schema": {
"type": "boolean"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsumptionBalanceDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/consumption/balance/limitations/{limitation_id}/reset": {
"put": {
"tags": [
"License"
],
"summary": "Resets a consumption balance",
"description": "More information about consumption based aspects",
"operationId": "ResetConsumptionBalance",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "limitation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/licenses/{license_id}/consumption/balance/limitations/{limitation_id}/recalculate": {
"put": {
"tags": [
"License"
],
"summary": "Recalculates a consumption balance",
"description": "More information about consumption based aspects",
"operationId": "RecalculateConsumptionBalance",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "limitation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/lookup/licenses": {
"post": {
"tags": [
"LookUp"
],
"summary": "Returns all available licenses for a specific customer",
"operationId": "LookupLicenses",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "lookupDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResultObjects"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/lookup/customer": {
"post": {
"tags": [
"LookUp"
],
"summary": "Customer lookup (name -> id)",
"operationId": "LookupCustomer",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "lookupDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupCustomerDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "uuid"
}
}
}
},
"204": {
"description": ""
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/lookup/product": {
"post": {
"tags": [
"LookUp"
],
"summary": "Product lookup (name -> id)",
"operationId": "LookupProduct",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "lookupDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupProductDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "uuid"
}
}
}
},
"204": {
"description": ""
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/notifications/configurations": {
"post": {
"tags": [
"Notification"
],
"summary": "Updates the email notification settings for the specified ISV.",
"operationId": "UpdateNotificationSettings",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "configurationDto",
"description": "The email configuration settings.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailConfigurationDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"get": {
"tags": [
"Notification"
],
"summary": "Gets the current email notification settings for the specified ISV.",
"operationId": "GetNotificationSettings",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailConfigurationDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/notifications/configurations/tests": {
"get": {
"tags": [
"Notification"
],
"summary": "Sends a test email to verify the email configuration for the specified ISV.",
"operationId": "SendTestEmail",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "to_email",
"in": "query",
"description": "The recipient email address.",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/notifications/emails": {
"post": {
"tags": [
"Notification"
],
"summary": "Sends a license-related email using the specified template and recipients.",
"operationId": "SendLicenseMail",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "licenseMailDto",
"description": "The license mail details including template and recipients.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseMailDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/notifications/useremailtemplates": {
"get": {
"tags": [
"Notification"
],
"summary": "Gets all user email templates for the specified ISV.",
"operationId": "GetAllUserEmailTemplates",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserEmailTemplateDto"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Notification"
],
"summary": "Adds a new user email template for the specified ISV.",
"operationId": "AddUserEmailTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "emailTemplate",
"description": "The user email template to add.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEmailTemplateDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEmailTemplateDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Notification"
],
"summary": "Updates an existing user email template for the specified ISV.",
"operationId": "UpdateUserEmailTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "emailTemplate",
"description": "The user email template to update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEmailTemplateDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEmailTemplateDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/notifications/useremailtemplates/{email_template_id}": {
"get": {
"tags": [
"Notification"
],
"summary": "Gets a specific user email template by its identifier.",
"operationId": "GetUserEmailTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "email_template_id",
"in": "path",
"required": true,
"description": "The email template identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEmailTemplateDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"patch": {
"tags": [
"Notification"
],
"summary": "Partially updates a user email template for the specified ISV.",
"operationId": "PatchUserEmailTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "email_template_id",
"in": "path",
"required": true,
"description": "The email template identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "emailTemplate",
"description": "The user email template with updated fields.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEmailTemplateDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEmailTemplateDto"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Notification"
],
"summary": "Deletes a user email template for the specified ISV.",
"operationId": "DeleteUserEmailTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "email_template_id",
"in": "path",
"required": true,
"description": "The email template identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/notifications/useremailtemplates/purpose/{purpose}": {
"get": {
"tags": [
"Notification"
],
"summary": "Gets user email templates by their purpose.",
"operationId": "GetUserEmailTemplatesByPurpose",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"description": "The ISV identifier.",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "purpose",
"in": "path",
"required": true,
"description": "The purpose of the email templates.",
"schema": {
"type": "string"
},
"x-position": 2
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserEmailTemplateDto"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Warning",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products": {
"get": {
"tags": [
"Product"
],
"summary": "Get all products",
"operationId": "GetAllProducts",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "name",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Product"
],
"summary": "Add a new product",
"operationId": "AddProduct",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "productDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Product"
],
"summary": "Update an existing product",
"operationId": "UpdateProduct",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "productDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}": {
"get": {
"tags": [
"Product"
],
"summary": "Get product by id",
"operationId": "GetProduct",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Product"
],
"summary": "Delete a product",
"operationId": "DeleteProduct",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/detail": {
"get": {
"tags": [
"Product"
],
"summary": "Get product details by id",
"operationId": "GetProductDetails",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductDetailsDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/features": {
"get": {
"tags": [
"Product"
],
"summary": "Get all features for a product",
"operationId": "GetAllFeatures",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeatureDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Product"
],
"summary": "Add a new feature to a product",
"operationId": "AddFeature",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "featureDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Product"
],
"summary": "Update an existing feature",
"operationId": "UpdateFeature",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "featureDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/features/{feature_id}": {
"get": {
"tags": [
"Product"
],
"summary": "Get a specific feature by ID",
"operationId": "GetFeatureById",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "feature_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Product"
],
"summary": "Delete a feature from a product",
"operationId": "DeleteFeature",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "feature_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/limitations": {
"get": {
"tags": [
"Product"
],
"summary": "Get all limitations for a product",
"operationId": "GetAllLimitations",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LimitationDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Product"
],
"summary": "Add a new limitation to a product",
"operationId": "AddLimitation",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "limitationDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitationDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitationDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Product"
],
"summary": "Update an existing limitation",
"operationId": "UpdateLimitation",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "limitationDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitationDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitationDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/limitations/{limitation_id}": {
"get": {
"tags": [
"Product"
],
"summary": "Get a specific limitation by ID",
"operationId": "GetLimitationById",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "limitation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitationDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Product"
],
"summary": "Delete a limitation from a product",
"operationId": "DeleteLimitation",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "limitation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/constrained_variables": {
"get": {
"tags": [
"Product"
],
"summary": "Get all constrained variables for a product",
"operationId": "GetAllConstrainedVariables",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConstrainedVariableDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Product"
],
"summary": "Add a new constrained variable to a product",
"operationId": "AddConstrainedVariable",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "constrainedVariableDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConstrainedVariableDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConstrainedVariableDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Product"
],
"summary": "Update an existing constrained variable",
"operationId": "UpdateConstrainedVariable",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "constrainedVariableDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConstrainedVariableDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConstrainedVariableDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/constrained_variables/{variable_id}": {
"get": {
"tags": [
"Product"
],
"summary": "Get a specific constrained variable by ID",
"operationId": "GetConstrainedVariableById",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "variable_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConstrainedVariableDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Product"
],
"summary": "Delete a constrained variable from a product",
"operationId": "DeleteConstrainedVariable",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "variable_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/variables": {
"get": {
"tags": [
"Product"
],
"summary": "Get all variables for a product",
"operationId": "GetAllVariables",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VariableDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Product"
],
"summary": "Add a new variable to a product",
"operationId": "AddVariable",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "variableDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariableDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariableDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Product"
],
"summary": "Update an existing variable",
"operationId": "UpdateVariable",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "variableDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariableDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariableDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/variables/{variable_id}": {
"get": {
"tags": [
"Product"
],
"summary": "Get a specific variable by ID",
"operationId": "GetVariableById",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "variable_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariableDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Product"
],
"summary": "Delete a variable from a product",
"operationId": "DeleteVariable",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "variable_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/email_templates": {
"get": {
"tags": [
"Product"
],
"summary": "Get all email templates for a product",
"operationId": "GetAllEmailTemplates",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailTemplateDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Product"
],
"summary": "Add a new email template to a product",
"operationId": "AddEmailTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "emailTemplateDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailTemplateDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailTemplateDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Product"
],
"summary": "Update an existing email template",
"operationId": "UpdateEmailTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "emailTemplateDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailTemplateDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailTemplateDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/email_templates/{email_template_id}": {
"get": {
"tags": [
"Product"
],
"summary": "Get a specific email template by ID",
"operationId": "GetEmailTemplateById",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "email_template_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailTemplateDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Product"
],
"summary": "Delete an email template from a product",
"operationId": "DeleteEmailTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "email_template_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/analytical_fields": {
"get": {
"tags": [
"Product"
],
"summary": "Get all analytical fields for a product",
"operationId": "GetAllAnalyticalFields",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AnalyticalFieldDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Product"
],
"summary": "Add a new analytical field to a product",
"operationId": "AddAnalyticalField",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "analyticalFieldDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticalFieldDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticalFieldDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Product"
],
"summary": "Update an existing analytical field",
"operationId": "UpdateAnalyticalField",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "analyticalFieldDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticalFieldDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticalFieldDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/analytical_fields/{analytical_field_id}": {
"get": {
"tags": [
"Product"
],
"summary": "Get a specific analytical field by ID",
"operationId": "GetAnalyticalFieldById",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "analytical_field_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticalFieldDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Product"
],
"summary": "Delete an analytical field from a product",
"operationId": "DeleteAnalyticalField",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "analytical_field_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/usage_modules": {
"get": {
"tags": [
"Product"
],
"summary": "Get all usage modules for a product",
"operationId": "GetAllUsageModules",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageModuleDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Product"
],
"summary": "Add a new usage module to a product",
"operationId": "AddUsageModule",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "usageModuleDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageModuleDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageModuleDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Product"
],
"summary": "Update an existing usage module",
"operationId": "UpdateUsageModule",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "usageModuleDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageModuleDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageModuleDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/usage_modules/{usage_module_id}": {
"get": {
"tags": [
"Product"
],
"summary": "Get a specific usage module by ID",
"operationId": "GetUsageModuleById",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "usage_module_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageModuleDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Product"
],
"summary": "Delete a usage module from a product",
"operationId": "DeleteUsageModule",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "usage_module_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/usage_features": {
"get": {
"tags": [
"Product"
],
"summary": "Get all usage features for a product",
"operationId": "GetAllUsageFeatures",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageFeatureDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Product"
],
"summary": "Add a new usage feature to a product",
"operationId": "AddUsageFeature",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "usageFeatureDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageFeatureDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageFeatureDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Product"
],
"summary": "Update an existing usage feature",
"operationId": "UpdateUsageFeature",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "usageFeatureDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageFeatureDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageFeatureDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/usage_features/{usage_feature_id}": {
"get": {
"tags": [
"Product"
],
"summary": "Get a specific usage feature by ID",
"operationId": "GetUsageFeatureById",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "usage_feature_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageFeatureDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Product"
],
"summary": "Delete a usage feature from a product",
"operationId": "DeleteUsageFeature",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "usage_feature_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/software_shipment_properties": {
"get": {
"tags": [
"Product"
],
"summary": "Get all software shipment properties for a product",
"operationId": "GetAllSoftwareShipmentProperties",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductSoftwareShipmentPropertyDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Product"
],
"summary": "Add a new software shipment property to a product",
"operationId": "AddSoftwareShipmentProperty",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "defaultValue",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 4
}
],
"requestBody": {
"x-name": "propertyDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductSoftwareShipmentPropertyDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductSoftwareShipmentPropertyDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Product"
],
"summary": "Update an existing software shipment property",
"operationId": "UpdateSoftwareShipmentProperty",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "propertyDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductSoftwareShipmentPropertyDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductSoftwareShipmentPropertyDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/software_shipment_properties/{property_id}": {
"get": {
"tags": [
"Product"
],
"summary": "Get a specific software shipment property by ID",
"operationId": "GetSoftwareShipmentPropertyById",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "property_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductSoftwareShipmentPropertyDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Product"
],
"summary": "Delete a software shipment property from a product",
"operationId": "DeleteSoftwareShipmentProperty",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "property_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/software_release_limitations": {
"get": {
"tags": [
"Product"
],
"summary": "Get all software release limitations for a product",
"operationId": "GetAllSoftwareReleaseLimitations",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Product"
],
"summary": "Add a new software release limitation to a product",
"operationId": "AddSoftwareReleaseLimitation",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "softwareReleaseLimitationDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Product"
],
"summary": "Update an existing software release limitation",
"operationId": "UpdateSoftwareReleaseLimitation",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "softwareReleaseLimitationDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/software_release_limitations/{software_release_limitation_id}": {
"get": {
"tags": [
"Product"
],
"summary": "Get a specific software release limitation by ID",
"operationId": "GetSoftwareReleaseLimitationById",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "software_release_limitation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Product"
],
"summary": "Delete a software release limitation from a product",
"operationId": "DeleteSoftwareReleaseLimitation",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "software_release_limitation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
},
{
"name": "new_software_release_limitation_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid",
"nullable": true
},
"x-position": 4
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/software_release_limitations/{software_release_limitation_id}/software_shipments": {
"get": {
"tags": [
"Product"
],
"summary": "Get all software shipments for a product and software release limitation",
"operationId": "GetAllSoftwareShipments",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "software_release_limitation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SoftwareShipmentDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Product"
],
"summary": "Add a new software shipment to a product and software release limitation",
"operationId": "AddSoftwareShipment",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "software_release_limitation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"requestBody": {
"x-name": "softwareShipmentDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SoftwareShipmentDto"
}
}
},
"required": true,
"x-position": 4
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SoftwareShipmentDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Product"
],
"summary": "Update an existing software shipment",
"operationId": "UpdateSoftwareShipment",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "software_release_limitation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"requestBody": {
"x-name": "softwareShipmentDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SoftwareShipmentDto"
}
}
},
"required": true,
"x-position": 4
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SoftwareShipmentDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/software_release_limitations/{software_release_limitation_id}/software_shipments/{software_shipment_id}": {
"get": {
"tags": [
"Product"
],
"summary": "Get a specific software shipment by ID",
"operationId": "GetSoftwareShipmentById",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "software_release_limitation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
},
{
"name": "software_shipment_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 4
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SoftwareShipmentDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Product"
],
"summary": "Delete a software shipment from a product and software release limitation",
"operationId": "DeleteSoftwareShipment",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "software_release_limitation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
},
{
"name": "software_shipment_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 4
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"204": {
"description": "No content"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/export": {
"get": {
"tags": [
"Product"
],
"summary": "Export a full product",
"operationId": "ExportFullProduct",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/import": {
"post": {
"tags": [
"Product"
],
"summary": "Import a product from file",
"operationId": "ImportProductFromFile",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"product": {
"type": "string",
"format": "binary",
"nullable": true
}
}
}
}
}
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FullProductDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/products/{product_id}/history": {
"get": {
"tags": [
"Product"
],
"summary": "Get the history of a product",
"operationId": "GetProductHistoryAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/provisioning/activations": {
"post": {
"tags": [
"Provisioning"
],
"summary": "Activates a client (assigns a token to a client)",
"description": "Typically used in named device scenarios. More Information.",
"operationId": "ActivateLicense",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "device",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivateClientDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivateLicenseResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 1001,
"message": "The license is expired.",
"help": ""
},
{
"id": 1002,
"message": "The license is inactive.",
"help": ""
},
{
"id": 1003,
"message": "Non compliant software version.",
"help": ""
},
{
"id": 1004,
"message": "Unsupported version format. Supported is numerical with '.' separator, e.g., 20 or 20.1 or 20.1.3 .",
"help": ""
},
{
"id": 1013,
"message": "This client is already activated and cannot be reassigned.",
"help": ""
},
{
"id": 2000,
"message": "This master license has no available tokens. You can either add token(s) to this license or unassign some existing token(s).",
"help": ""
},
{
"id": 2001,
"message": "Token already assigned.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseInfoDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/provisioning/activations/offline": {
"get": {
"tags": [
"Provisioning"
],
"summary": "Activates an offline client (assigns a token to a offline client)",
"description": "Typically used in offline device scenarios. More Information.",
"operationId": "ActivateOfflineLicense",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "license_key",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 3
},
{
"name": "client_id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 4
},
{
"name": "client_name",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 5
},
{
"name": "client_description",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 6
},
{
"name": "software_version",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 7
},
{
"name": "tags",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"x-position": 8
},
{
"name": "file_name",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 9
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Xml Document",
"content": {
"application/xml": {
"example": "This function will return a xml file."
}
}
}
}
}
},
"/api/v2/isv/{isv_id}/provisioning/heartbeats": {
"post": {
"tags": [
"Provisioning"
],
"summary": "Creates a license heartbeat",
"description": "More Information.",
"operationId": "AddHeartbeat",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "heartbeatDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddHeartbeatDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeartbeatResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 2002,
"message": "This token is not assigned.",
"help": ""
},
{
"id": 2003,
"message": "Unknown token license key.",
"help": ""
},
{
"id": 2006,
"message": "Unknown client.",
"help": ""
},
{
"id": 2018,
"message": "This token is suspended.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
},
{
"id": 5000,
"message": "This client is assigned to a different token license key. Use the correct or no token license key.",
"help": ""
},
{
"id": 5001,
"message": "Unknown heartbeat type.",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseInfoDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/provisioning/licenses/by_customer": {
"post": {
"tags": [
"Provisioning"
],
"summary": "Returns all licenses of a customer",
"description": "Typically used in SaaS scenarios. More Information.",
"operationId": "GetLicensesByCustomerAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "getLicensesByCustomerDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetLicensesByCustomerDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicensesByCustomerErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 3000,
"message": "Unknown product.",
"help": ""
},
{
"id": 4000,
"message": "Unknown customer.",
"help": ""
},
{
"id": 4001,
"message": "No available licenses for this customer. Create a new license or add tokens to an existing license.",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/provisioning/licenses/by_user": {
"post": {
"tags": [
"Provisioning"
],
"summary": "Returns all licenses of a named user",
"description": "Typically used in SaaS/Web scenarios. More Information.",
"operationId": "GetLicensesByUserAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "getLicensesByUserDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetLicensesByUserDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicensesByUserErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1010,
"message": "Unknown license user.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
},
{
"id": 4001,
"message": "No available licenses for this customer. Create a new license or add tokens to an existing license.",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/provisioning/licenses/by_license": {
"post": {
"tags": [
"Provisioning"
],
"summary": "Returns all licenses of a (legacy) key",
"description": "Typically used in order to map a license/key/subscription of a backoffice system to the SLASCONE license. More Information.",
"operationId": "GetLicensesByLicenseKeyAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "getLicensesByLicenseKeyDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetLicensesByLicenseKeyDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicensesByKeyErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/provisioning/unassign": {
"post": {
"tags": [
"Provisioning"
],
"summary": "Unassigns a token from a client",
"description": "Typically used in named device scenarios. More Information.",
"operationId": "UnassignLicense",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "unassign_dto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnassignDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeactivateDeviceLicenseResponseError"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 2003,
"message": "Unknown token license key.",
"help": ""
},
{
"id": 2004,
"message": "This token key is already unassigned.",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/provisioning/validate": {
"post": {
"tags": [
"Provisioning"
],
"summary": "Checks the validity of a license",
"description": "Checks the validity of a license.",
"operationId": "GetDeviceInfo",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "license",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateLicenseDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAssignmentsErrorExamples"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1002,
"message": "The license is inactive.",
"help": ""
},
{
"id": 2000,
"message": "This master license has no available tokens. You can either add token(s) to this license or unassign some existing token(s).",
"help": ""
},
{
"id": 2012,
"message": "Supported for named device licenses only.",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseInfoDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/provisioning/validate/consumption": {
"post": {
"tags": [
"Provisioning"
],
"summary": "Checks the consumption status of a limitation",
"description": "More Information.",
"operationId": "GetConsumptionStatus",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "consumptionStatusDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateConsumptionStatusDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetConsumptionStatusErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 2006,
"message": "Unknown client.",
"help": ""
},
{
"id": 6009,
"message": "The consumption mode is disabled.",
"help": ""
},
{
"id": 6019,
"message": "This limitation does not exist.",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsumptionDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/provisioning/licenses/state/toggle": {
"post": {
"tags": [
"Provisioning"
],
"summary": "Toggles the license state (active/inactive)",
"description": "Toggles the license state (active/inactive).",
"operationId": "ToogleLicenseStateAsync",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "toggleLicenseStateDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ToggleLicenseStateDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ToggleLicenseStateErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 1001,
"message": "The license is expired.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseStateDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/provisioning/session/open": {
"post": {
"tags": [
"Provisioning"
],
"summary": "Opens a (floating) session",
"description": "More Information.",
"operationId": "OpenSession",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "sessionRequestDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRequestDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpenSessionErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 1001,
"message": "The license is expired.",
"help": ""
},
{
"id": 1001,
"message": "The license is expired.",
"help": ""
},
{
"id": 1002,
"message": "The license is inactive.",
"help": ""
},
{
"id": 1002,
"message": "The license is inactive.",
"help": ""
},
{
"id": 1007,
"message": "The number of allowed connections has been reached.",
"help": ""
},
{
"id": 1007,
"message": "The number of allowed connections has been reached.",
"help": ""
},
{
"id": 1009,
"message": "The maximum number of users () for this license has been reached.",
"help": ""
},
{
"id": 1010,
"message": "Unknown license user.",
"help": ""
},
{
"id": 1014,
"message": "Invalid User ID format",
"help": ""
},
{
"id": 1030,
"message": "The maximum number of licenses for user for this product has been reached. Other licenses which contain this user: .",
"help": ""
},
{
"id": 2001,
"message": "Token already assigned.",
"help": ""
},
{
"id": 2002,
"message": "This token is not assigned.",
"help": ""
},
{
"id": 2004,
"message": "This token key is already unassigned.",
"help": ""
},
{
"id": 2006,
"message": "Unknown client.",
"help": ""
},
{
"id": 2010,
"message": "Missing unique device/client id.",
"help": ""
},
{
"id": 2013,
"message": "Missing client id.",
"help": "The edition of the new license requires a client id for activation of the license."
},
{
"id": 2015,
"message": "Unknown token key.",
"help": ""
},
{
"id": 2018,
"message": "This token is suspended.",
"help": ""
},
{
"id": 3000,
"message": "Unknown product.",
"help": ""
},
{
"id": 6006,
"message": "Unknown license limitation.",
"help": ""
},
{
"id": 12000,
"message": "The provisioning mode of this license is set to Named. Sessions need the provisioning mode to be Floating.",
"help": ""
},
{
"id": 12000,
"message": "The provisioning mode of this license is set to Named. Sessions need the provisioning mode to be Floating.",
"help": ""
},
{
"id": 12001,
"message": "No open session(s) were found.",
"help": ""
},
{
"id": 12002,
"message": "The maximum number of floating sessions with same client has been reached. Cannot open an additional session.",
"help": ""
},
{
"id": 12002,
"message": "The maximum number of floating sessions with same client has been reached. Cannot open an additional session.",
"help": ""
},
{
"id": 12003,
"message": "The checkout period has to be a positive number (in minutes).",
"help": ""
},
{
"id": 12003,
"message": "The checkout period has to be a positive number (in minutes).",
"help": ""
},
{
"id": 12004,
"message": "A user id is mandatory for this license type",
"help": ""
},
{
"id": 12004,
"message": "A user id is mandatory for this license type",
"help": ""
},
{
"id": 12005,
"message": "A session id is mandatory for this license type",
"help": ""
},
{
"id": 12005,
"message": "A session id is mandatory for this license type",
"help": ""
},
{
"id": 12006,
"message": "The number of allowed sessions for this user has been reached",
"help": ""
},
{
"id": 12006,
"message": "The number of allowed sessions for this user has been reached",
"help": ""
},
{
"id": 12007,
"message": "Unknown user",
"help": ""
},
{
"id": 12007,
"message": "Unknown user",
"help": ""
},
{
"id": 12008,
"message": "Active Sessions detected",
"help": ""
},
{
"id": 12009,
"message": "A session for this user/client already exists",
"help": ""
},
{
"id": 12009,
"message": "A session for this user/client already exists",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionStatusDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/provisioning/session/close": {
"post": {
"tags": [
"Provisioning"
],
"summary": "Closes a (floating) session",
"description": "More Information.",
"operationId": "CloseSession",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "sessionRequestDto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRequestDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloseSessionErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1000,
"message": "The input is not a valid license key.",
"help": ""
},
{
"id": 2006,
"message": "Unknown client.",
"help": ""
},
{
"id": 12000,
"message": "The provisioning mode of this license is set to Named. Sessions need the provisioning mode to be Floating.",
"help": ""
},
{
"id": 12001,
"message": "No open session(s) were found.",
"help": ""
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/provisioning/licenses/{license_id}/tokens/floating/active/count": {
"get": {
"tags": [
"Provisioning"
],
"summary": "Returns the number of actively used floating tokens.",
"description": "More Information.",
"operationId": "GetActiveFloatingTokensCount",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "license_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers": {
"get": {
"tags": [
"Reseller"
],
"summary": "Returns all resellers",
"operationId": "GetAllResellers",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "name",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResellerDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Reseller"
],
"summary": "Creates a reseller",
"operationId": "AddReseller",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "reseller",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"patch": {
"tags": [
"Reseller"
],
"summary": "Updates a reseller",
"operationId": "UpdateReseller",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "reseller",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/by_user": {
"get": {
"tags": [
"Reseller"
],
"summary": "Returns all resellers of the logged in user",
"operationId": "GetResellerByUser",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/light": {
"get": {
"tags": [
"Reseller"
],
"summary": "Returns all resellers with reduced information",
"operationId": "GetAllResellersLight",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResellerLightDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/filtered": {
"post": {
"tags": [
"Reseller"
],
"summary": "Returns all resellers matching a filter",
"operationId": "GetFilteredResellers",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "resellerFilter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerFilterDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerLazyLoadDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/{reseller_id}": {
"get": {
"tags": [
"Reseller"
],
"summary": "Returns a reseller",
"operationId": "GetReseller",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "reseller_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Reseller"
],
"summary": "Deletes a reseller",
"operationId": "DeleteReseller",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "reseller_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResellerDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/number/{reseller_number}": {
"get": {
"tags": [
"Reseller"
],
"summary": "Returns a reseller (deprecated; use api/v{version:apiVersion}/isv/{isv_id}/resellers/by_number instead)",
"operationId": "Reseller_GetResellerByResellerNumberDeprecated",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "reseller_number",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerDto"
}
}
}
}
},
"deprecated": true,
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/by_number": {
"get": {
"tags": [
"Reseller"
],
"summary": "Returns a reseller",
"operationId": "GetResellerByNumber",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "reseller_number",
"in": "query",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/{reseller_id}/contacts": {
"get": {
"tags": [
"Reseller"
],
"summary": "Returns a reseller's contacts",
"operationId": "GetResellerContacts",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "reseller_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResellerContactDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Reseller"
],
"summary": "Creates a reseller contact",
"operationId": "AddResellerContact",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "reseller_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "contact",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerContactDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerContactDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"patch": {
"tags": [
"Reseller"
],
"summary": "Updates a reseller contact",
"operationId": "UpdateResellerContact",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "reseller_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"requestBody": {
"x-name": "contact",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerContactDto"
}
}
},
"required": true,
"x-position": 3
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerContactDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/{reseller_id}/contacts/{contact_id}": {
"put": {
"tags": [
"Reseller"
],
"summary": "Toggles a reseller contact state",
"operationId": "ToggleResellerContactState",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "reseller_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "contact_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerContactDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Reseller"
],
"summary": "Deletes a reseller contact",
"operationId": "DeleteResellerContact",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "reseller_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "contact_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
},
{
"name": "remove_identity",
"in": "query",
"schema": {
"type": "boolean",
"default": true
},
"x-position": 4
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerContactDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/contacts": {
"get": {
"tags": [
"Reseller"
],
"summary": "Returns a reseller contact",
"operationId": "GetResellerContactByUserId",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResellerContactDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/{reseller_id}/contacts/email/{contact_id}": {
"get": {
"tags": [
"Reseller"
],
"summary": "Sends a new invitation email to a reseller contact",
"description": "A first invitation is send during creation of a contact",
"operationId": "ResendResellerContactInvitation",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "reseller_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "contact_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success"
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/{reseller_id}/templates": {
"get": {
"tags": [
"Reseller"
],
"summary": "Returns all available product templates (editions) for a reseller",
"operationId": "GetResellerTemplates",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "reseller_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResellerTemplateDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/templates": {
"post": {
"tags": [
"Reseller"
],
"summary": "Grants access to a product templates (edition)",
"operationId": "AddResellerTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "resellerTemplate",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerTemplateDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerTemplateDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"put": {
"tags": [
"Reseller"
],
"summary": "Updates access to a product templates (edition)",
"operationId": "UpdateResellerTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "resellerTemplate",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerTemplateDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerTemplateDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/{reseller_id}/templates/{template_id}": {
"delete": {
"tags": [
"Reseller"
],
"summary": "Revokes access to a product templates (edition)",
"operationId": "DeleteResellerTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "reseller_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "template_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerTemplateDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/types": {
"get": {
"tags": [
"Reseller"
],
"summary": "Returns all reseller types",
"operationId": "GetResellerTypes",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "name",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResellerTypeDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Reseller"
],
"summary": "Creates a reseller type",
"operationId": "AddResellerType",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "type",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerTypeDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerTypeDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"patch": {
"tags": [
"Reseller"
],
"summary": "Updates a reseller type",
"operationId": "UpdateResellerType",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "type",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerTypeDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerTypeDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/types/{type_id}/new_type/{new_type_id}": {
"delete": {
"tags": [
"Reseller"
],
"summary": "Deletes a reseller type",
"operationId": "RemoveResellerType",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "type_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "new_type_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResellerTypeDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/resellers/count": {
"get": {
"tags": [
"Reseller"
],
"summary": "Returns the number of all resellers",
"operationId": "GetResellerCount",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"204": {
"description": "No content"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/roles": {
"get": {
"tags": [
"Roles"
],
"summary": "Get user roles and last active context for the authenticated user.",
"operationId": "Get user roles and last active context",
"parameters": [
{
"name": "isv_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid",
"nullable": true
},
"x-position": 1
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRolesDto"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/v2/roles/complete": {
"get": {
"tags": [
"Roles"
],
"summary": "Get user roles and last active context for the authenticated user.",
"operationId": "Get all user roles and last active context",
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRolesDto"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/v2/roles/context": {
"post": {
"tags": [
"Roles"
],
"summary": "Get user role for the authenticated user in the specified ISV context.",
"operationId": "Switch user context",
"requestBody": {
"x-name": "userRoleContext",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRoleContextDto"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success"
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": []
}
]
}
},
"/api/v2/isv/{isv_id}/templates": {
"get": {
"tags": [
"Template"
],
"summary": "Returns all templates (editions)",
"operationId": "GetAllTemplates",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "product_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "name",
"in": "query",
"schema": {
"type": "string",
"nullable": true
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"post": {
"tags": [
"Template"
],
"summary": "Creates a template (edition)",
"operationId": "AddTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "template",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"patch": {
"tags": [
"Template"
],
"summary": "Updates a template (edition)",
"operationId": "UpdateTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
}
],
"requestBody": {
"x-name": "template",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateDto"
}
}
},
"required": true,
"x-position": 2
},
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTemplateResponseErrors"
},
"example": {
"id": 0,
"message": null,
"help": null,
"expectedErrors": [
{
"id": 1020,
"message": "The value list must not be empty or contain only empty values",
"help": ""
},
{
"id": 1021,
"message": "One or more invalid items in the value list.",
"help": "The option variable is in restricted mode and allows only values from the custom list."
},
{
"id": 1022,
"message": "Invalid number of items in the value list.",
"help": "The option variable is in single select mode and allows only one value."
}
]
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/templates/{template_id}/clone": {
"post": {
"tags": [
"Template"
],
"summary": "Duplicates a template (edition)",
"operationId": "CloneTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "template_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/templates/{template_id}": {
"get": {
"tags": [
"Template"
],
"summary": "Returns a template (edition)",
"operationId": "GetTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "template_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
},
"delete": {
"tags": [
"Template"
],
"summary": "Deletes a template (edition)",
"operationId": "DeleteTemplate",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "template_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "new_template_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/templates/{template_id}/history": {
"get": {
"tags": [
"Template"
],
"summary": "Returns the entire audit history of a template (edition)",
"operationId": "GetTemplateHistory",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "template_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryDto"
}
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
},
"/api/v2/isv/{isv_id}/templates/{template_id}/history/{history_id}": {
"get": {
"tags": [
"Template"
],
"summary": "Returns a specific template (edition) audit history snapshot",
"operationId": "GetTemplateHistoryDetail",
"parameters": [
{
"name": "isv_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 1
},
{
"name": "template_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 2
},
{
"name": "history_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"x-position": 3
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"422": {
"description": "Unprocessable content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
},
"504": {
"description": "Gateway timeout"
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonErrorResponse"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HistoryDto"
}
}
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
}
]
}
}
},
"components": {
"schemas": {
"AbstractEmailTemplateDtoOfEmailTemplateDto": {
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"language": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"body": {
"type": "string",
"nullable": true
},
"parent_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sub_email_templates": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/EmailTemplateDto"
}
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"AbstractEmailTemplateDtoOfUserEmailTemplateDto": {
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"language": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"body": {
"type": "string",
"nullable": true
},
"parent_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sub_email_templates": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/UserEmailTemplateDto"
}
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"ActivateClientDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"license_key",
"client_id"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"license_key": {
"type": "string",
"minLength": 1
},
"client_id": {
"type": "string",
"minLength": 1
},
"client_name": {
"type": "string",
"nullable": true
},
"client_description": {
"type": "string",
"nullable": true
},
"software_version": {
"type": "string",
"nullable": true
},
"timestamp_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"tags": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"ActivateLicenseResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"ActivationUponLicenseCreation": {
"type": "integer",
"description": "",
"x-enumNames": [
"TokenKey",
"CustomerNumber",
"CustomerEmail",
"LegacyKey",
"ClientId",
"LicenseId"
],
"enum": [
0,
1,
2,
3,
4,
5
]
},
"AddHeartbeatDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"client_id",
"software_version",
"operating_system"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"client_id": {
"type": "string",
"minLength": 1
},
"user_id": {
"type": "string",
"nullable": true
},
"software_version": {
"type": "string",
"minLength": 1
},
"operating_system": {
"type": "string",
"minLength": 1
},
"token_key": {
"type": "string",
"format": "uuid",
"nullable": true
},
"group_id": {
"type": "string",
"nullable": true
},
"heartbeat_type_id": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
},
"AddLicenseUserErrorExamples": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"AddOrUpdateLicenseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"AlertDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"is_active": {
"type": "boolean"
},
"alert_days": {
"type": "integer",
"format": "int32",
"nullable": true
},
"mode": {
"$ref": "#/components/schemas/AlertMode"
},
"template_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"template": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/TemplateDto"
}
]
},
"email_template_id": {
"type": "string",
"format": "uuid"
},
"email_template": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/EmailTemplateDto"
}
]
},
"created_date_utc": {
"type": "string",
"format": "date-time"
}
}
},
"AlertMode": {
"type": "integer",
"description": "",
"x-enumNames": [
"DaysBefore",
"DaysAfter",
"OnExpiration"
],
"enum": [
0,
1,
2
]
},
"AnalyticalFieldDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"product_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"typ": {
"$ref": "#/components/schemas/AnalyticalFieldTyp"
},
"is_chart_relevant": {
"type": "boolean"
},
"is_full_logging": {
"type": "boolean"
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"AnalyticalFieldFilterDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"AnalyticalFieldTyp": {
"type": "integer",
"description": "",
"x-enumNames": [
"Numerical",
"Alphanumerical",
"Boolean",
"Array"
],
"enum": [
0,
1,
2,
3
]
},
"AnalyticalFieldValueDto": {
"type": "object",
"additionalProperties": false,
"required": [
"analytical_field_id",
"value"
],
"properties": {
"analytical_field_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"value": {
"type": "string",
"minLength": 1
},
"value_array": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"timestamp_utc": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"AnalyticalHeartbeatDto": {
"type": "object",
"additionalProperties": false,
"required": [
"client_id",
"analytical_heartbeat"
],
"properties": {
"client_id": {
"type": "string",
"minLength": 1
},
"user_id": {
"type": "string",
"nullable": true
},
"analytical_heartbeat": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AnalyticalFieldValueDto"
}
},
"token_key": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
},
"AnalyticalHeartbeatResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"BackupStorageDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"use_storage_account": {
"type": "boolean"
},
"account": {
"type": "string",
"nullable": true
},
"key": {
"type": "string",
"nullable": true
},
"container_name": {
"type": "string",
"nullable": true
}
}
},
"BackupStorageResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"BackupStorageSasTokenCredentialsError": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorResultObjects"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"BaseErrorResponse": {
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"help": {
"type": "string",
"nullable": true
},
"expectedErrors": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ErrorResultObjects"
}
}
}
},
"BulkDeleteUserResultDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"userId": {
"type": "string",
"nullable": true
},
"success": {
"type": "boolean"
},
"errorMessage": {
"type": "string",
"nullable": true
}
}
},
"ClientIdMode": {
"type": "integer",
"description": "",
"x-enumNames": [
"Client",
"ClientAndToken"
],
"enum": [
0,
1
]
},
"ClientType": {
"type": "integer",
"description": "",
"x-enumNames": [
"Devices",
"Users"
],
"enum": [
0,
1
]
},
"CloseAllSessionsRequestDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"license_id": {
"type": "string",
"format": "uuid"
}
}
},
"CloseSessionErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"CommonErrorResponse": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"ConfigurationDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"on_delete_remove_identity": {
"type": "boolean",
"nullable": true
}
}
},
"ConstrainedVariableDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"name",
"custom_list_id",
"mode",
"selection_mode"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"custom_list_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"mode": {
"$ref": "#/components/schemas/ConstrainedVariableMode"
},
"selection_mode": {
"$ref": "#/components/schemas/ConstrainedVariableSelectionMode"
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"ConstrainedVariableMode": {
"type": "integer",
"description": "",
"x-enumNames": [
"Restricted",
"Unrestricted"
],
"enum": [
0,
1
]
},
"ConstrainedVariableSelectionMode": {
"type": "integer",
"description": "",
"x-enumNames": [
"SingleSelect",
"MultiSelect"
],
"enum": [
0,
1
]
},
"ConsumptionBalanceDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"limit": {
"type": "number",
"format": "decimal"
},
"remaining": {
"type": "number",
"format": "decimal"
},
"balance": {
"type": "number",
"format": "decimal"
},
"last_reset_date_utc": {
"type": "string",
"format": "date-time"
},
"assignment_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"license_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"limitation_id": {
"type": "string",
"format": "uuid"
},
"limitation": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/LimitationDto"
}
]
},
"reset_mode": {
"$ref": "#/components/schemas/ConsumptionResetPeriod"
},
"reset_period_days": {
"type": "integer",
"format": "int32",
"nullable": true
},
"consumption_balance_mode": {
"$ref": "#/components/schemas/ConsumptionBalanceMode"
},
"next_reset_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_transaction_id": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
},
"ConsumptionBalanceMode": {
"type": "integer",
"description": "",
"x-enumNames": [
"RealTime",
"Lazy"
],
"enum": [
0,
1
]
},
"ConsumptionDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"transaction_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"limitation_id": {
"type": "string",
"format": "uuid"
},
"remaining": {
"type": "number",
"format": "decimal",
"nullable": true
},
"balance": {
"type": "number",
"format": "decimal",
"nullable": true
},
"limit": {
"type": "number",
"format": "decimal"
},
"goodwill": {
"type": "number",
"format": "decimal",
"nullable": true
},
"last_reset_date_utc": {
"type": "string",
"format": "date-time"
},
"next_reset_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"ConsumptionHeartbeatDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"value": {
"type": "number",
"format": "decimal"
},
"remaining": {
"type": "number",
"format": "decimal",
"nullable": true
},
"balance": {
"type": "number",
"format": "decimal",
"nullable": true
},
"assignment_id": {
"type": "string",
"format": "uuid"
},
"client_id": {
"type": "string",
"nullable": true
},
"license_id": {
"type": "string",
"format": "uuid"
},
"limitation_id": {
"type": "string",
"format": "uuid"
},
"limitation": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/LimitationDto"
}
]
},
"user_id": {
"type": "string",
"nullable": true
},
"license_user": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/LicenseUserDto"
}
]
},
"created_date_utc": {
"type": "string",
"format": "date-time"
},
"external_id": {
"type": "string",
"nullable": true
}
}
},
"ConsumptionHeartbeatLazyLoadDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"consumption_heartbeats": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ConsumptionHeartbeatDto"
}
},
"max_count": {
"type": "integer",
"format": "int32"
},
"aggregate_value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
},
"ConsumptionHeartbeatResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"ConsumptionHeartbeatValueDto": {
"type": "object",
"additionalProperties": false,
"required": [
"limitation_id",
"value"
],
"properties": {
"limitation_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"user_id": {
"type": "string",
"nullable": true
},
"external_id": {
"type": "string",
"nullable": true
},
"timestamp_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"value": {
"type": "number",
"format": "decimal"
}
}
},
"ConsumptionResetPeriod": {
"type": "integer",
"description": "",
"x-enumNames": [
"Disabled",
"Never",
"Periodically",
"FirstDayOfMonth",
"FirstDayEachQuarter",
"FirstDayOfYear"
],
"enum": [
0,
1,
2,
3,
4,
5
]
},
"ConsumptionRollbackResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"ConsumptionTransactionDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"limitation_id": {
"type": "string",
"format": "uuid"
},
"transaction_id": {
"type": "string",
"format": "uuid"
}
}
},
"CustomerAccountDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"customer_id": {
"type": "string",
"format": "uuid"
},
"company_name": {
"type": "string",
"nullable": true
},
"customer_number": {
"type": "string",
"nullable": true
}
}
},
"CustomerContactDto": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"surname",
"email"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1
},
"surname": {
"type": "string",
"minLength": 1
},
"email": {
"type": "string",
"minLength": 1
},
"phone": {
"type": "string",
"nullable": true
},
"mobile": {
"type": "string",
"nullable": true
},
"language": {
"type": "string",
"nullable": true
},
"user_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"customer_id": {
"type": "string",
"format": "uuid"
},
"is_active": {
"type": "boolean"
},
"is_customer_portal_user": {
"type": "boolean"
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"CustomerDto": {
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"company_name": {
"type": "string",
"nullable": true
},
"customer_number": {
"type": "string",
"nullable": true
},
"customer_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CustomerTypeDto"
}
]
},
"email": {
"type": "string",
"nullable": true
},
"street": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"postalcode": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"prospect_number": {
"type": "string",
"nullable": true
},
"longitude": {
"type": "number",
"format": "double",
"nullable": true
},
"latitude": {
"type": "number",
"format": "double",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
},
"tag_assignments": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/TagAssignmentDto"
}
},
"logo": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ResourceDto"
}
]
},
"reseller_id": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
},
"CustomerFilterDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"page": {
"type": "integer",
"format": "int32",
"nullable": true
},
"page_size": {
"type": "integer",
"format": "int32",
"nullable": true
},
"search_text": {
"type": "string",
"nullable": true
},
"plz_query": {
"type": "string",
"nullable": true
},
"customer_types": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"reseller_types": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"tags": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"start_character": {
"type": "string",
"nullable": true
},
"sort_type": {
"$ref": "#/components/schemas/SortTypeDto"
},
"descending": {
"type": "boolean"
}
}
},
"CustomerLazyLoadDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"customers": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/CustomerDto"
}
},
"max_count": {
"type": "integer",
"format": "int32"
},
"customer_characters": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"CustomerLightDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"company_name": {
"type": "string",
"nullable": true
},
"customer_number": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
}
}
},
"CustomerPortalRoleDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"customerId": {
"type": "string",
"format": "uuid"
},
"customerName": {
"type": "string",
"nullable": true
},
"customerPortalRoleId": {
"type": "string",
"format": "uuid"
}
}
},
"CustomerTypeDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"customer_type_name": {
"type": "string",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"CustomListDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"custom_list_name": {
"type": "string",
"nullable": true
},
"elements": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/CustomListElementDto"
}
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"CustomListElementDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"value": {
"type": "string",
"nullable": true
},
"caption": {
"type": "string",
"nullable": true
}
}
},
"CustomListResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"DataExchangeAddCustomerDto": {
"type": "object",
"additionalProperties": false,
"required": [
"customer_number",
"customer_name",
"customer_type",
"country"
],
"properties": {
"customer_number": {
"type": "string",
"minLength": 1
},
"customer_name": {
"type": "string",
"minLength": 1
},
"customer_type": {
"type": "string",
"minLength": 1
},
"country": {
"type": "string",
"minLength": 1
},
"street": {
"type": "string",
"nullable": true
},
"zip": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"prospect_number": {
"type": "string",
"nullable": true
},
"tags": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"DataExchangeAddCustomerResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"DataExchangeAddLicenseByDetailsResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"DataExchangeAddLicenseDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"template",
"customer_number"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"template": {
"type": "string",
"minLength": 1
},
"customer_number": {
"type": "string",
"minLength": 1
},
"legacy_license_key": {
"type": "string",
"nullable": true
},
"token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"goodwill_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"floating_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"user_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"start_date": {
"type": "string",
"nullable": true
},
"expiration_date": {
"type": "string",
"nullable": true
},
"software_release_limitation": {
"type": "string",
"nullable": true
},
"license_type": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"is_active": {
"type": "boolean",
"default": true,
"nullable": true
},
"client_id": {
"type": "string",
"nullable": true
}
}
},
"DataExchangeAddLicenseResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"DataExchangeAddOrUpdateCustomerContactDto": {
"type": "object",
"additionalProperties": false,
"required": [
"customer_number",
"contact_name",
"contact_surname",
"email"
],
"properties": {
"customer_number": {
"type": "string",
"minLength": 1
},
"contact_name": {
"type": "string",
"minLength": 1
},
"contact_surname": {
"type": "string",
"minLength": 1
},
"email": {
"type": "string",
"minLength": 1
},
"phone": {
"type": "string",
"nullable": true
},
"mobil": {
"type": "string",
"nullable": true
},
"language": {
"type": "string",
"nullable": true
},
"is_customer_portal_user": {
"type": "boolean"
}
}
},
"DataExchangeAddOrUpdateCustomerContactErrorResponse": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"DataExchangeUpdateCustomerDto": {
"type": "object",
"additionalProperties": false,
"required": [
"customer_number"
],
"properties": {
"customer_number": {
"type": "string",
"minLength": 1
},
"customer_name": {
"type": "string",
"nullable": true
},
"customer_type": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"street": {
"type": "string",
"nullable": true
},
"zip": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"prospect_number": {
"type": "string",
"nullable": true
},
"tags": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"DataExchangeUpdateCustomerResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"DataExchangeUpdateLicenseByDetailsResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"DataExchangeUpdateLicenseDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"customer_number",
"legacy_license_key"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"customer_number": {
"type": "string",
"minLength": 1
},
"legacy_license_key": {
"type": "string",
"minLength": 1
},
"template": {
"type": "string",
"nullable": true
},
"token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"goodwill_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"floating_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"user_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"start_date": {
"type": "string",
"nullable": true
},
"expiration_date": {
"type": "string",
"nullable": true
},
"software_release_limitation": {
"type": "string",
"nullable": true
},
"license_type": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"is_active": {
"type": "boolean",
"default": true,
"nullable": true
}
}
},
"DataExchangeUpdateLicenseResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"DateValidity": {
"type": "integer",
"description": "",
"x-enumNames": [
"IsValid",
"IsNotValidYet",
"IsExpired"
],
"enum": [
0,
1,
2
]
},
"DeactivateDeviceLicenseResponseError": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"DeviceAnalyticalHeartbeatDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"license_assignment_id": {
"type": "string",
"format": "uuid"
},
"analytical_field_id": {
"type": "string",
"format": "uuid"
},
"value": {
"type": "string",
"nullable": true
},
"value_array": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"transaction_id": {
"type": "string",
"format": "uuid"
},
"software_version": {
"type": "string",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time"
},
"modified_date_utc": {
"type": "string",
"format": "date-time"
},
"is_last": {
"type": "boolean"
},
"analytical_field": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AnalyticalFieldDto"
}
]
},
"user_id": {
"type": "string",
"nullable": true
},
"license_user": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/LicenseUserDto"
}
]
}
}
},
"DeviceHeartbeatDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"software_version": {
"type": "string",
"nullable": true
},
"operating_system": {
"type": "string",
"nullable": true
},
"ip_address": {
"type": "string",
"nullable": true
},
"client_id": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"zip": {
"type": "string",
"nullable": true
},
"latitude": {
"type": "string",
"nullable": true
},
"longitude": {
"type": "string",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time"
},
"device_license_assignment_id": {
"type": "string",
"format": "uuid"
},
"device_license_id": {
"type": "string",
"format": "uuid"
},
"customer_name": {
"type": "string",
"nullable": true
},
"heartbeat_type_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"heartbeat_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/HeartbeatTypeDto"
}
]
},
"user_id": {
"type": "string",
"nullable": true
},
"license_user": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/LicenseUserDto"
}
]
},
"group_id": {
"type": "string",
"nullable": true
},
"value": {
"type": "integer",
"format": "int32"
}
}
},
"DeviceLicenseAssignmentDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"license_id": {
"type": "string",
"format": "uuid"
},
"product_id": {
"type": "string",
"format": "uuid"
},
"device_name": {
"type": "string",
"nullable": true
},
"device_description": {
"type": "string",
"nullable": true
},
"token_key": {
"type": "string",
"format": "uuid"
},
"user_email": {
"type": "string",
"nullable": true
},
"user_id": {
"type": "string",
"format": "uuid"
},
"client_id": {
"type": "string",
"nullable": true
},
"activated": {
"type": "boolean"
},
"is_software_version_valid": {
"type": "boolean"
},
"is_goodwill_license": {
"type": "boolean"
},
"has_heartbeats": {
"type": "boolean"
},
"has_consumption_heartbeats": {
"type": "boolean"
},
"activated_date_utc": {
"type": "string",
"format": "date-time"
},
"heartbeat_info": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/DeviceHeartbeatDto"
}
]
},
"enforce_software_version_upgrade": {
"type": "boolean"
},
"device_analytical_heartbeats": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/DeviceAnalyticalHeartbeatDto"
}
},
"software_version": {
"type": "string",
"nullable": true
},
"operating_system": {
"type": "string",
"nullable": true
},
"tag_assignments": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/TagAssignmentDto"
}
},
"license_activation_type": {
"$ref": "#/components/schemas/LicenseActivationType"
},
"suspended_until_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"DevicesSortEnum": {
"type": "integer",
"description": "",
"x-enumNames": [
"LastHeartbeatDate",
"GroupId",
"SoftwareVersion",
"Name"
],
"enum": [
0,
1,
2,
3
]
},
"EmailConfigurationDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"inherit_from_vendor": {
"type": "boolean"
},
"use_azure_communication_service": {
"type": "boolean"
},
"from_email": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"to_email": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"smtp_client": {
"type": "string",
"nullable": true
},
"smtp_port": {
"type": "integer",
"format": "int32",
"nullable": true
},
"acs_sender_domain": {
"type": "string",
"nullable": true
},
"acs_sender_username": {
"type": "string",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"EmailTemplateDto": {
"allOf": [
{
"$ref": "#/components/schemas/AbstractEmailTemplateDtoOfEmailTemplateDto"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"product_id": {
"type": "string",
"format": "uuid"
}
}
}
]
},
"ErrorResultObjects": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
},
"help": {
"type": "string",
"nullable": true
}
}
},
"ExpirationMode": {
"type": "integer",
"description": "",
"x-enumNames": [
"Never",
"Date",
"DayAfterActivation"
],
"enum": [
1,
2,
3
]
},
"FeatureDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"FullConsumptionHeartbeatDto": {
"type": "object",
"additionalProperties": false,
"required": [
"client_id",
"consumption_heartbeat"
],
"properties": {
"client_id": {
"type": "string",
"minLength": 1
},
"consumption_heartbeat": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsumptionHeartbeatValueDto"
}
},
"token_key": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
},
"FullProductDto": {
"allOf": [
{
"$ref": "#/components/schemas/ProductDto"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"features": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/FeatureDto"
}
},
"limitations": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LimitationDto"
}
},
"constrained_variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ConstrainedVariableDto"
}
},
"variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/VariableDto"
}
},
"analytical_fields": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/AnalyticalFieldDto"
}
},
"software_shipment_properties": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ProductSoftwareShipmentPropertyDto"
}
},
"software_release_limitations": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
},
"usage_features": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/UsageFeatureDto"
}
},
"usage_modules": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/UsageModuleDto"
}
},
"email_templates": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/EmailTemplateDto"
}
}
}
}
]
},
"FullUsageHeartbeatByNameDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"client_id",
"usage_heartbeat"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"client_id": {
"type": "string",
"minLength": 1
},
"user_id": {
"type": "string",
"nullable": true
},
"usage_heartbeat": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageFeatureNameDto"
}
},
"token_key": {
"type": "string",
"format": "uuid",
"nullable": true
},
"create_usage_feature_if_not_exists": {
"type": "boolean"
},
"create_usage_module_if_not_exists": {
"type": "boolean"
}
}
},
"FullUsageHeartbeatDto": {
"type": "object",
"additionalProperties": false,
"required": [
"client_id",
"usage_heartbeat"
],
"properties": {
"client_id": {
"type": "string",
"minLength": 1
},
"user_id": {
"type": "string",
"nullable": true
},
"usage_heartbeat": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageHeartbeatValueDto"
}
},
"token_key": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
},
"GetAssignmentsErrorExamples": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"GetConsumptionStatusErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"GetLicensesByCustomerDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"customer_number"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"customer_number": {
"type": "string",
"minLength": 1
},
"active_licenses_only": {
"type": "boolean"
}
}
},
"GetLicensesByLicenseKeyDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"product_id": {
"type": "string",
"format": "uuid"
},
"license_key": {
"type": "string",
"nullable": true
}
}
},
"GetLicensesByUserDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"user_id"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"user_id": {
"type": "string",
"minLength": 1
},
"active_licenses_only": {
"type": "boolean"
}
}
},
"GetLicenseUsersErrorExamples": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"HeartBeatMode": {
"type": "integer",
"description": "",
"x-enumNames": [
"JustOnce",
"Periodically"
],
"enum": [
1,
2
]
},
"HeartbeatResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"HeartbeatTypeDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"HistoryAction": {
"type": "integer",
"description": "",
"x-enumNames": [
"Update",
"Create",
"Delete",
"Onboarding",
"DeleteFromB2c"
],
"enum": [
0,
1,
2,
3,
4
]
},
"HistoryDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"new_value": {
"type": "string",
"nullable": true
},
"action": {
"$ref": "#/components/schemas/HistoryAction"
},
"comment": {
"type": "string",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"ImportResultDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"imported_rows": {
"type": "integer",
"format": "int32"
},
"omitted_rows": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/OmittedDataSet"
}
},
"skipped_rows": {
"type": "integer",
"format": "int32"
},
"total_rows": {
"type": "integer",
"format": "int32"
}
}
},
"IsvUserRolesDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"isvId": {
"type": "string",
"format": "uuid"
},
"isvName": {
"type": "string",
"nullable": true
},
"userId": {
"type": "string",
"format": "uuid"
},
"vendorRoleId": {
"type": "string",
"format": "uuid"
},
"resellerPortalRoles": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ResellerPortalRoleDto"
}
},
"customerPortalRoles": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/CustomerPortalRoleDto"
}
}
}
},
"ItemTagAssignmentDto": {
"type": "object",
"additionalProperties": false,
"required": [
"tag_id"
],
"properties": {
"tag_id": {
"type": "integer",
"format": "int32"
}
}
},
"LicenseActivationType": {
"type": "integer",
"description": "",
"x-enumNames": [
"Unknown",
"Online",
"UponLicenseCreation",
"ActivationFile"
],
"enum": [
0,
1,
2,
3
]
},
"LicenseBundleAssignmentDto": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"bundle_id",
"license_id",
"product_id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"bundle_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"license_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"license_name": {
"type": "string",
"nullable": true
},
"license_description": {
"type": "string",
"nullable": true
},
"license_template_name": {
"type": "string",
"nullable": true
},
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"product_name": {
"type": "string",
"nullable": true
},
"product_logo": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ResourceDto"
}
]
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"LicenseBundleDto": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"is_active",
"customer_id",
"assignments"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"is_active": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"customer_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"customer_name": {
"type": "string",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseBundleAssignmentDto"
}
}
}
},
"LicenseConstrainedVariableDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"variable_id"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"variable_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"variable_name": {
"type": "string",
"nullable": true
},
"variable_description": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"LicenseDto": {
"allOf": [
{
"$ref": "#/components/schemas/LicenseSubscriptionPlanDto"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"customer_id",
"product_id",
"template_id",
"token_limit"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"customer_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"template_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"license_type_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"legacy_license_key": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"token_limit": {
"type": "integer",
"format": "int32"
},
"goodwill_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"floating_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"user_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"software_release_limitation_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"is_temporary": {
"type": "boolean"
},
"license_features": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseFeatureDto"
}
},
"license_limitations": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseLimitationDto"
}
},
"license_constrained_variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseConstrainedVariableDto"
}
},
"license_variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseVariableDto"
}
},
"license_users_groups": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseUserGroupDto"
}
},
"license_users": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseUserDto"
}
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
},
"customer": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CustomerDto"
}
]
},
"product": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ProductDto"
}
]
},
"template": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/TemplateDto"
}
]
},
"license_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/LicenseTypeDto"
}
]
},
"software_release_limitation": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
]
},
"prioritized_software_release": {
"type": "string",
"nullable": true
},
"mail_logs": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/MailLogDto"
}
},
"client_id": {
"type": "string",
"nullable": true
}
}
}
]
},
"LicenseFeatureDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"feature_id"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"feature_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"feature_name": {
"type": "string",
"nullable": true
},
"feature_description": {
"type": "string",
"nullable": true
},
"is_active": {
"type": "boolean"
},
"feature_exceptions": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/LicenseFeatureExceptionsDto"
}
]
}
}
},
"LicenseFeatureExceptionDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"start_date_utc": {
"type": "string",
"format": "date-time"
},
"end_date_utc": {
"type": "string",
"format": "date-time"
},
"temporary_is_active": {
"type": "boolean"
}
}
},
"LicenseFeatureExceptionsDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"original_is_active": {
"type": "boolean"
},
"exceptions": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseFeatureExceptionDto"
}
}
}
},
"LicenseFilterDto": {
"type": "object",
"additionalProperties": false,
"required": [
"page_size"
],
"properties": {
"page_size": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32",
"nullable": true
},
"is_active": {
"type": "boolean",
"nullable": true
},
"key_search": {
"type": "string",
"nullable": true
},
"product_filter": {
"type": "string",
"format": "uuid"
},
"customer_filter": {
"type": "string",
"format": "uuid"
},
"customer_number_filter": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"customer_type_filter": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"reseller_type_filter": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"template_filter": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"license_type_filter": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"operating_system_filter": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"software_version_filter": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"is_software_version_valid": {
"type": "boolean",
"nullable": true
},
"feature_filter": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"is_feature_active": {
"type": "boolean",
"nullable": true
},
"date_filter": {
"type": "string",
"format": "date-time",
"nullable": true
},
"date_filter_mode": {
"type": "string",
"nullable": true
},
"is_normal_token": {
"type": "boolean",
"nullable": true
},
"is_goodwill_token": {
"type": "boolean",
"nullable": true
},
"is_group_valid": {
"type": "boolean",
"nullable": true
},
"is_assigned_token": {
"type": "boolean",
"nullable": true
},
"is_suspended_token": {
"type": "boolean",
"nullable": true
},
"group_count_filter": {
"type": "integer",
"format": "int32",
"nullable": true
},
"group_count_mode": {
"type": "string",
"nullable": true
},
"sort_type": {
"$ref": "#/components/schemas/LicenseFilterSortType"
},
"sort_order": {
"type": "boolean"
},
"license_tag_filter": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"token_tag_filter": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"customer_tag_filter": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"analytical_field_filter": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AnalyticalFieldFilterDto"
}
]
}
}
},
"LicenseFilterSortType": {
"type": "integer",
"description": "",
"x-enumNames": [
"Customer",
"CustomerNumber",
"Template",
"ExpirationDate",
"GroupCount",
"CustomerEmail",
"SoftwareReleaseLimitation",
"CreatedDate",
"StartDate",
"Name",
"Reseller",
"ResellerNumber",
"ResellerEmail"
],
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"LicenseImportByDetailsDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"customer_number",
"template"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"customer_number": {
"type": "string",
"minLength": 1
},
"template": {
"type": "string",
"minLength": 1
},
"legacy_license_key": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"goodwill_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"floating_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"user_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"start_date": {
"type": "string",
"nullable": true
},
"expiration_date": {
"type": "string",
"nullable": true
},
"license_type": {
"type": "string",
"nullable": true
},
"software_release_limitation": {
"type": "string",
"nullable": true
},
"license_features": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"license_limitations": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseImportLimitationDto"
}
},
"license_variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseImportVariableDto"
}
},
"license_constrained_variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseImportConstrainedVariableDto"
}
},
"tags": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"is_active": {
"type": "boolean",
"default": true,
"nullable": true
},
"client_id": {
"type": "string",
"nullable": true
},
"resume_on_error": {
"type": "boolean",
"default": false
}
}
},
"LicenseImportByDetailsPatchDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"license_key",
"customer_number"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"license_key": {
"type": "string",
"minLength": 1
},
"customer_number": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"nullable": true
},
"template": {
"type": "string",
"nullable": true
},
"legacy_license_key": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"goodwill_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"floating_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"user_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"start_date": {
"type": "string",
"nullable": true
},
"expiration_date": {
"type": "string",
"nullable": true
},
"license_type": {
"type": "string",
"nullable": true
},
"software_release_limitation": {
"type": "string",
"nullable": true
},
"license_features": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"license_limitations": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseImportLimitationDto"
}
},
"license_variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseImportVariableDto"
}
},
"license_constrained_variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseImportConstrainedVariableDto"
}
},
"is_active": {
"type": "boolean",
"default": true,
"nullable": true
},
"resume_on_error": {
"type": "boolean",
"default": false
}
}
},
"LicenseImportByDetailsPutDto": {
"type": "object",
"additionalProperties": false,
"required": [
"license_key",
"product_id",
"customer_number",
"template"
],
"properties": {
"license_key": {
"type": "string",
"minLength": 1
},
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"customer_number": {
"type": "string",
"minLength": 1
},
"template": {
"type": "string",
"minLength": 1
},
"legacy_license_key": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"goodwill_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"floating_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"user_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"start_date": {
"type": "string",
"nullable": true
},
"expiration_date": {
"type": "string",
"nullable": true
},
"license_type": {
"type": "string",
"nullable": true
},
"software_release_limitation": {
"type": "string",
"nullable": true
},
"license_features": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"license_limitations": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseImportLimitationDto"
}
},
"license_variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseImportVariableDto"
}
},
"license_constrained_variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseImportConstrainedVariableDto"
}
},
"tags": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"is_active": {
"type": "boolean",
"default": true,
"nullable": true
},
"resume_on_error": {
"type": "boolean",
"default": false
}
}
},
"LicenseImportConstrainedVariableDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"variable": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"LicenseImportLimitationDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"limitation": {
"type": "string",
"nullable": true
},
"limit": {
"type": "integer",
"format": "int32"
},
"consumption_reset_mode": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ConsumptionResetPeriod"
}
]
},
"consumption_reset_period_days": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
},
"LicenseImportVariableDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"variable": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
}
},
"LicenseInfoDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"customer": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CustomerAccountDto"
}
]
},
"license_name": {
"type": "string",
"nullable": true
},
"license_key": {
"type": "string",
"nullable": true
},
"token_key": {
"type": "string",
"format": "uuid",
"nullable": true
},
"legacy_license_key": {
"type": "string",
"nullable": true
},
"client_id": {
"type": "string",
"nullable": true
},
"client_name": {
"type": "string",
"nullable": true
},
"client_description": {
"type": "string",
"nullable": true
},
"product_name": {
"type": "string",
"nullable": true
},
"product_id": {
"type": "string",
"format": "uuid"
},
"template_name": {
"type": "string",
"nullable": true
},
"template_id": {
"type": "string",
"format": "uuid"
},
"provisioning_mode": {
"$ref": "#/components/schemas/ProvisioningMode"
},
"client_type": {
"$ref": "#/components/schemas/ClientType"
},
"is_license_active": {
"type": "boolean"
},
"is_license_expired": {
"type": "boolean"
},
"is_license_valid": {
"type": "boolean"
},
"start_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expiration_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"date_validity": {
"$ref": "#/components/schemas/DateValidity"
},
"token_limit": {
"type": "integer",
"format": "int32"
},
"floating_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"is_temporary": {
"type": "boolean"
},
"is_software_version_valid": {
"type": "boolean"
},
"software_release_limitation": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
]
},
"is_newer_software_shipment_available": {
"type": "boolean"
},
"latest_software_shipment": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SoftwareShipmentDto"
}
]
},
"session_period": {
"type": "integer",
"format": "int32",
"nullable": true
},
"heartbeat_period": {
"type": "integer",
"format": "int32",
"nullable": true
},
"freeride": {
"type": "integer",
"format": "int32",
"nullable": true
},
"enforce_software_version_upgrade": {
"type": "boolean"
},
"features": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ProvisioningFeatureDto"
}
},
"limitations": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ProvisioningLimitationDto"
}
},
"variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ProvisioningVariableDto"
}
},
"constrained_variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ProvisioningConstrainedVariableDto"
}
},
"license_users": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseUserDto"
}
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"license_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/LicenseTypeDto"
}
]
}
}
},
"LicenseLazyLoadDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"licenses": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LicenseTreeDto"
}
},
"max_count": {
"type": "integer",
"format": "int32"
},
"customer_count": {
"type": "integer",
"format": "int32"
}
}
},
"LicenseLimitationDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"limitation_id"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"limitation_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"limitation_name": {
"type": "string",
"nullable": true
},
"limitation_description": {
"type": "string",
"nullable": true
},
"limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"consumption_reset_mode": {
"$ref": "#/components/schemas/ConsumptionResetPeriod"
},
"consumption_reset_period_days": {
"type": "integer",
"format": "int32",
"nullable": true
},
"current_user_transaction_id": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
},
"LicenseMailDto": {
"type": "object",
"additionalProperties": false,
"required": [
"licenseKey",
"emailTemplateId",
"productId",
"toEmails"
],
"properties": {
"licenseKey": {
"type": "string",
"minLength": 1
},
"emailTemplateId": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"language": {
"type": "string",
"nullable": true
},
"productId": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"toEmails": {
"type": "array",
"items": {
"type": "string"
}
},
"ccEmails": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"LicensesByCustomerErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"LicensesByKeyErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"LicensesByUserErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"LicenseStateDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"product_id": {
"type": "string",
"format": "uuid"
},
"license_id": {
"type": "string",
"format": "uuid"
},
"legacy_license_key": {
"type": "string",
"nullable": true
},
"is_active": {
"type": "boolean"
}
}
},
"LicenseSubscriptionPlanDto": {
"allOf": [
{
"$ref": "#/components/schemas/SubscriptionPlanDto"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"is_active": {
"type": "boolean"
},
"is_expired": {
"type": "boolean"
},
"date_validity": {
"$ref": "#/components/schemas/DateValidity"
},
"is_valid": {
"type": "boolean"
},
"is_software_release_valid": {
"type": "boolean"
},
"is_group_valid": {
"type": "boolean"
},
"group_count": {
"type": "integer",
"format": "int32"
},
"date_of_issue_utc": {
"type": "string",
"format": "date-time"
},
"start_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
"LicenseTreeDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"description": {
"type": "string",
"nullable": true
},
"legacy_license_key": {
"type": "string",
"nullable": true
},
"license_name": {
"type": "string",
"nullable": true
},
"is_active": {
"type": "boolean"
},
"is_software_release_valid": {
"type": "boolean"
},
"is_group_valid": {
"type": "boolean"
},
"customer_id": {
"type": "string",
"format": "uuid"
},
"customer_number": {
"type": "string",
"nullable": true
},
"customer_email": {
"type": "string",
"nullable": true
},
"company_name": {
"type": "string",
"nullable": true
},
"customer_type": {
"type": "string",
"nullable": true
},
"product_id": {
"type": "string",
"format": "uuid"
},
"product_name": {
"type": "string",
"nullable": true
},
"template_id": {
"type": "string",
"format": "uuid"
},
"template_name": {
"type": "string",
"nullable": true
},
"software_release": {
"type": "string",
"nullable": true
},
"license_type_name": {
"type": "string",
"nullable": true
},
"expiration_mode": {
"$ref": "#/components/schemas/ExpirationMode"
},
"token_limit": {
"type": "integer",
"format": "int32"
},
"goodwill_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"floating_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"user_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"active_users": {
"type": "integer",
"format": "int32",
"nullable": true
},
"active_floating_tokens": {
"type": "integer",
"format": "int32",
"nullable": true
},
"date_of_issue_utc": {
"type": "string",
"format": "date-time"
},
"start_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expiration_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"prioritized_key": {
"$ref": "#/components/schemas/PrioritizedKeyMode"
},
"offline_mode": {
"$ref": "#/components/schemas/OfflineLicensing"
},
"group_count": {
"type": "integer",
"format": "int32"
},
"is_temporary": {
"type": "boolean"
},
"has_consumption_heartbeats": {
"type": "boolean",
"nullable": true
},
"provisioning_mode": {
"$ref": "#/components/schemas/ProvisioningMode"
},
"client_type": {
"$ref": "#/components/schemas/ClientType"
},
"tag_assignments": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/TagAssignmentDto"
}
},
"reseller_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"reseller_number": {
"type": "string",
"nullable": true
},
"reseller_email": {
"type": "string",
"nullable": true
},
"reseller_name": {
"type": "string",
"nullable": true
},
"reseller_type": {
"type": "string",
"nullable": true
}
}
},
"LicenseTypeDto": {
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"name": {
"type": "string",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"LicenseUserDto": {
"type": "object",
"additionalProperties": false,
"required": [
"user_id",
"name",
"license_id",
"is_active"
],
"properties": {
"user_id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"license_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"is_active": {
"type": "boolean"
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
},
"active_sessions": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/SessionDto"
}
},
"license_user_group_id": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
},
"LicenseUserGroupDto": {
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"name": {
"type": "string",
"nullable": true
},
"user_limit": {
"type": "integer",
"format": "int32"
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"LicenseVariableDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"variable_id"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"variable_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"variable_name": {
"type": "string",
"nullable": true
},
"variable_description": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
}
},
"LimitationDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"is_aggregatable": {
"type": "boolean"
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"LookupCustomerDto": {
"type": "object",
"additionalProperties": false,
"required": [
"customer_number"
],
"properties": {
"customer_number": {
"type": "string",
"minLength": 1
}
}
},
"LookupDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"customer_number",
"client_id"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"customer_number": {
"type": "string",
"minLength": 1
},
"client_id": {
"type": "string",
"minLength": 1
},
"legacy_key": {
"type": "string",
"nullable": true
}
}
},
"LookupProductDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_name"
],
"properties": {
"product_name": {
"type": "string",
"minLength": 1
}
}
},
"MailLogDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"receivers": {
"type": "string",
"nullable": true
},
"ccs": {
"type": "string",
"nullable": true
},
"subject": {
"type": "string",
"nullable": true
},
"body": {
"type": "string",
"nullable": true
},
"was_license_file_attached": {
"type": "boolean"
},
"customer_contact_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"customer_contact": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CustomerContactDto"
}
]
},
"license_id": {
"type": "string",
"format": "uuid"
},
"email_template_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"email_template": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/EmailTemplateDto"
}
]
},
"alert_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"alert": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AlertDto"
}
]
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"MigrateDatabaseInfoDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"migrations": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"completed": {
"type": "boolean"
}
}
},
"OfflineLicensing": {
"type": "integer",
"description": "",
"x-enumNames": [
"Off",
"SlasconeAlgorithm",
"IdlAlgorithm"
],
"enum": [
0,
1,
2
]
},
"OmittedDataSet": {
"type": "object",
"additionalProperties": false,
"properties": {
"recordLine": {
"type": "integer",
"format": "int32"
},
"errors": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"OpenSessionErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"PrioritizedKeyMode": {
"type": "integer",
"description": "",
"x-enumNames": [
"Standard",
"LegacyLicenseKey"
],
"enum": [
0,
1
]
},
"ProblemDetails": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
"ProductDetailsDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"features": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/FeatureDto"
}
},
"limitations": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/LimitationDto"
}
},
"variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/VariableDto"
}
},
"constrained_variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ConstrainedVariableDto"
}
},
"analytical_fields": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/AnalyticalFieldDto"
}
},
"software_release_limitations": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
},
"usage_features": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/UsageFeatureDto"
}
},
"usage_modules": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/UsageModuleDto"
}
},
"email_templates": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/EmailTemplateDto"
}
},
"software_shipment_properties": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ProductSoftwareShipmentPropertyDto"
}
}
}
},
"ProductDto": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"prioritized_key"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"short_description": {
"type": "string",
"nullable": true
},
"minimum_software_release_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"software_release": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
},
"is_goodwill_visible": {
"type": "boolean"
},
"is_upgrade_compliance_visible": {
"type": "boolean"
},
"is_group_compliance_visible": {
"type": "boolean"
},
"is_temporary_license_rules_visible": {
"type": "boolean"
},
"prioritized_key": {
"$ref": "#/components/schemas/PrioritizedKeyMode"
},
"offline_licensing": {
"$ref": "#/components/schemas/OfflineLicensing"
},
"license_file_name": {
"type": "string",
"nullable": true
},
"user_id_type": {
"$ref": "#/components/schemas/UserIdType"
},
"client_id_mode": {
"$ref": "#/components/schemas/ClientIdMode"
},
"maximum_inactive_days": {
"type": "integer",
"format": "int32",
"nullable": true
},
"max_licenses_per_user": {
"type": "integer",
"format": "int32"
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
},
"minimum_software_release": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
]
},
"logo": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ResourceDto"
}
]
}
}
},
"ProductSoftwareShipmentPropertyDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"product_id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"ProvisioningConstrainedVariableDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"customListId": {
"type": "string",
"format": "uuid"
},
"value": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"ProvisioningFeatureDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"is_active": {
"type": "boolean"
},
"expiration_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"ProvisioningLimitationDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"remaining": {
"type": "number",
"format": "decimal",
"nullable": true
},
"balance": {
"type": "number",
"format": "decimal"
},
"consumption_reset_mode": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ConsumptionResetPeriod"
}
]
},
"consumption_reset_period_days": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
},
"ProvisioningMode": {
"type": "integer",
"description": "",
"x-enumNames": [
"Named",
"Floating"
],
"enum": [
0,
1
]
},
"ProvisioningVariableDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
}
},
"RemoveLicenseUsersErrorExamples": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"ResellerContactDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"surname": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"mobile": {
"type": "string",
"nullable": true
},
"user_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"is_active": {
"type": "boolean"
},
"is_reseller_portal_user": {
"type": "boolean"
},
"language": {
"type": "string",
"nullable": true
},
"reseller_id": {
"type": "string",
"format": "uuid"
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"ResellerDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"street": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"postalcode": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"logo": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ResourceDto"
}
]
},
"number": {
"type": "string",
"nullable": true
},
"longitude": {
"type": "number",
"format": "double"
},
"latitude": {
"type": "number",
"format": "double"
},
"email": {
"type": "string",
"nullable": true
},
"reseller_type_id": {
"type": "string",
"format": "uuid"
},
"reseller_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ResellerTypeDto"
}
]
},
"reseller_contacts": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ResellerContactDto"
}
},
"reseller_settings": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ResellerSettingsDto"
}
]
},
"last_modified_by": {
"type": "string",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"ResellerEmailConfigurationMode": {
"type": "integer",
"description": "",
"x-enumNames": [
"Optional",
"Mandatory",
"None"
],
"enum": [
0,
1,
2
]
},
"ResellerFilterDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"page": {
"type": "integer",
"format": "int32",
"nullable": true
},
"page_size": {
"type": "integer",
"format": "int32",
"nullable": true
},
"search_text": {
"type": "string",
"nullable": true
},
"plz_query": {
"type": "string",
"nullable": true
},
"reseller_types": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "uuid"
}
},
"tag_ids": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"start_character": {
"type": "string",
"nullable": true
},
"reseller_sort_type": {
"$ref": "#/components/schemas/ResellerSortTypeDto"
},
"descending": {
"type": "boolean"
}
}
},
"ResellerLazyLoadDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"resellers": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ResellerDto"
}
},
"max_count": {
"type": "integer",
"format": "int32"
},
"reseller_character": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"ResellerLightDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"reseller_number": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
}
}
},
"ResellerPortalGlobalSettingsDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"canDeleteLicenses": {
"type": "boolean"
}
}
},
"ResellerPortalRoleDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"resellerId": {
"type": "string",
"format": "uuid"
},
"resellerName": {
"type": "string",
"nullable": true
},
"resellerPortalRoleId": {
"type": "string",
"format": "uuid"
}
}
},
"ResellerPortalSettingsDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"customer_management": {
"type": "boolean"
},
"license_management": {
"type": "boolean"
},
"force_email_configuration": {
"type": "boolean",
"nullable": true
},
"email_configuration_mode": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ResellerEmailConfigurationMode"
}
]
}
}
},
"ResellerSettingsDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"override_global_portal_settings": {
"type": "boolean"
},
"portal_settings": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ResellerPortalSettingsDto"
}
]
}
}
},
"ResellerSortTypeDto": {
"type": "integer",
"description": "",
"x-enumNames": [
"Name",
"ResellerNumber",
"Email"
],
"enum": [
0,
1,
2
]
},
"ResellerTemplateDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"reseller_id": {
"type": "string",
"format": "uuid"
},
"template_id": {
"type": "string",
"format": "uuid"
}
}
},
"ResellerTypeDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"ResourceDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"uri": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
}
},
"SessionDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"session_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"session_valid_until": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time"
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"license_id": {
"type": "string",
"format": "uuid"
},
"assignment_id": {
"type": "string",
"format": "uuid"
},
"assignment": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/DeviceLicenseAssignmentDto"
}
]
},
"user_id": {
"type": "string",
"nullable": true
},
"max_open_session_count": {
"type": "integer",
"format": "int32"
},
"max_active_client_count": {
"type": "integer",
"format": "int32"
},
"duration": {
"type": "integer",
"format": "int32"
}
}
},
"SessionRequestDto": {
"type": "object",
"additionalProperties": false,
"required": [
"license_id",
"client_id"
],
"properties": {
"license_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"client_id": {
"type": "string",
"minLength": 1
},
"session_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"user_id": {
"type": "string",
"nullable": true
},
"checkout_period": {
"type": "number",
"format": "double",
"nullable": true
}
}
},
"SessionStatusDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"is_session_valid": {
"type": "boolean"
},
"session_valid_until": {
"type": "string",
"format": "date-time",
"nullable": true
},
"session_created_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"session_modified_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"max_open_session_count": {
"type": "integer",
"format": "int32"
},
"max_active_client_count": {
"type": "integer",
"format": "int32"
}
}
},
"SlasconeLicenseInfoDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"slascone_licensing_state": {
"$ref": "#/components/schemas/SlasconeLicensingState"
},
"error_message": {
"type": "string",
"nullable": true
},
"slascone_license_info": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/LicenseInfoDto"
}
]
}
}
},
"SlasconeLicensingState": {
"type": "integer",
"description": "",
"x-enumNames": [
"Invalid",
"Expired",
"NeedsActivation",
"FullyValidated"
],
"enum": [
0,
1,
2,
3
]
},
"SoftwareReleaseLimitationDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"product_id": {
"type": "string",
"format": "uuid"
},
"software_release": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"software_shipments": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/SoftwareShipmentDto"
}
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"SoftwareShipmentDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"product_id": {
"type": "string",
"format": "uuid"
},
"version_number": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"download_link": {
"type": "string",
"nullable": true
},
"properties": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/SoftwareShipmentPropertyDto"
}
},
"software_release_limitation_id": {
"type": "string",
"format": "uuid"
},
"is_latest": {
"type": "boolean"
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"SoftwareShipmentPropertyDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"value": {
"type": "string",
"nullable": true
},
"software_shipment_id": {
"type": "string",
"format": "uuid"
},
"product_software_shipment_property_id": {
"type": "string",
"format": "uuid"
},
"product_software_shipment_property_name": {
"type": "string",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"SortTypeDto": {
"type": "integer",
"description": "",
"x-enumNames": [
"Name",
"CustomerNumber",
"Email",
"ProspectNumber"
],
"enum": [
0,
1,
2,
3
]
},
"SubscriptionPlanDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"expiration_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expiration_mode": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ExpirationMode"
}
]
},
"valid_days_count": {
"type": "integer",
"format": "int32"
},
"trial_days_count": {
"type": "integer",
"format": "int32"
}
}
},
"TagAssignmentDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"tag_id": {
"type": "integer",
"format": "int32"
},
"customer_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"license_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"assignment_id": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
},
"TemplateConstrainedVariableDto": {
"type": "object",
"additionalProperties": false,
"required": [
"variable_id"
],
"properties": {
"template_id": {
"type": "string",
"format": "uuid"
},
"variable_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"variable_name": {
"type": "string",
"nullable": true
},
"is_adjustable": {
"type": "boolean"
},
"is_hidden": {
"type": "boolean"
},
"is_customer_portal_hidden": {
"type": "boolean"
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
}
},
"TemplateDto": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"product_id",
"name",
"token_limit"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"product_name": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"short_description": {
"type": "string",
"nullable": true
},
"is_active": {
"type": "boolean"
},
"token_limit": {
"type": "integer",
"format": "int32"
},
"goodwill_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"floating_token_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"enforce_floating_limit": {
"type": "boolean"
},
"user_limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"license_type_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"license_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/LicenseTypeDto"
}
]
},
"is_software_release_limitation_adjustable": {
"type": "boolean"
},
"software_release_limitation_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"allows_invalid_software_release": {
"type": "boolean"
},
"is_expiration_mode_adjustable": {
"type": "boolean"
},
"is_expiration_hidden": {
"type": "boolean"
},
"expiration_mode": {
"$ref": "#/components/schemas/ExpirationMode"
},
"expiration_date_utc": {
"type": "string",
"format": "date-time"
},
"valid_days_count": {
"type": "integer",
"format": "int32"
},
"trial_days_count": {
"type": "integer",
"format": "int32"
},
"heartbeat_mode": {
"$ref": "#/components/schemas/HeartBeatMode"
},
"heartbeat_period": {
"type": "integer",
"format": "int32",
"nullable": true
},
"free_ride": {
"type": "integer",
"format": "int32",
"nullable": true
},
"client_type": {
"$ref": "#/components/schemas/ClientType"
},
"activation_upon_license_creation": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ActivationUponLicenseCreation"
}
]
},
"token_ui_mode": {
"$ref": "#/components/schemas/TokenUiMode"
},
"features": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/TemplateFeatureDto"
}
},
"limitations": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/TemplateLimitationDto"
}
},
"variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/TemplateVariableDto"
}
},
"constrained_variables": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/TemplateConstrainedVariableDto"
}
},
"provisioning_mode": {
"$ref": "#/components/schemas/ProvisioningMode"
},
"session_period": {
"type": "integer",
"format": "int32",
"nullable": true
},
"max_floating_sessions_with_same_client_id": {
"type": "integer",
"format": "int32"
},
"is_temporary": {
"type": "boolean"
},
"has_strict_heartbeats": {
"type": "boolean"
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
},
"software_release_limitation": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SoftwareReleaseLimitationDto"
}
]
},
"supports_license_user_groups": {
"type": "boolean"
},
"heartbeat_sampling_rate": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
},
"TemplateFeatureDto": {
"type": "object",
"additionalProperties": false,
"required": [
"feature_id"
],
"properties": {
"template_id": {
"type": "string",
"format": "uuid"
},
"feature_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"feature_name": {
"type": "string",
"nullable": true
},
"is_adjustable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"is_hidden": {
"type": "boolean"
},
"is_customer_portal_hidden": {
"type": "boolean"
}
}
},
"TemplateLimitationAlertDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"is_active": {
"type": "boolean"
},
"alert_percentage": {
"type": "integer",
"format": "int32",
"nullable": true
},
"template_limitation_id": {
"type": "string",
"format": "uuid"
},
"email_template_id": {
"type": "string",
"format": "uuid"
},
"email_template": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/EmailTemplateDto"
}
]
},
"created_date_utc": {
"type": "string",
"format": "date-time"
}
}
},
"TemplateLimitationDto": {
"type": "object",
"additionalProperties": false,
"required": [
"limitation_id"
],
"properties": {
"template_id": {
"type": "string",
"format": "uuid"
},
"limitation_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"limitation_name": {
"type": "string",
"nullable": true
},
"is_adjustable": {
"type": "boolean"
},
"limit": {
"type": "integer",
"format": "int32",
"nullable": true
},
"consumption_reset_mode": {
"$ref": "#/components/schemas/ConsumptionResetPeriod"
},
"consumption_reset_period_days": {
"type": "integer",
"format": "int32",
"nullable": true
},
"goodwill": {
"type": "number",
"format": "decimal",
"nullable": true
},
"enforce_limit": {
"type": "boolean"
},
"user_provisioning": {
"type": "boolean"
},
"consumption_balance_mode": {
"$ref": "#/components/schemas/ConsumptionBalanceMode"
},
"is_hidden": {
"type": "boolean"
},
"is_customer_portal_hidden": {
"type": "boolean"
},
"alerts": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/TemplateLimitationAlertDto"
}
}
}
},
"TemplateVariableDto": {
"type": "object",
"additionalProperties": false,
"required": [
"variable_id"
],
"properties": {
"template_id": {
"type": "string",
"format": "uuid"
},
"variable_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"variable_name": {
"type": "string",
"nullable": true
},
"is_adjustable": {
"type": "boolean"
},
"is_required": {
"type": "boolean"
},
"is_hidden": {
"type": "boolean"
},
"is_customer_portal_hidden": {
"type": "boolean"
},
"value": {
"type": "string",
"nullable": true
}
}
},
"ToggleLicenseStateDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"license_key",
"is_active"
],
"properties": {
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"license_key": {
"type": "string",
"minLength": 1
},
"is_active": {
"type": "boolean"
}
}
},
"ToggleLicenseStateErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"TokenUiMode": {
"type": "integer",
"description": "",
"x-enumNames": [
"TokenKey",
"ClientId"
],
"enum": [
0,
1
]
},
"UnassignDto": {
"type": "object",
"additionalProperties": false,
"required": [
"token_key"
],
"properties": {
"token_key": {
"type": "string",
"format": "uuid",
"minLength": 1
}
}
},
"UpdateLicenseUserErrorExamples": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"UpdateTemplateResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"UsageFeatureDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"is_chart_relevant": {
"type": "boolean"
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"UsageFeatureNameDto": {
"type": "object",
"additionalProperties": false,
"required": [
"usage_feature_name"
],
"properties": {
"usage_feature_name": {
"type": "string",
"minLength": 1
},
"usage_module_name": {
"type": "string",
"nullable": true
},
"timestamp_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"value": {
"type": "number",
"format": "double"
}
}
},
"UsageHeartbeatByFeatureNameResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"UsageHeartbeatResponseErrors": {
"allOf": [
{
"$ref": "#/components/schemas/BaseErrorResponse"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"UsageHeartbeatValueDto": {
"type": "object",
"additionalProperties": false,
"required": [
"usage_feature_id",
"value"
],
"properties": {
"usage_feature_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"usage_module_id": {
"type": "string",
"nullable": true
},
"timestamp_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"value": {
"type": "number",
"format": "double"
}
}
},
"UsageModuleDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"is_chart_relevant": {
"type": "boolean"
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
},
"UserEmailTemplateDto": {
"allOf": [
{
"$ref": "#/components/schemas/AbstractEmailTemplateDtoOfUserEmailTemplateDto"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"purpose": {
"type": "string",
"nullable": true
}
}
}
]
},
"UserIdType": {
"type": "integer",
"description": "",
"x-enumNames": [
"Standard",
"Guid",
"EMail"
],
"enum": [
0,
1,
2
]
},
"UserRoleContextDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"isvId": {
"type": "string",
"format": "uuid"
},
"resellerId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"customerId": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
},
"UserRolesDto": {
"type": "object",
"additionalProperties": false,
"properties": {
"userRoles": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/IsvUserRolesDto"
}
},
"userRoleContext": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/UserRoleContextDto"
}
]
}
}
},
"ValidateAssignmentsDto": {
"type": "object",
"additionalProperties": false,
"required": [
"days"
],
"properties": {
"days": {
"type": "integer",
"format": "int32"
},
"customerTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"licenseTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
}
}
},
"ValidateConsumptionStatusDto": {
"type": "object",
"additionalProperties": false,
"required": [
"license_id",
"limitation_id"
],
"properties": {
"license_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"limitation_id": {
"type": "string",
"format": "uuid",
"minLength": 1
}
}
},
"ValidateLicenseDto": {
"type": "object",
"additionalProperties": false,
"required": [
"license_key"
],
"properties": {
"license_key": {
"type": "string",
"minLength": 1
}
}
},
"VariableDto": {
"type": "object",
"additionalProperties": false,
"required": [
"product_id",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"product_id": {
"type": "string",
"format": "uuid",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"nullable": true
},
"created_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modified_date_utc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"last_modified_by": {
"type": "string",
"nullable": true
}
}
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert the JWT with Bearer into field",
"name": "Bearer Token",
"in": "header"
},
"AdminKey": {
"type": "apiKey",
"description": "Read more about the Admin Key [here](https://support.slascone.com/hc/en-us/articles/360016153358-API-FUNDAMENTALS/#authentication).",
"name": "AdminKey",
"in": "header"
},
"ProvisioningKey": {
"type": "apiKey",
"description": "Read more about the Provisioning Key [here](https://support.slascone.com/hc/en-us/articles/360016153358-API-FUNDAMENTALS/#authentication).",
"name": "ProvisioningKey",
"in": "header"
},
"CustomerPortalKey": {
"type": "apiKey",
"description": "Read more about the Customer Portal Key [here](https://support.slascone.com/hc/en-us/articles/360016153358-API-FUNDAMENTALS/#authentication).",
"name": "CustomerPortalKey",
"in": "header"
},
"DaemonKey": {
"type": "apiKey",
"description": "Read more about the Daemon Key [here](https://support.slascone.com/hc/en-us/articles/360016153358-API-FUNDAMENTALS/#authentication).",
"name": "DaemonKey",
"in": "header"
}
}
},
"security": [
{
"Bearer": []
},
{
"AdminKey": []
},
{
"ProvisioningKey": []
},
{
"CustomerPortalKey": []
},
{
"DaemonKey": []
}
],
"tags": [
{
"name": "Administration"
},
{
"name": "Customer"
},
{
"name": "CustomerPortal"
},
{
"name": "DataExchange"
},
{
"name": "DataGathering"
},
{
"name": "LicenseBundle"
},
{
"name": "License"
},
{
"name": "LookUp"
},
{
"name": "Notification"
},
{
"name": "Product"
},
{
"name": "Provisioning"
},
{
"name": "Reseller"
},
{
"name": "Roles"
},
{
"name": "Template",
"description": "(Product Edition)"
}
],
"externalDocs": {
"description": "Request help",
"url": "https://outlook.office365.com/owa/calendar/OnlineDemo@slascone.com/bookings/s/Atny3m9eVEOyMpL1imVDMQ2"
}
}