{ "openapi": "3.0.1", "info": { "title": "Standard API", "version": "v1" }, "servers": [ { "url": "https://app-hsm-clse-stage.azurewebsites.net" } ], "paths": { "/api/standard/v1/effective-system-permissions": { "get": { "tags": [ "Authorization" ], "summary": "Get the effective permissions of a user for the system securable", "operationId": "getSystemEffectivePermissionsEffectiveSystemPermissions", "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "X-Client-System-Id", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/EffectivePermissionDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/role-assignments/{id}": { "delete": { "tags": [ "Authorization" ], "summary": "Deletes a role-assignment.", "operationId": "deleteRoleAssignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/system-assignable-roles": { "get": { "tags": [ "Authorization" ], "summary": "Gets the roles that the current user can assign to other users on the system", "operationId": "getSystemAssignableRolesSystemAssignableRoles", "parameters": [ { "name": "clientSystemIds", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "explode": false }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfRoleDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/system-role-assignments": { "patch": { "tags": [ "Authorization" ], "summary": "Creates new system role-assignments.", "operationId": "createRoleAssignmentsSystemRoleAssignment", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateMultipleRoleAssignmentsDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateMultipleRoleAssignmentsDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateMultipleRoleAssignmentsDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateMultipleRoleAssignmentsDto" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SystemRoleAssignmentDto" } } } } }, "204": { "description": "No Content" }, "400": { "description": "BadRequest ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/invite": { "put": { "tags": [ "Authorization" ], "summary": "Invite a user with role assignments at system securable", "operationId": "inviteUsersToSystemSystemUserInvitation", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/InviteUsersToSecurableDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InviteUsersToSecurableDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InviteUsersToSecurableDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InviteUsersToSecurableDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInvitationResultDto" } } } }, "400": { "description": "ErrorCode(INVALID_DATA): invalid data \n\nErrorCode(EMAIL_COULD_NOT_BE_SENT): email could not be sent \n\nBadRequest ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "409": { "description": "Conflict ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/reinvite": { "put": { "tags": [ "Authorization" ], "summary": "Resends the system invitation email to a user", "operationId": "reInviteUsersToSystemSystemUserInvitation", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReInviteUserToSecurableDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReInviteUserToSecurableDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReInviteUserToSecurableDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReInviteUserToSecurableDto" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/availability-capabilities": { "get": { "tags": [ "Capabilities" ], "summary": "Get all availability capabilities", "operationId": "getAvailabilityCapabilitiesCapabilities", "parameters": [ { "name": "capabilityType", "in": "query", "schema": { "$ref": "#/components/schemas/CapabilityType" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CapabilityDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/availability-capability-grants": { "get": { "tags": [ "Capabilities" ], "summary": "Gets the availability capability grants for system.", "operationId": "getSystemCapabilityGrantsSystemAvailabilityCapabilityGrants", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AvailabilityCapabilityGrantWithTypeDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/client-systems": { "get": { "tags": [ "ClientSystems" ], "summary": "Get client systems", "operationId": "getClientSystemsClientSystem", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientSystemDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/distribution-task-jobs": { "post": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "createJobCloudToDeviceDistributionTaskJobs", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskJobCreateRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskJobCreateRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskJobCreateRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskJobCreateRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskJobCreateResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "get": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "getPagedDistributionTaskJobsCloudToDeviceDistributionTaskJobs", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "onlyActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeSystemJobs", "in": "query", "schema": { "type": "boolean" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfCloudToDeviceDistributionTaskJobResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distribution-task-jobs/{id}": { "get": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "getDistributionTaskJobDetailsCloudToDeviceDistributionTaskJobs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskJobDetailResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distribution-task-jobs/{id}/distribution-tasks": { "get": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "getPagedDistributionTaskJobTasksCloudToDeviceDistributionTaskJobs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfCloudToDeviceDistributionTaskResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distribution-task-jobs/{id}/cancel": { "put": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "cancelCloudToDeviceDistributionTaskJobs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "description": "Accepted" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/distribution-task-repeatable-jobs": { "post": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "createJobCloudToDeviceDistributionTaskRepeatableJobs", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobCreateRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobCreateRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobCreateRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobCreateRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobCreateResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "get": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "getByCustomerIdCloudToDeviceDistributionTaskRepeatableJobs", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfCloudToDeviceDistributionTaskRepeatableJobResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distribution-task-repeatable-jobs/{id}/force-update": { "put": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "forceUpdateCloudToDeviceDistributionTaskRepeatableJobs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distribution-task-repeatable-jobs/{id}/run": { "put": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "runCloudToDeviceDistributionTaskRepeatableJobs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskJobResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distribution-task-repeatable-jobs/{id}": { "put": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "updateCloudToDeviceDistributionTaskRepeatableJobs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobUpdateRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobUpdateRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobUpdateRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobUpdateRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "get": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "getCloudToDeviceDistributionTaskRepeatableJobs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "deleteCloudToDeviceDistributionTaskRepeatableJobs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distribution-tasks/{id}": { "get": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "getTaskCloudToDeviceDistributionTasks", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distribution-tasks/{id}/cancel": { "put": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "cancelCloudToDeviceDistributionTasks", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{deviceId}/distribution-tasks": { "get": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "getPagedByDeviceIdCloudToDeviceDistributionTasks", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "statusTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DistributionTaskStatus" } }, "explode": false }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfCloudToDeviceDistributionTaskByDeviceResponseDto" } } } }, "400": { "description": "If the device is not assigned to a customer with errorCode DEVICE_NOT_INSTALLED", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{deviceId}/distribution-tasks/statistics": { "get": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "getDistributionTaskDeviceStatisticCloudToDeviceDistributionTasks", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionTaskStatisticsResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distribution-tasks/{id}/logs": { "get": { "tags": [ "CloudToDeviceDistribution" ], "operationId": "getDistributionTaskLogsCloudToDeviceDistributionTasks", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskLogResponseDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-documents/{id}": { "get": { "tags": [ "CustomerDeviceDocuments" ], "summary": "Get a specific device-document.", "operationId": "getCustomerDeviceDocumentCustomerDeviceDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "patch": { "tags": [ "CustomerDeviceDocuments" ], "summary": "Updates metadata of a device document.", "operationId": "updateCustomerDeviceDocumentsCustomerDeviceDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentBaseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentBaseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentBaseDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentBaseDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "CustomerDeviceDocuments" ], "summary": "Deletes a device document.", "operationId": "deleteCustomerDeviceDocumentsCustomerDeviceDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-documents/{id}/document": { "get": { "tags": [ "CustomerDeviceDocuments" ], "summary": "Downloads a specific device-document.", "operationId": "downloadCustomerDeviceDocumentCustomerDeviceDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-type-documents/{documentId}": { "get": { "tags": [ "CustomerDeviceTypeDocuments" ], "summary": "Gets a specific customer device-type document.", "operationId": "getCustomerDeviceTypeDocumentCustomerDeviceTypeDocument", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "patch": { "tags": [ "CustomerDeviceTypeDocuments" ], "summary": "Updates metadata of a customer device-type document.", "operationId": "updateCustomerDeviceTypeDocumentCustomerDeviceTypeDocument", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentBaseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentBaseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentBaseDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentBaseDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "CustomerDeviceTypeDocuments" ], "summary": "Deletes a specific customer device-type document.", "operationId": "deleteCustomerDeviceTypeDocumentCustomerDeviceTypeDocument", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-type-documents/{documentId}/document": { "get": { "tags": [ "CustomerDeviceTypeDocuments" ], "summary": "Downloads a specific customer device-type document.", "operationId": "downloadCustomerDeviceTypeDocumentCustomerDeviceTypeDocument", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/associated-customers-count": { "get": { "tags": [ "Customers" ], "summary": "Gets the number of associated customers of the current user", "operationId": "getAssociatedCustomersCountAssociatedCustomersCount", "parameters": [ { "name": "X-Client-System-Id", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociatedCustomerCountDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers": { "get": { "tags": [ "Customers" ], "summary": "Gets a collection of customers. Only customers that the current user has permissions on will be included in the result", "operationId": "getCustomersCustomer", "parameters": [ { "name": "fullTextSearch", "in": "query", "schema": { "type": "string" } }, { "name": "parentId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "resellerId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "conditionOwnerId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "invoiceRecipientId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "facilityManagementProviderId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "isReseller", "in": "query", "schema": { "type": "boolean" } }, { "name": "deletedOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "X-Client-System-Id", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfCustomerDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}": { "get": { "tags": [ "Customers" ], "summary": "Gets a customer by id", "operationId": "getCustomerCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-Client-System-Id", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "Customers" ], "summary": "Deletes a customer permanently. This operation is irreversible.", "operationId": "deleteCustomerCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "ErrorCode(NOT_ALL_DEVICES_COULD_BE_UNINSTALLED): not all devices could be uninstalled \n\nErrorCode(DEVICES_COULD_NOT_BE_UNINSTALLED): devices could not be uninstalled ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/invite": { "put": { "tags": [ "Customers" ], "summary": "Update the customer user role assignments at customer", "operationId": "inviteUsersToCustomerCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/InviteUsersToSecurableDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InviteUsersToSecurableDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InviteUsersToSecurableDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InviteUsersToSecurableDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInvitationResultDto" } } } }, "400": { "description": "ErrorCode(INVALID_DATA): invalid data \n\nErrorCode(EMAIL_COULD_NOT_BE_SENT): email could not be sent ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/reinvite": { "put": { "tags": [ "Customers" ], "summary": "Resends the customer invitation email to a user", "operationId": "reInviteUsersToCustomerCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReInviteUserToSecurableDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReInviteUserToSecurableDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReInviteUserToSecurableDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReInviteUserToSecurableDto" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/stored-device-filters": { "get": { "tags": [ "StoredDeviceFilters" ], "summary": "Get stored device filters available for this customer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeInherited", "in": "query", "schema": { "type": "boolean" } }, { "name": "onlyBestMatchingTranslation", "in": "query", "schema": { "type": "boolean" } }, { "name": "textFilter", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfStoredDeviceFilterWithoutTermDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "StoredDeviceFilters" ], "summary": "Create a new stored device filter for this customer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewStoredDeviceFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewStoredDeviceFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewStoredDeviceFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewStoredDeviceFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoredDeviceFilterDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/support-organization": { "get": { "tags": [ "Customers" ], "summary": "Get support organization for customer", "operationId": "getCustomerSupportOrganizationCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSupportOrganizationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "Customers" ], "summary": "Update support organization for customer", "operationId": "updateCustomerSupportOrganizationCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomerSupportOrganizationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSupportOrganizationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerSupportOrganizationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerSupportOrganizationDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSupportOrganizationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "Customers" ], "summary": "Delete support organization for customer", "operationId": "deleteCustomerSupportOrganizationCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/self-assignment-light-credentials": { "get": { "tags": [ "Customers" ], "summary": "Gets the self assignment credentials for the customer", "operationId": "getSelfAssignmentLightCredentialsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSelfAssignmentLightCredentialsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/self-assign-to-customer-light": { "put": { "tags": [ "Customers" ], "summary": "Self assign the current user to the customer", "operationId": "selfAssignToCustomerCustomer", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomerSelfAssignmentLightCredentialsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSelfAssignmentLightCredentialsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerSelfAssignmentLightCredentialsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerSelfAssignmentLightCredentialsDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/effective-customer-permissions": { "get": { "tags": [ "Customers" ], "summary": "Get the effective permissions of a user for a customer securable", "operationId": "getCustomerEffectivePermissionsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "X-Client-System-Id", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/EffectivePermissionDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/effective-capabilities": { "get": { "tags": [ "Customers" ], "summary": "Get the effective capabilities for the user-customer context", "operationId": "getCustomerEffectiveCapabilitiesCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EffectiveCustomerCapabilitiesDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/effective-customer-capability-grants": { "get": { "tags": [ "Customers" ], "summary": "Get the effective customer capability grants", "operationId": "getCustomerEffectiveCapabilityGrantsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EffectiveCustomerCapabilityGrantDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/availability-capability-grants": { "get": { "tags": [ "Capabilities" ], "summary": "Gets the availability capability grants for this customer.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAvailabilityCapabilityGrantDto" } } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Capabilities" ], "summary": "Grants an availability capability to this customer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateCustomerCapabilityGrantDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerCapabilityGrantDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerCapabilityGrantDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCustomerCapabilityGrantDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAvailabilityCapabilityGrantDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/availability-capability-grants/{code}": { "get": { "tags": [ "Capabilities" ], "summary": "Gets the availability capability grant for a specific capability on this customer.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAvailabilityCapabilityGrantDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "Capabilities" ], "summary": "Updates a capability grant for the given capability on this customer.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerCapabilityGrantDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerCapabilityGrantDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerCapabilityGrantDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerCapabilityGrantDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAvailabilityCapabilityGrantDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "Capabilities" ], "summary": "Removes the availability capability grant for a specific capability from the customer.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/assigned-users": { "get": { "tags": [ "Customers" ], "summary": "Gets a list of users that have some role assigned at this customer", "operationId": "getCustomerAssignedUsersCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "assignmentSources", "in": "query", "description": "Sources of role assignment to be filtered (e.g., return only users with direct role assignments), separated by comma", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentTypeDto" } }, "explode": false }, { "name": "fullTextSearch", "in": "query", "description": "String to perform full text search. Search is performed on columns FirstName, LastName, Email and Affiliation.\r\nString can include multiple terms (e.g., \"search this\") or match by prefix (e.g., \"sea*\").", "schema": { "type": "string" } }, { "name": "userStatus", "in": "query", "description": "List of user status to filter, separated by comma.", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/UserStatusDto" } }, "explode": false }, { "name": "includeAssignmentsApplicableToRelatedCustomersOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfUserDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/assigned-users/{userId}/effective-role-assignments": { "get": { "tags": [ "Customers" ], "summary": "Gets a list of effective role assignments of a given assigned user of a customer", "operationId": "getCustomerAssignedUserEffectiveRoleAssignmentsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assignmentSources", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentTypeDto" } }, "explode": false }, { "name": "includeAssignmentsApplicableToRelatedCustomersOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "clientSystemIds", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "explode": false }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfEffectiveRoleAssignmentDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/mark-favorite": { "put": { "tags": [ "CustomerSelection" ], "summary": "Marks a customer as favorite or non favorite for the currently accessing user.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-Client-System-Id", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MarkCustomerAsFavoriteDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MarkCustomerAsFavoriteDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MarkCustomerAsFavoriteDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MarkCustomerAsFavoriteDto" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/mark-recently-accessed": { "put": { "tags": [ "CustomerSelection" ], "summary": "Marks a customer as recently accessed by the accessing user.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-Client-System-Id", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/status": { "get": { "tags": [ "Customers" ], "summary": "Get a customer's status.", "operationId": "getCustomerStatusCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerStatus" } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "Customers" ], "summary": "Set a customer's status.", "operationId": "updateCustomerStatusCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomerStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerStatus" } } } }, "400": { "description": "ErrorCode(CUSTOMER_STATUS_CHANGE_INVALID): customer status change invalid ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/promote-to-reseller": { "put": { "tags": [ "Customers" ], "summary": "Promotes a customer to reseller.", "operationId": "promoteCustomerToResellerCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "copyConfigurationFromResellerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "ErrorCode(INVALID_OPERATION): invalid operation ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/demote-reseller": { "put": { "tags": [ "Customers" ], "summary": "Demote a reseller to a regular customer", "operationId": "demoteResellerToRegularCustomerCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "501": { "description": "Not Implemented" } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/reseller": { "put": { "tags": [ "Customers" ], "summary": "Updates the reseller of a customer", "operationId": "updateResellerOfCustomerCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "resellerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "409": { "description": "ErrorCode(ACTIVE_ORDERS): active orders ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/assignable-roles": { "get": { "tags": [ "Customers" ], "summary": "Gets the roles that the current user can assign to other users on this customer", "operationId": "getCustomerAssignableRolesCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientSystemIds", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "explode": false }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfRoleDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/effective-branding": { "get": { "tags": [ "Customers" ], "summary": "Gets the effective branding of this customer.", "operationId": "getEffectiveCustomerBrandingCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandingDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/branding": { "get": { "tags": [ "Customers" ], "summary": "Gets the branding assigned to this specific customer.", "operationId": "getCustomerBrandingCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerBrandingDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "Customers" ], "summary": "Creates or updates the customer branding.", "operationId": "createOrUpdateCustomerBrandingCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomerBrandingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerBrandingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerBrandingDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerBrandingDto" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/role-assignments": { "patch": { "tags": [ "Authorization" ], "summary": "Creates new role-assignments for this customer.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateMultipleRoleAssignmentsDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateMultipleRoleAssignmentsDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateMultipleRoleAssignmentsDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateMultipleRoleAssignmentsDto" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerRoleAssignmentDto" } } } } }, "204": { "description": "No Content" }, "400": { "description": "BadRequest ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/location-tree": { "get": { "tags": [ "Customers" ], "summary": "Gets the whole location tree of a customer.", "operationId": "getLocationTreeCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationTreeDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/buildings": { "post": { "tags": [ "Customers" ], "summary": "Creates a new building for this customer.", "operationId": "createBuildingCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationDto" } } } }, "400": { "description": "ErrorCode(ILLEGAL_LOCATION_NAME): illegal location name ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/device-classification": { "put": { "tags": [ "Customers" ], "summary": "Return a summary of devices classified into different categories, e.g. for showing them as charts.", "operationId": "getDeviceClassificationCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "types", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/DeviceClassificationTypeDto" } }, "explode": false }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceClassificationRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceClassificationRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceClassificationRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceClassificationRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceClassificationResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/users/{userId}/role-assignments": { "delete": { "tags": [ "Customers" ], "summary": "Deletes directly assigned non externally managed role-assignments of a user on a customer.", "operationId": "deleteRoleAssignmentsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "ErrorCode(NOT_ALLOWED_TO_DELETE_OWN_ROLE_ASSIGNMENT): not allowed to delete own role assignment ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/service-areas": { "get": { "tags": [ "Customers" ], "summary": "Returns service areas directly assigned to a reseller", "operationId": "getServiceAreasCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAreaListingDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/effective-service-areas": { "get": { "tags": [ "Customers" ], "summary": "Returns effective service areas of a customer", "operationId": "getEffectiveServiceAreasCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EffectiveServiceAreaListingDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/effective-free-service-periods": { "get": { "tags": [ "Customers" ], "summary": "Get effective free service periods for customer", "operationId": "getEffectiveFreeServicePeriodsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EffectiveFreeServicePeriodListingDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/service-area-available-device-types": { "get": { "tags": [ "Customers" ], "summary": "Returns the available device types to be used on service areas of a customer", "operationId": "getAvailableDeviceTypesForServiceAreaCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceTypeDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/full-service-contracts": { "get": { "tags": [ "Customers" ], "summary": "Returns the full service contracts of a customer", "operationId": "getFullServiceContractsCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullServiceContractListingDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-types/{deviceTypeId}/effective-problem-types": { "get": { "tags": [ "Customers" ], "summary": "Returns effective indistinct device service request problem types of a customer for a specific deviceType", "operationId": "getEffectiveIndistinctServiceRequestProblemTypesCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EffectiveDeviceServiceRequestProblemTypeDto" } } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-types/{deviceTypeId}/effective-device-service-request-problem-types": { "get": { "tags": [ "Customers" ], "summary": "Returns effective indistinct device service request problem types of a customer for a specific deviceType", "operationId": "getEffectiveIndistinctDeviceServiceRequestProblemTypesCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EffectiveDeviceServiceRequestProblemTypeDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/resolution-types": { "get": { "tags": [ "Customers" ], "summary": "Returns device service request resolution types of a reseller", "operationId": "getServiceRequestResolutionTypesCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeListingDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/device-service-request-resolution-types": { "get": { "tags": [ "Customers" ], "summary": "Returns device service request resolution types of a reseller", "operationId": "getDeviceServiceRequestResolutionTypesCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeListingDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-types/{deviceTypeId}/effective-resolution-types": { "get": { "tags": [ "Customers" ], "summary": "Returns the effective resolution types for an indistinct device service request of a given device type within a customer", "operationId": "getEffectiveResolutionTypesForIndistinctServiceRequestsCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeListingDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-types/{deviceTypeId}/effective-device-service-request-resolution-types": { "get": { "tags": [ "Customers" ], "summary": "Returns the effective resolution types for an indistinct device service request of a given device type within a customer", "operationId": "getEffectiveResolutionTypesForIndistinctDeviceServiceRequestsCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeListingDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/free-service-periods": { "get": { "tags": [ "Customers" ], "summary": "Returns free service periods of a customer", "operationId": "getFreeServicePeriodsCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FreeServicePeriodListingDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-types/{deviceTypeId}/indistinct-service-requests-billing-mode": { "get": { "tags": [ "Customers" ], "summary": "Returns the billing mode for an indistinct service request for a given device type within a customer", "operationId": "getIndistinctServiceRequestsBillingModeCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingMode" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-types/{deviceTypeId}/indistinct-device-service-requests-billing-mode": { "get": { "tags": [ "Customers" ], "summary": "Returns the billing mode for an indistinct device service request for a given device type within a customer", "operationId": "getIndistinctDeviceServiceRequestsBillingModeCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingMode" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/problem-types": { "get": { "tags": [ "Customers" ], "summary": "Returns service request problem types of a reseller", "operationId": "getServiceRequestProblemTypesCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeListingDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/device-service-request-problem-types": { "get": { "tags": [ "Customers" ], "summary": "Returns device service request problem types of a reseller", "operationId": "getDeviceServiceRequestProblemTypesCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeListingDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/service-request-settings": { "put": { "tags": [ "Customers" ], "summary": "Update device service request settings of a reseller", "operationId": "updateServiceRequestSettingsCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestSettingsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestSettingsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestSettingsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestSettingsDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSettingsDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/device-service-request-settings": { "put": { "tags": [ "Customers" ], "summary": "Update device service request settings of a reseller", "operationId": "updateDeviceServiceRequestSettingsCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestSettingsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestSettingsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestSettingsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestSettingsDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSettingsDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "get": { "tags": [ "Customers" ], "summary": "Returns device service request settings of a reseller", "operationId": "getDeviceServiceRequestSettingsCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSettingsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/effective-service-request-settings": { "get": { "tags": [ "Customers" ], "summary": "Returns effective device service request settings of a customer", "operationId": "getEffectiveServiceRequestSettingsCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EffectiveDeviceServiceRequestSettingsDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/effective-device-service-request-settings": { "get": { "tags": [ "Customers" ], "summary": "Returns effective device service request settings of a customer", "operationId": "getEffectiveDeviceServiceRequestSettingsCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSettingsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/get-service-requests": { "put": { "tags": [ "Customers" ], "summary": "Returns device service requests of a customer", "operationId": "obsoleteGetDeviceServiceRequestsCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfDeviceServiceRequestDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/get-device-service-requests": { "put": { "tags": [ "Customers" ], "summary": "Returns device service requests of a customer", "operationId": "getDeviceServiceRequestsCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfDeviceServiceRequestDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/get-reseller-service-requests": { "put": { "tags": [ "Customers" ], "summary": "Returns device service requests of a reseller", "operationId": "obsoleteGetResellerDeviceServiceRequestsCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfDeviceServiceRequestResellerSummaryDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/get-reseller-device-service-requests": { "put": { "tags": [ "Customers" ], "summary": "Returns device service requests of a reseller", "operationId": "getResellerDeviceServiceRequestsCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestSummaryFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfDeviceServiceRequestResellerSummaryDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/refill-items": { "get": { "tags": [ "Customers" ], "summary": "Returns refill items of a reseller", "operationId": "getRefillItemsCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeIds", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "explode": false }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefillItemDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/refill-item-settings": { "get": { "tags": [ "Customers" ], "summary": "Returns refill item settings of a reseller", "operationId": "getRefillItemSettingsCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillItemSettingsDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "Customers" ], "summary": "Update refill item settings of a reseller", "operationId": "updateRefillItemSettingsCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RefillItemSettingsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RefillItemSettingsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefillItemSettingsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RefillItemSettingsDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillItemSettingsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/effective-refill-items": { "get": { "tags": [ "Customers" ], "summary": "Returns effective refill items of a customer", "operationId": "getEffectiveRefillItemsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefillItemDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/suitable-refill-items": { "get": { "tags": [ "Customers" ], "summary": "Returns suitable refill items for a customer and device type", "operationId": "getSuitableRefillItemsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefillItemDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/selected-inheritance-refill-item-candidates": { "get": { "tags": [ "Customers" ], "summary": "Returns candidates for inheritance refill item selection of a customer. Includes refill items that are already in the selected inheritance list.", "operationId": "getSelectedInheritanceRefillItemCandidatesCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefillItemDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/selected-inheritance-refill-items": { "get": { "tags": [ "Customers" ], "summary": "Returns selected inheritance items of a customer", "operationId": "getSelectedInheritanceRefillItemsCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SelectedInheritanceRefillItemDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/devices/{deviceId}/refill-item-associations": { "get": { "tags": [ "Customers" ], "summary": "Returns refill item device associations of a customer", "operationId": "getRefillItemAssociationsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefillItemDeviceAssociationDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/effective-service-areas-assigned-device-types": { "get": { "tags": [ "Customers" ], "summary": "Get customer's effective service area's assigned device types", "operationId": "getEffectiveServiceAreasAssignedDeviceTypesCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceTypeDto" } } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/avatar-image": { "put": { "tags": [ "Customers" ], "summary": "Add avatar image to customer", "operationId": "uploadAvatarFileCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" }, "fileLastModifiedAt": { "type": "string", "format": "date-time" } } }, "encoding": { "uploadedFile": { "style": "form" }, "fileLastModifiedAt": { "style": "form" } } } } }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "BadRequest ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "Customers" ], "summary": "Delete customer avatar", "operationId": "deleteAvatarFileCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "get": { "tags": [ "Customers" ], "summary": "Retrieve customer avatar as well as thumbnails", "operationId": "getAvatarFileCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/role-inheritance-settings": { "get": { "tags": [ "Customers" ], "summary": "Returns customer role inheritance settings flags", "operationId": "getRoleInheritanceSettingsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendedRoleInheritanceSettingsDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "Customers" ], "summary": "Update customer role inheritance settings flags", "operationId": "updateRoleInheritanceSettingsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomerRoleInheritanceSettingsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRoleInheritanceSettingsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerRoleInheritanceSettingsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerRoleInheritanceSettingsDto" } } } }, "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/effective-customer-service-request-settings": { "get": { "tags": [ "Customers" ], "summary": "Returns effective customer service request settings", "operationId": "getEffectiveCustomerServiceRequestSettingsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EffectiveCustomerServiceRequestSettingsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/customer-service-request-settings": { "get": { "tags": [ "Customers" ], "summary": "Returns customer service request settings of reseller", "operationId": "getCustomerServiceRequestSettingsOfResellerCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSettingsDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "Customers" ], "summary": "Update customer service request settings flags of reseller", "operationId": "createOrUpdateCustomerServiceRequestSettingsOfResellerCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSettingsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSettingsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSettingsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSettingsDto" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSettingsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/customer-service-request-types": { "get": { "tags": [ "Customers" ], "summary": "Returns customer service request types", "operationId": "getCustomerServiceRequestTypesCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerServiceRequestTypeDto" } } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Customers" ], "summary": "Create a new customer service request type for this customer", "operationId": "createCustomerServiceRequestTypeCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateCustomerServiceRequestTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateCustomerServiceRequestTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateCustomerServiceRequestTypeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateCustomerServiceRequestTypeDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestTypeDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/effective-customer-service-request-types": { "get": { "tags": [ "Customers" ], "summary": "Returns customers' effective service request types.", "operationId": "getEffectiveServiceRequestTypesCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EffectiveCustomerServiceRequestTypeDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/available-customer-service-request-types": { "get": { "tags": [ "Customers" ], "summary": "Get available customer service request types for a customer", "operationId": "getAvailableCustomerServiceRequestTypesCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EffectiveCustomerServiceRequestTypeDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/get-customer-service-requests": { "put": { "tags": [ "Customers" ], "summary": "Returns customer service requests of a customer", "operationId": "getCustomerServiceRequestsCustomer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSummaryFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSummaryFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSummaryFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSummaryFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfCustomerServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/get-reseller-customer-service-requests": { "put": { "tags": [ "Customers" ], "summary": "Returns customer service requests of a reseller", "operationId": "getResellerCustomerServiceRequestsCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSummaryFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSummaryFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSummaryFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestSummaryFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfCustomerServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/device-types/{deviceTypeId}/device-type-variant-settings": { "get": { "tags": [ "Customers" ], "summary": "Retrieves reseller device type variant settings", "operationId": "getDeviceTypeVariantSettingsCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDeviceTypeVariantSettingDto" } } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Customers" ], "summary": "Create the device type variant settings of a reseller", "operationId": "createDeviceTypeVariantSettingsCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateCustomerDeviceTypeVariantSettingDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerDeviceTypeVariantSettingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerDeviceTypeVariantSettingDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCustomerDeviceTypeVariantSettingDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDeviceTypeVariantSettingDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "ErrorCode(NOT_ALLOWED_TO_EDIT_DEVICE_TYPE_VARIANT_SETTINGS): not allowed to edit device type variant settings ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/customer-service-request": { "post": { "tags": [ "Customers" ], "summary": "Creates a customer service request", "operationId": "createCustomerServiceRequestCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateCustomerServiceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerServiceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerServiceRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCustomerServiceRequestDto" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/customer-service-request-order": { "post": { "tags": [ "Customers" ], "summary": "Create a customer service request order for the designated customer service requests", "operationId": "createCustomerServiceRequestOrdersCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestOrderDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/device-types": { "get": { "tags": [ "Customers" ], "summary": "Get the device types and variants of a customer", "operationId": "getDeviceTypesCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lifeCycleStates", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/DeviceTypeLifecycleState" } }, "explode": false }, { "name": "includeResellerHiddenVariants", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeCustomerNonRegisteredDeviceTypes", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeCustomerNonRegisteredDeviceTypeVariants", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeServiceAreaUnassignedDeviceTypes", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeNonNetworkedDeviceTypes", "in": "query", "schema": { "type": "boolean" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceTypeWithVariantsDto" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/customer-relationship-path": { "get": { "tags": [ "Customers" ], "summary": "Gets the relationship path for the given customer with the specificed relationship type", "operationId": "getCustomerRelationshipPathCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationType", "in": "query", "schema": { "$ref": "#/components/schemas/CustomerRelationType" } }, { "name": "X-Client-System-Id", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/ancestor": { "get": { "tags": [ "Customers" ], "summary": "Get the required ancestor of a customer", "operationId": "getAncestorCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipType", "in": "query", "schema": { "$ref": "#/components/schemas/CustomerRelationType" } }, { "name": "X-Client-System-Id", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/device-type-documents": { "post": { "tags": [ "Customers" ], "summary": "Create a new device type document for a customer.", "operationId": "createCustomerDeviceTypeDocumentCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "deviceTypeId": { "type": "string", "format": "uuid" }, "language": { "type": "string" }, "title": { "maxLength": 100, "type": "string" }, "description": { "maxLength": 4000, "type": "string" }, "restrictedAccess": { "type": "boolean" }, "binaryFile": { "type": "string", "format": "binary" }, "fileLastModifiedAt": { "type": "string", "format": "date-time" } } }, "encoding": { "deviceTypeId": { "style": "form" }, "language": { "style": "form" }, "title": { "style": "form" }, "description": { "style": "form" }, "restrictedAccess": { "style": "form" }, "binaryFile": { "style": "form" }, "fileLastModifiedAt": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/device-type-documents": { "get": { "tags": [ "Customers" ], "summary": "Gets the stored documents for the customer with the given device type.", "operationId": "getCustomerDeviceTypeDocumentsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contentLanguages", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "explode": false }, { "name": "order", "in": "query", "schema": { "$ref": "#/components/schemas/BinaryFileOrderOptions" } }, { "name": "createdDateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "createdDateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "title", "in": "query", "schema": { "type": "string" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/device-type-links": { "post": { "tags": [ "Customers" ], "summary": "Create a new device type link for a customer.", "operationId": "createDeviceTypeLinkCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateCustomerDeviceTypeLinkDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerDeviceTypeLinkDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerDeviceTypeLinkDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCustomerDeviceTypeLinkDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDeviceTypeLinkDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/device-type-links": { "get": { "tags": [ "Customers" ], "summary": "Gets the stored links for the customer with the given device type.", "operationId": "getDeviceTypeLinksCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceTypeId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contentLanguages", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "explode": false }, { "name": "order", "in": "query", "schema": { "$ref": "#/components/schemas/BinaryFileOrderOptions" } }, { "name": "createdDateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "createdDateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "title", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDeviceTypeLinkDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{resellerId}/customer": { "post": { "tags": [ "Customers" ], "summary": "Creates a new customer", "operationId": "createNewCustomerCustomer", "parameters": [ { "name": "resellerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewCustomerDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewCustomerDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewCustomerDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewCustomerDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/descendants": { "get": { "tags": [ "Customers" ], "summary": "Get descendants of a customer", "operationId": "getDescendantsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relationshipType", "in": "query", "schema": { "$ref": "#/components/schemas/CustomerRelationType" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "recursive", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfCustomerDescedantDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/document-jobs/4plus-technician-report": { "post": { "tags": [ "Customers" ], "operationId": "createFourPlusTechnicianDocumentJobCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "timeZone", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateFourPlusTechnicianDocumentJobRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateFourPlusTechnicianDocumentJobRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateFourPlusTechnicianDocumentJobRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateFourPlusTechnicianDocumentJobRequestDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentJobDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/facility-management-clients": { "get": { "tags": [ "Customers" ], "summary": "Gets customers that are facility management clients of this customer.", "operationId": "getFacilityManagementClientsCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fullTextSearch", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfCustomerRelationChildDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Customers" ], "summary": "Add a facility management client to this customer.", "operationId": "addFacilityManagementClientCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/beneficiaries": { "get": { "tags": [ "Customers" ], "summary": "Gets customers that are beneficiaries of this customer.", "operationId": "getBeneficiariesCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fullTextSearch", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfCustomerRelationChildDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Customers" ], "summary": "Add a beneficiary to this customer.", "operationId": "addBeneficiaryCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/subsidiaries": { "get": { "tags": [ "Customers" ], "summary": "Gets customers that are subsidiaries of this customer.", "operationId": "getSubsidiariesCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fullTextSearch", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfCustomerRelationChildDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Customers" ], "summary": "Add a subsidiary to this customer.", "operationId": "addSubsidiaryCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/invoice-sources": { "get": { "tags": [ "Customers" ], "summary": "Gets customers that are invoice sources of this customer.", "operationId": "getInvoiceSourcesCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fullTextSearch", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfCustomerRelationChildDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Customers" ], "summary": "Add an invoice source to this customer.", "operationId": "addInvoiceSourceCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddCustomerRelationChildDto" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/facility-management-clients/{childCustomerId}": { "delete": { "tags": [ "Customers" ], "summary": "Remove a facility management client from this customer.", "operationId": "removeFacilityManagementClientCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "childCustomerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/beneficiaries/{childCustomerId}": { "delete": { "tags": [ "Customers" ], "summary": "Remove a beneficiary from this customer.", "operationId": "removeBeneficiaryCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "childCustomerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/subsidiaries/{childCustomerId}": { "delete": { "tags": [ "Customers" ], "summary": "Remove a subsidiary from this customer.", "operationId": "removeSubsidiaryCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "childCustomerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/invoice-sources/{childCustomerId}": { "delete": { "tags": [ "Customers" ], "summary": "Remove an invoice source from this customer.", "operationId": "removeInvoiceSourceCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "childCustomerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/support-organization": { "get": { "tags": [ "Customers" ], "summary": "Get support organization for root reseller customer", "operationId": "getCustomerSupportOrganizationForRootResellerSupportOrganization", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSupportOrganizationDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customer-service-requests/{id}/original-data": { "put": { "tags": [ "CustomerServiceRequests" ], "summary": "Update customer service request original data", "operationId": "updateCustomerServiceRequestOriginalDataCustomerServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerServiceRequestOriginalDataDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerServiceRequestOriginalDataDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerServiceRequestOriginalDataDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerServiceRequestOriginalDataDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customer-service-requests/{id}/handling-data": { "put": { "tags": [ "CustomerServiceRequests" ], "summary": "Update customer service request handling data", "operationId": "updateCustomerServiceRequestHandlingDataCustomerServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerServiceRequestHandlingDataDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerServiceRequestHandlingDataDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerServiceRequestHandlingDataDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerServiceRequestHandlingDataDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customer-service-requests/{id}": { "get": { "tags": [ "CustomerServiceRequests" ], "summary": "Retrieves customer service request details", "operationId": "getCustomerServiceRequestCustomerServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "CustomerServiceRequests" ], "summary": "Deletes a customer service request", "operationId": "deleteCustomerServiceRequestCustomerServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customer-service-requests/{id}/status": { "put": { "tags": [ "CustomerServiceRequests" ], "summary": "Update customer service request status", "operationId": "updateCustomerServiceRequestStatusCustomerServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ServiceRequestStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRequestStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceRequestStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ServiceRequestStatus" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customer-service-requests/{id}/billing-mode": { "get": { "tags": [ "CustomerServiceRequests" ], "summary": "Get billing mode for customer service request", "operationId": "getCustomerServiceRequestBillingModeCustomerServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingModeDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customer-service-requests/{id}/images": { "post": { "tags": [ "CustomerServiceRequests" ], "summary": "Add image to customer service request", "operationId": "addCustomerServiceRequestImageCustomerServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" }, "fileLastModifiedAt": { "type": "string", "format": "date-time" } } }, "encoding": { "uploadedFile": { "style": "form" }, "fileLastModifiedAt": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRequestImageDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customer-service-requests/{id}/images/{imageId}": { "delete": { "tags": [ "CustomerServiceRequests" ], "summary": "Deletes an image from customer service request", "operationId": "deleteCustomerServiceRequestImageCustomerServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "imageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customer-service-requests/{customerServiceRequestId}/notification-users/{userId}": { "post": { "tags": [ "CustomerServiceRequests" ], "summary": "Add a user to the notification list for the customer service request", "operationId": "addCustomerServiceRequestNotificationUserCustomerServiceRequest", "parameters": [ { "name": "customerServiceRequestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "CustomerServiceRequests" ], "summary": "Delete a user from the notification list for the customer service request", "operationId": "deleteCustomerServiceRequestNotificationUserCustomerServiceRequest", "parameters": [ { "name": "customerServiceRequestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customer-service-request-types/{id}": { "get": { "tags": [ "CustomerServiceRequestTypes" ], "summary": "Returns customer service request type", "operationId": "getCustomerServiceRequestTypeCustomerServiceRequestType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerServiceRequestTypeDto" } } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "CustomerServiceRequestTypes" ], "summary": "Update customer service request type", "operationId": "updateCustomerServiceRequestTypeCustomerServiceRequestType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateCustomerServiceRequestTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateCustomerServiceRequestTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateCustomerServiceRequestTypeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateCustomerServiceRequestTypeDto" } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerServiceRequestTypeDto" } } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "CustomerServiceRequestTypes" ], "summary": "Delete customer service request type", "operationId": "deleteCustomerServiceRequestTypeCustomerServiceRequestType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/analysis/sliced-net-changes": { "post": { "tags": [ "DataAnalyses" ], "summary": "Calculates the sum of net-changes per time-slice over all given data series sources for a customer's device filter. This analysis only yields correct results for resources that have monotonous behavior.", "operationId": "getSlicedNetChangesCustomerDataAnalysis", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SlicedNetChangesAnalysisRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SlicedNetChangesAnalysisRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SlicedNetChangesAnalysisRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SlicedNetChangesAnalysisRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SummedNetChangeResponseDto" } } } } }, "503": { "description": "ServiceUnavailable ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "BadRequest \n\nErrorCode(DATA_ANALYSIS_EXECUTION_EXPECTATION_FAILED): data analysis execution expectation failed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/analysis/net-change": { "post": { "tags": [ "DataAnalyses" ], "summary": "Calculates the sum of net-changes over all given data series sources for a customer's device filter. This analysis only yields correct results for resources that have monotonous behavior.", "operationId": "getNetChangeCustomerDataAnalysis", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NetChangeAnalysisRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NetChangeAnalysisRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NetChangeAnalysisRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NetChangeAnalysisRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummedUpNetChangeResponseDto" } } } }, "503": { "description": "ServiceUnavailable ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "BadRequest \n\nErrorCode(DATA_ANALYSIS_EXECUTION_EXPECTATION_FAILED): data analysis execution expectation failed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/analysis/ranked-net-changes": { "post": { "tags": [ "DataAnalyses" ], "summary": "Calculates an ordered ranking of net changes of all given devices in the customer scope.", "operationId": "getRankedNetChangesCustomerDataAnalysis", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderDirection", "in": "query", "schema": { "$ref": "#/components/schemas/OrderDirection" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RankedNetChangesAnalysisRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RankedNetChangesAnalysisRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RankedNetChangesAnalysisRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RankedNetChangesAnalysisRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummedRankedNetChangesDto" } } } }, "503": { "description": "ServiceUnavailable ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "BadRequest \n\nErrorCode(DATA_ANALYSIS_EXECUTION_EXPECTATION_FAILED): data analysis execution expectation failed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/analysis/summed-status-durations": { "post": { "tags": [ "DataAnalyses" ], "summary": "Calculates the summed durations a resource was in a specific status over all given data series sources within the customer scope.", "operationId": "getSummedStatusDurationsCustomerDataAnalysis", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SummedStatusDurationsAnalysisRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SummedStatusDurationsAnalysisRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SummedStatusDurationsAnalysisRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SummedStatusDurationsAnalysisRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummedStatusDurationResponseDto" } } } }, "503": { "description": "ServiceUnavailable ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "BadRequest \n\nErrorCode(DATA_ANALYSIS_EXECUTION_EXPECTATION_FAILED): data analysis execution expectation failed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/analysis/average-status-durations": { "post": { "tags": [ "DataAnalyses" ], "summary": "Calculates the average durations a resource was in a specific status over all given data series sources within the customer scope.", "operationId": "getAverageStatusDurationsCustomerDataAnalysis", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AverageStatusDurationsAnalysisRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AverageStatusDurationsAnalysisRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AverageStatusDurationsAnalysisRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AverageStatusDurationsAnalysisRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AverageStatusDurationResponseDto" } } } }, "503": { "description": "ServiceUnavailable ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "BadRequest \n\nErrorCode(DATA_ANALYSIS_EXECUTION_EXPECTATION_FAILED): data analysis execution expectation failed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/analysis/cycled-summed-net-changes": { "post": { "tags": [ "DataAnalyses" ], "summary": "Calculates the sum of net-changes per cycle and segment for a customer's device filter. This analysis only yields correct results for resources that have monotonous behavior.", "operationId": "getCycledSummedNetChangesCustomerDataAnalysis", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CycledSummedNetChangesAnalysisRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CycledSummedNetChangesAnalysisRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CycledSummedNetChangesAnalysisRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CycledSummedNetChangesAnalysisRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CycledSummedNetChangesResponseDto" } } } }, "503": { "description": "ServiceUnavailable ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "BadRequest \n\nErrorCode(DATA_ANALYSIS_EXECUTION_EXPECTATION_FAILED): data analysis execution expectation failed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/analysis/status-transition-count": { "post": { "tags": [ "DataAnalyses" ], "summary": "Calculates the count of status transitions over all given data series sources.", "operationId": "getStatusTransitionCountCustomerDataAnalysis", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/StatusTransitionCountAnalysisRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StatusTransitionCountAnalysisRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StatusTransitionCountAnalysisRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StatusTransitionCountAnalysisRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusTransitionCountResponseDto" } } } }, "503": { "description": "ServiceUnavailable ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "BadRequest \n\nErrorCode(DATA_ANALYSIS_EXECUTION_EXPECTATION_FAILED): data analysis execution expectation failed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{id}/analysis/sliced-summed-status-durations": { "post": { "tags": [ "DataAnalyses" ], "summary": "Calculates the summed durations a resource was in a specific status for each time slice, over all given data series sources.", "operationId": "getSlicedSummedStatusDurationsCustomerDataAnalysis", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SlicedSummedStatusDurationsAnalysisRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SlicedSummedStatusDurationsAnalysisRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SlicedSummedStatusDurationsAnalysisRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SlicedSummedStatusDurationsAnalysisRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SlicedSummedStatusDurationResponseDto" } } } } }, "503": { "description": "ServiceUnavailable ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "BadRequest \n\nErrorCode(DATA_ANALYSIS_EXECUTION_EXPECTATION_FAILED): data analysis execution expectation failed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/date-interval/validate": { "post": { "tags": [ "DateIntervals" ], "summary": "Validate date interval", "operationId": "validateDateInterval", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/date-interval/calculate-effective": { "post": { "tags": [ "DateIntervals" ], "summary": "Calculate effective date interval for a given definition", "operationId": "calculateEffectiveDateInterval", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbsoluteDateIntervalDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/date-interval/get-predefined": { "post": { "tags": [ "DateIntervals" ], "summary": "Get predefined date interval based on adaptive date interval", "operationId": "getPredefinedDateInterval", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RelativeDateIntervalDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RelativeDateIntervalDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RelativeDateIntervalDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RelativeDateIntervalDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertedPredefinedDateIntervalDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-filters/term-types": { "get": { "tags": [ "DeviceFilters" ], "summary": "Get all filter term types", "operationId": "getFilterTermTypesDeviceFilter", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceFilterTermTypeDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-filters/heuristic-result-analysis": { "put": { "tags": [ "DeviceFilters" ], "summary": "Gets heuristic information of the filters execution-result", "operationId": "getHeuristicResultAnalysisDeviceFilter", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceFilterHeuristicResultAnalysisDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-filters/result-analysis": { "put": { "tags": [ "DeviceFilters" ], "summary": "Gets information of the filters execution-result", "operationId": "getResultAnalysisDeviceFilter", "parameters": [ { "name": "customerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceFilterHeuristicResultAnalysisDto" } } } }, "403": { "description": "If the user does not have the Permission 'VIEW_DEVICES'", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-filters/validate-filter": { "put": { "tags": [ "DeviceFilters" ], "summary": "Validate device filter", "operationId": "validateFilterDeviceFilter", "parameters": [ { "name": "customerId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceFilterValidationMessageDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-filters/execute": { "put": { "tags": [ "DeviceFilters" ], "summary": "Execute device filter", "operationId": "executeFilterDeviceFilter", "parameters": [ { "name": "customerId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "image-min-width", "in": "header", "schema": { "type": "integer", "format": "int32" } }, { "name": "image-min-height", "in": "header", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeLocations", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeStatus", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeCompoundMembers", "in": "query", "schema": { "type": "boolean" } }, { "name": "doCompoundEnrichment", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeInstallationDates", "in": "query", "schema": { "type": "boolean" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "$ref": "#/components/schemas/DeviceOrdering" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfDeviceDto" } } } }, "404": { "description": "When no Customer can be found for the provided CustomerId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "If the user does not have the Permission 'VIEW_DEVICES'", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-forwarding-rules/{ruleId}": { "get": { "tags": [ "DeviceForwardingRules" ], "operationId": "loadRuleDeviceForwardingRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceForwardingRuleResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "DeviceForwardingRules" ], "operationId": "deleteRuleDeviceForwardingRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "DeviceForwardingRules" ], "operationId": "updateRuleDeviceForwardingRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceForwardingRuleUpdateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceForwardingRuleUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceForwardingRuleUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceForwardingRuleUpdateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceForwardingRuleResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-forwarding-rules": { "get": { "tags": [ "DeviceForwardingRules" ], "operationId": "loadRulesDeviceForwardingRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Returns DeviceForwardingRules by CustomerId", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceForwardingRuleResponseDto" } } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "DeviceForwardingRules" ], "operationId": "createRuleDeviceForwardingRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceForwardingRuleCreateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceForwardingRuleCreateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceForwardingRuleCreateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceForwardingRuleCreateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceForwardingRuleResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-forwarding-rules/{ruleId}/toggle-active-state": { "put": { "tags": [ "DeviceForwardingRules" ], "operationId": "toggleRuleActivationStatusDeviceForwardingRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-forwarding-rules/{ruleId}/force-update": { "put": { "tags": [ "DeviceForwardingRules" ], "operationId": "forceUpdateDeviceForwardingRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-forwarding-rules/{ruleId}/regenerate-streaming-key": { "put": { "tags": [ "DeviceForwardingRules" ], "operationId": "regenerateStreamingKeyDeviceForwardingRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-forwarding-rules/{ruleId}/regenerate-queue-key": { "put": { "tags": [ "DeviceForwardingRules" ], "operationId": "regenerateQueueKeyDeviceForwardingRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceForwardingConnectionQueueConnectionResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-ids/{uniqueIdentifier}": { "get": { "tags": [ "DeviceIds" ], "summary": "Resolve device ID by using any unique identifier of a component of the device", "operationId": "resolveDeviceIdDeviceId", "parameters": [ { "name": "uniqueIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceIdDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-images/{id}": { "get": { "tags": [ "DeviceImages" ], "summary": "Get a specific device-image.", "operationId": "getCustomerDeviceImagesDeviceImage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDeviceImageDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "patch": { "tags": [ "DeviceImages" ], "summary": "Updates metadata of a device image.", "operationId": "updateCustomerDeviceImageDeviceImage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BinaryBaseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BinaryBaseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BinaryBaseDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BinaryBaseDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDeviceImageDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "DeviceImages" ], "summary": "Deletes a device image.", "operationId": "deleteCustomerImageDeviceImage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-images/{id}/image": { "get": { "tags": [ "DeviceImages" ], "summary": "Get a device image binary", "operationId": "downloadCustomerDeviceImagesDeviceImage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "thumbnailSizeVariant", "in": "query", "schema": { "$ref": "#/components/schemas/ThumbnailSizeVariant" } } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-monitoring-rules/by-resource-data-observation-rule-id/{redoDeviceMonitoringRuleId}": { "get": { "tags": [ "DeviceMonitoringRules" ], "operationId": "loadByRedoDeviceMonitoringRuleIdDeviceMonitoringRule", "parameters": [ { "name": "redoDeviceMonitoringRuleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the DeviceMonitoringRule by RedoDeviceMonitoringRuleId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMonitoringRuleDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-monitoring-rules/by-resource-data-observation-rule-id/{redoDeviceMonitoringRuleId}/affected-devices-filter": { "get": { "tags": [ "DeviceMonitoringRules" ], "operationId": "loadAffectedDevicesFilterByRedoDeviceMonitoringRuleIdDeviceMonitoringRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "redoDeviceMonitoringRuleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Returns the Affected Devices Filter by RedoDeviceMonitoringRuleId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceFilterDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-monitoring-rules": { "get": { "tags": [ "DeviceMonitoringRules" ], "operationId": "loadRulesDeviceMonitoringRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Returns DeviceMonitoringRules by CustomerId", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceMonitoringRuleDto" } } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "DeviceMonitoringRules" ], "operationId": "createRuleDeviceMonitoringRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceMonitoringRuleCreateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMonitoringRuleCreateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceMonitoringRuleCreateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceMonitoringRuleCreateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMonitoringRuleDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-monitoring-rules/{ruleId}": { "delete": { "tags": [ "DeviceMonitoringRules" ], "operationId": "deleteRuleDeviceMonitoringRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "DeviceMonitoringRules" ], "operationId": "updateRuleDeviceMonitoringRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeviceMonitoringRuleUpdateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMonitoringRuleUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeviceMonitoringRuleUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeviceMonitoringRuleUpdateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMonitoringRuleDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-monitoring-rules/{ruleId}/toggle-active-state": { "put": { "tags": [ "DeviceMonitoringRules" ], "operationId": "toggleRuleActivationStatusDeviceMonitoringRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/device-monitoring-rules/{ruleId}/force-update": { "put": { "tags": [ "DeviceMonitoringRules" ], "operationId": "forceUpdateDeviceMonitoringRule", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-registrations": { "post": { "tags": [ "DeviceRegistrations" ], "summary": "Creates a new device registration for devices that are unregistered", "operationId": "registerDeviceDeviceRegistration", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceLocationAssignmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceLocationAssignmentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceLocationAssignmentDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceLocationAssignmentDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceLocationAssignmentDto" } } } }, "403": { "description": "When the user does not have the Permission EDIT_DEVICES_CompetenceClassCode for the customer of the target location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "500": { "description": "The Location cannot be found (LOCATION_NOT_A_MOUNTPOINT,LOCATION_MARKED_AS_DELETED)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "400": { "description": "When the Location cannot be found (LOCATION_NOT_FOUND).When the device is a DeviceSystem NOT_ALLOWED_TO_REGISTER_DEVICE_SYSTEM.When the device is not able to be registered alone DEVICE_NOT_STANDALONE", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "When the device is not found (DEVICE_NOT_FOUND)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "423": { "description": "When The customer is currently locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-registrations/{id}": { "put": { "tags": [ "DeviceRegistrations" ], "summary": "Updates a device registration", "operationId": "updateDeviceRegistrationDeviceRegistration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceLocationAssignmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceLocationAssignmentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceLocationAssignmentDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceLocationAssignmentDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceLocationAssignmentDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/operational-context": { "get": { "tags": [ "Devices" ], "summary": "Retrieves the current operational context of a device", "operationId": "getOperationalContextDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalContextDto" } } } }, "404": { "description": "The device is unknown or has no operational context because it is not activated" }, "403": { "description": "The user lacks the permission VIEW_DEVICES on the customer of the device", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/data-link-connections": { "get": { "tags": [ "Devices" ], "summary": "Retrieves data link information of a device", "operationId": "getDeviceDataLinksDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "includeHistorical", "in": "query", "schema": { "type": "boolean" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfDeviceDataLinkInfoDto" } } } }, "403": { "description": "ErrorCode(DEVICE_NOT_INSTALLED): device not installed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/data-link-expectation": { "get": { "tags": [ "Devices" ], "summary": "Retrieves data link connection status expectation of a device", "operationId": "getDeviceConnectionStatusExpectationDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionStatusExpectationDto" } } } }, "403": { "description": "ErrorCode(DEVICE_NOT_INSTALLED): device not installed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "Devices" ], "summary": "Sets data link connection status expectation of a device", "operationId": "setDeviceConnectionStatusExpectationDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "expectation", "in": "query", "schema": { "$ref": "#/components/schemas/ConnectionStatusExpectationDto" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionStatusExpectationDto" } } } }, "403": { "description": "ErrorCode(DEVICE_NOT_INSTALLED): device not installed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{networkId}/reset-statistics": { "put": { "tags": [ "Devices" ], "summary": "Resets the data link monitoring statistics of a device", "operationId": "resetDataLinkMonitoringStatisticsDevice", "parameters": [ { "name": "networkId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{networkId}/reset-online-status": { "put": { "tags": [ "Devices" ], "summary": "Resets the online status of a device", "operationId": "resetOnlineStatusDevice", "parameters": [ { "name": "networkId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/effective-problem-types": { "get": { "tags": [ "Devices" ], "summary": "Returns the effective problem types for a distinct device service request", "operationId": "getEffectiveProblemTypesForDistinctServiceRequestsDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EffectiveDeviceServiceRequestProblemTypeDto" } } } } }, "400": { "description": "ErrorCode(DEVICE_NOT_INSTALLED): device not installed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/effective-device-service-request-problem-types": { "get": { "tags": [ "Devices" ], "summary": "Returns the effective problem types for a distinct device service request", "operationId": "getEffectiveProblemTypesForDistinctDeviceServiceRequestsDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EffectiveDeviceServiceRequestProblemTypeDto" } } } } }, "400": { "description": "ErrorCode(DEVICE_NOT_INSTALLED): device not installed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/effective-resolution-types": { "get": { "tags": [ "Devices" ], "summary": "Returns the effective resolution types for a distinct service request", "operationId": "getEffectiveResolutionTypesForDistinctServiceRequestsDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeListingDto" } } } }, "400": { "description": "ErrorCode(DEVICE_NOT_INSTALLED): device not installed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/effective-device-service-request-resolution-types": { "get": { "tags": [ "Devices" ], "summary": "Returns the effective resolution types for a distinct service request", "operationId": "getEffectiveResolutionTypesForDistinctDeviceServiceRequestsDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeListingDto" } } } }, "400": { "description": "ErrorCode(DEVICE_NOT_INSTALLED): device not installed ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/distinct-service-requests-billing-mode": { "get": { "tags": [ "Devices" ], "summary": "Returns the billing mode for a distinct service request", "operationId": "getDistinctServiceRequestsBillingModeDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingMode" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/distinct-device-service-requests-billing-mode": { "get": { "tags": [ "Devices" ], "summary": "Returns the billing mode for a distinct service request", "operationId": "getDistinctDeviceServiceRequestsBillingModeDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingMode" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/service-requests": { "get": { "tags": [ "Devices" ], "summary": "Returns the device service requests summary", "operationId": "getServiceRequestDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ServiceRequestStatus" } }, "explode": false }, { "name": "activeStatus", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ServiceRequestActiveStatus" } }, "explode": false }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceServiceRequestDto" } } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/device-service-requests": { "get": { "tags": [ "Devices" ], "summary": "Returns the device service requests summary", "operationId": "getDeviceServiceRequestDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ServiceRequestStatus" } }, "explode": false }, { "name": "activeStatus", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ServiceRequestActiveStatus" } }, "explode": false }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceServiceRequestDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/suitable-refill-items": { "get": { "tags": [ "Devices" ], "summary": "Returns suitable refill items for device", "operationId": "getSuitableRefillItemsDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefillItemDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/refill-item-associations": { "post": { "tags": [ "Devices" ], "summary": "Creates a new association between a device and a refill item", "operationId": "createRefillItemAssociationDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } }, "application/*+json": { "schema": { "type": "integer", "format": "int32" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillItemDeviceAssociationDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/unregister": { "put": { "tags": [ "Devices" ], "summary": "Unregisters the device from the current location", "operationId": "unregisterDeviceDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "When the device was successfully unregistered" }, "403": { "description": "When the user does not have EDIT_DEVICES_CompetenceClassCode permission on the customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "ErrorCode DEVICE_NOT_INSTALLED when the device is currently not registered", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/move": { "put": { "tags": [ "Devices" ], "summary": "Move a device from one location to another", "operationId": "moveDeviceDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MoveDeviceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MoveDeviceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveDeviceDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveDeviceDto" } } } }, "responses": { "204": { "description": "No Content" }, "404": { "description": "When the device cannot be found or resolved with errorCode DEVICE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/move": { "put": { "tags": [ "Devices" ], "summary": "Move selected devices from one location to another in batch", "operationId": "moveDevicesDevice", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MoveDevicesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MoveDevicesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveDevicesDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveDevicesDto" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/attribute-values": { "get": { "tags": [ "Devices" ], "summary": "Returns all attributes of a device", "operationId": "getAttributeValuesDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SlimAttributeDetailsDto" } } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "Devices" ], "summary": "Modify attributes of a device", "operationId": "createOrUpdateAttributeValuesDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOrUpdateAttributeDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOrUpdateAttributeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOrUpdateAttributeDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOrUpdateAttributeDto" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SlimAttributeDetailsDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/customer-service-requests": { "get": { "tags": [ "Devices" ], "summary": "Get customer service requests of a device", "operationId": "getCustomerServiceRequestsOfDeviceDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerServiceRequestDetailsDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{systemDeviceId}/device-system-member-configuration": { "put": { "tags": [ "Devices" ], "summary": "Manage device system configuration", "operationId": "createOrUpdateDeviceSystemConfigurationDevice", "parameters": [ { "name": "systemDeviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateDeviceSystemMemberConfigurationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateDeviceSystemMemberConfigurationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateDeviceSystemMemberConfigurationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateDeviceSystemMemberConfigurationDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceSystemMemberConfigurationResponseDto" } } } }, "404": { "description": "When the DeviceSystem cant be found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "422": { "description": "When the request Dto is not formatted correctly (eg networkId is not a valid networkId)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "ErrorCodes: [DeviceTypeIdInvalid, ExistingComponentHasDifferentNetworkId, ComponentAlreadyExistsInPlaceholder] or ErrorCode VALIDATION_FAILED with ErrorDetailCode(s) [DeviceNotFound, MultipleUsagesOfSameDigitalTwinNotAllowed, MultipleUsagesOfSameComponentNotAllowed, ComponentsUsageInMultipleDigitalTwinsNotAllowed, ComponentPlaceholderIdNotFound, ComponentTypeNotAllowedInComponentPlaceholder, ComponentNotFound, ExistingComponentHasDifferentNetworkId, ReuseOfUsedPumpNotAllowed, ComponentIdentifierInvalid, DeviceAlreadyRegisteredWithinAnotherDeviceSystem, ExistingDeviceHasIncompatibleLifeCycleStatus, LifeCycleStateDecommissioned, DisallowedForDeviceSystemRegistration, SystemDeviceTypeMemberPlaceholderIdNotFound, DeviceTypeNotAllowedInPlaceholder, SystemDeviceMemberPlaceholderMaxNumberOfDevicesExceeded, DeviceAssignmentRequestInvalid, ComponentNotInAssignableState]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "If the user does not have the Permission(s) 'UNREGISTER_DEVICES, VIEW_DEVICES, EDIT_DEVICES_CompetenceClassCode' or the Capability'DEVICE_SYSTEMS'", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/move-to-stash": { "put": { "tags": [ "Devices" ], "summary": "Move a device from a location to the stash", "operationId": "moveDeviceToStashDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/move-to-stash": { "put": { "tags": [ "Devices" ], "summary": "Move devices from their location to the stash", "operationId": "moveDevicesToStashDevice", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MoveDevicesToStashDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MoveDevicesToStashDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveDevicesToStashDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveDevicesToStashDto" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "BadRequest ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/device-image": { "post": { "tags": [ "Devices" ], "operationId": "uploadCustomerDeviceImageDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "title": { "maxLength": 100, "type": "string" }, "description": { "maxLength": 4000, "type": "string" }, "restrictedAccess": { "type": "boolean" }, "binaryFile": { "type": "string", "format": "binary" }, "fileLastModifiedAt": { "type": "string", "format": "date-time" } } }, "encoding": { "title": { "style": "form" }, "description": { "style": "form" }, "restrictedAccess": { "style": "form" }, "binaryFile": { "style": "form" }, "fileLastModifiedAt": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDeviceImageDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/device-images": { "get": { "tags": [ "Devices" ], "operationId": "getCustomerDeviceImagesDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "order", "in": "query", "schema": { "$ref": "#/components/schemas/BinaryFileOrderOptions" } }, { "name": "createdDateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "createdDateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "title", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDeviceImageDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/device-documents": { "post": { "tags": [ "Devices" ], "summary": "Creates a new document assigned to a specific device.", "operationId": "createCustomerDeviceDocumentsDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "language": { "type": "string" }, "title": { "maxLength": 100, "type": "string" }, "description": { "maxLength": 4000, "type": "string" }, "restrictedAccess": { "type": "boolean" }, "binaryFile": { "type": "string", "format": "binary" }, "fileLastModifiedAt": { "type": "string", "format": "date-time" } } }, "encoding": { "language": { "style": "form" }, "title": { "style": "form" }, "description": { "style": "form" }, "restrictedAccess": { "style": "form" }, "binaryFile": { "style": "form" }, "fileLastModifiedAt": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "get": { "tags": [ "Devices" ], "summary": "Gets documents of a specific device.", "operationId": "getCustomerDeviceDocumentsDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contentLanguages", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "explode": false }, { "name": "order", "in": "query", "schema": { "$ref": "#/components/schemas/BinaryFileOrderOptions" } }, { "name": "createdDateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "createdDateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "title", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfDocumentDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/effective-documents": { "get": { "tags": [ "Devices" ], "summary": "Get effective documents from a specific device", "operationId": "getEffectiveDeviceDocumentDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contentLanguages", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "explode": false }, { "name": "order", "in": "query", "schema": { "$ref": "#/components/schemas/BinaryFileOrderOptions" } }, { "name": "createdDateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "createdDateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "title", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerSharedDocumentDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/effective-links": { "get": { "tags": [ "Devices" ], "summary": "Get effective links from a specific device", "operationId": "getEffectiveDeviceLinksDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contentLanguages", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "explode": false }, { "name": "order", "in": "query", "schema": { "$ref": "#/components/schemas/BinaryFileOrderOptions" } }, { "name": "createdDateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "createdDateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "title", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDeviceTypeLinkDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{deviceId}/system-members": { "get": { "tags": [ "Devices" ], "summary": "Get active system members of a device system", "operationId": "getSystemMembersDevice", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceDto" } } } } }, "404": { "description": "When the device cannot be found with errorCode DEVICE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "When the device is not a device system", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "When the device is not assigned to a customer or the user does not have VIEW_DEVICES permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{deviceId}/historical-system-members": { "post": { "tags": [ "Devices" ], "summary": "Create historical storage assignment", "description": "This endpoint is temporary and will be removed in future versions", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceSystemMemberAssignmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceSystemMemberAssignmentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceSystemMemberAssignmentDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceSystemMemberAssignmentDto" } } } }, "responses": { "201": { "description": "Created" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/setting-change-history": { "get": { "tags": [ "Devices" ], "summary": "Get settings changes for a specific device", "operationId": "getSettingChangesDevice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "adaptiveInterval", "in": "query", "schema": { "$ref": "#/components/schemas/PredefinedAdaptiveInterval" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "resourceInstanceNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "resourceType", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfDeviceSettingsChangeDto" } } } }, "404": { "description": "When the device cannot be found or resolved with errorCode DEVICE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "When user has insufficient permissions on customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "BadRequest ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/resource-value-history": { "get": { "tags": [ "Devices" ], "summary": "List resource values", "description": "Lists the resource values recorded for a single resource instance", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "resourceType", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "resourceInstanceNumber", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "predefinedAdaptiveDateInterval", "in": "query", "schema": { "$ref": "#/components/schemas/PredefinedAdaptiveInterval" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "onlyChangedValues", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfResourceValueHistoryEntryDto" } } } }, "404": { "description": "When the device cannot be found or resolved with errorCode DEVICE_NOT_FOUND", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/{id}/multi-resource-value-history": { "get": { "tags": [ "Devices" ], "summary": "List resource value history for multiple resources", "description": "Lists historical resource values for all resources of a device that are tagged with EVENTLIST in the Catalog Service", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "predefinedAdaptiveDateInterval", "in": "query", "schema": { "$ref": "#/components/schemas/PredefinedAdaptiveInterval" } }, { "name": "maximumNumberOfValues", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "onlyChangedValues", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MultiResourceValueHistoryEntryDto" } } } } }, "400": { "description": "When no resources available for the passed tag or the passed property values for filtering the date are invalid (e.g. from > to)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "When user has insufficient permissions on customer or on at least one EVENTLIST resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/devices/unregister": { "put": { "tags": [ "Devices" ], "summary": "Unregisters multiple devices from their current location", "operationId": "unregisterDevicesDevice", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UnregisterDevicesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnregisterDevicesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnregisterDevicesDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UnregisterDevicesDto" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-request-problem-types": { "post": { "tags": [ "DeviceServiceRequestProblemTypes" ], "summary": "Create a device service request problem type", "operationId": "createDeviceServiceRequestProblemTypeDeviceServiceRequestProblemType", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestProblemTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestProblemTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestProblemTypeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestProblemTypeDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-request-problem-types/{id}": { "put": { "tags": [ "DeviceServiceRequestProblemTypes" ], "summary": "Update a device service request problem type", "operationId": "updateDeviceServiceRequestProblemTypeDeviceServiceRequestProblemType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestProblemTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestProblemTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestProblemTypeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestProblemTypeDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "DeviceServiceRequestProblemTypes" ], "summary": "Delete a device service request problem type", "operationId": "deleteServiceRequestProblemTypeDeviceServiceRequestProblemType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-request-resolution-types": { "post": { "tags": [ "DeviceServiceRequestResolutionTypes" ], "summary": "Create a device service request resolution type", "operationId": "createServiceRequestResolutionTypeDeviceServiceRequestResolutionType", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestResolutionTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestResolutionTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestResolutionTypeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestResolutionTypeDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-request-resolution-types/{id}": { "put": { "tags": [ "DeviceServiceRequestResolutionTypes" ], "summary": "Update a device service request resolution type", "operationId": "updateServiceRequestResolutionTypeDeviceServiceRequestResolutionType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestResolutionTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestResolutionTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestResolutionTypeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestResolutionTypeDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "DeviceServiceRequestResolutionTypes" ], "summary": "Delete a device service request resolution type", "operationId": "deleteServiceRequestResolutionTypeDeviceServiceRequestResolutionType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distinct-device-service-requests": { "post": { "tags": [ "DeviceServiceRequests" ], "summary": "Creates a new distinct device service request", "operationId": "createDistinctDeviceServiceRequestDeviceServiceRequest", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDistinctDeviceServiceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDistinctDeviceServiceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDistinctDeviceServiceRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDistinctDeviceServiceRequestDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/indistinct-device-service-requests": { "post": { "tags": [ "DeviceServiceRequests" ], "summary": "Creates a new indistinct device service request", "operationId": "createIndistinctDeviceServiceRequestDeviceServiceRequest", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateIndistinctDeviceServiceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateIndistinctDeviceServiceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateIndistinctDeviceServiceRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateIndistinctDeviceServiceRequestDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-requests/{id}": { "get": { "tags": [ "DeviceServiceRequests" ], "summary": "Get device service request details", "operationId": "getDeviceServiceRequestDetailsDeviceServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "DeviceServiceRequests" ], "summary": "Delete device service request", "operationId": "deleteDeviceServiceRequestDeviceServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distinct-device-service-requests/{id}/original-data": { "put": { "tags": [ "DeviceServiceRequests" ], "summary": "Update distinct device service request original data", "operationId": "updateDistinctDeviceServiceRequestOriginalDataDeviceServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDistinctDeviceServiceRequestOriginalDataDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDistinctDeviceServiceRequestOriginalDataDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDistinctDeviceServiceRequestOriginalDataDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDistinctDeviceServiceRequestOriginalDataDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/indistinct-device-service-requests/{id}/original-data": { "put": { "tags": [ "DeviceServiceRequests" ], "summary": "Update indistinct device service request original data", "operationId": "updateIndistinctDeviceServiceRequestOriginalDataDeviceServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateIndistinctDeviceServiceRequestOriginalDataDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIndistinctDeviceServiceRequestOriginalDataDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateIndistinctDeviceServiceRequestOriginalDataDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateIndistinctDeviceServiceRequestOriginalDataDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-requests/{id}/handling-data": { "put": { "tags": [ "DeviceServiceRequests" ], "summary": "Update device service request handling data", "operationId": "updateDeviceServiceRequestHandlingDataDeviceServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestHandlingDataDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestHandlingDataDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestHandlingDataDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestHandlingDataDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-requests/{id}/status": { "put": { "tags": [ "DeviceServiceRequests" ], "summary": "Update device service requests' status", "operationId": "updateDeviceServiceRequestStatusDeviceServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ServiceRequestStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRequestStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceRequestStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ServiceRequestStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-requests/order": { "put": { "tags": [ "DeviceServiceRequests" ], "summary": "Order multiple device service requests", "operationId": "orderMultipleDeviceServiceRequestsDeviceServiceRequest", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-requests/{id}/images": { "post": { "tags": [ "DeviceServiceRequests" ], "summary": "Add image to service request", "operationId": "addDeviceServiceRequestImageDeviceServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" }, "fileLastModifiedAt": { "type": "string", "format": "date-time" } } }, "encoding": { "uploadedFile": { "style": "form" }, "fileLastModifiedAt": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRequestImageDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-requests/{id}/photos": { "post": { "tags": [ "DeviceServiceRequests" ], "summary": "Add photo to service request", "operationId": "addDeviceServiceRequestPhotoDeviceServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" }, "fileLastModifiedAt": { "type": "string", "format": "date-time" } } }, "encoding": { "uploadedFile": { "style": "form" }, "fileLastModifiedAt": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRequestImageDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-requests/{id}/images/{imageId}": { "delete": { "tags": [ "DeviceServiceRequests" ], "summary": "Deletes an image from service request", "operationId": "deleteDeviceServiceRequestImageDeviceServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "imageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-requests/{id}/photos/{photoId}": { "delete": { "tags": [ "DeviceServiceRequests" ], "summary": "Deletes a photo from service request", "operationId": "deleteDeviceServiceRequestPhotoDeviceServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "photoId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-service-requests/{id}/notification-users/{userId}": { "post": { "tags": [ "DeviceServiceRequests" ], "summary": "Add a user to the notification list for the device service request", "operationId": "addDeviceServiceRequestNotificationUserDeviceServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "DeviceServiceRequests" ], "summary": "Delete a user from the notification list for the device service request", "operationId": "deleteDeviceServiceRequestNotificationUserDeviceServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-system-registrations": { "post": { "tags": [ "DeviceSystemRegistrations" ], "summary": "Creates a new device system and assigns it to the location", "operationId": "createDeviceSystemDeviceSystemRegistration", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceSystemDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceSystemDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceSystemDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceSystemDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlimDeviceDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-type-links/{id}": { "get": { "tags": [ "DeviceTypeLinks" ], "summary": "Gets a specific device-type link.", "operationId": "getCustomerDeviceTypeLinkDeviceTypeLink", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceTypeLinkDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "patch": { "tags": [ "DeviceTypeLinks" ], "summary": "Updates a specific device-type link.", "operationId": "updateCustomerDeviceTypeLinkDeviceTypeLink", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerDeviceTypeLinkDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerDeviceTypeLinkDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerDeviceTypeLinkDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerDeviceTypeLinkDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceTypeLinkDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "DeviceTypeLinks" ], "summary": "Deletes a specific device-type link.", "operationId": "deleteCustomerDeviceTypeLinkDeviceTypeLink", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-types/{id}/variants": { "get": { "tags": [ "DeviceTypes" ], "summary": "Retrieves variants of a device type", "operationId": "getDeviceTypeVariantsDeviceType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceTypeVariantDto" } } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-types/{id}/attribute-groups": { "get": { "tags": [ "DeviceTypes" ], "summary": "Retrieves attribute groups of a device type", "operationId": "getDeviceTypeAttributeGroupsDeviceType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeGroupDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-types/{id}/resourceinstances": { "get": { "tags": [ "DeviceTypes" ], "summary": "Gets the superset of all resource instances defined for firmware types that can be part of the given device type", "operationId": "getDeviceTypeResourceInstancesDeviceType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tags", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "explode": false }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceTypeResourceInstanceDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/device-type-variant-settings/{deviceTypeVariantSettingId}": { "put": { "tags": [ "DeviceTypeVariantSettings" ], "summary": "Update customer device type variant settings", "operationId": "updateDeviceTypeVariantSettingsDeviceTypeVariantSetting", "parameters": [ { "name": "deviceTypeVariantSettingId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } }, "application/*+json": { "schema": { "type": "boolean" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDeviceTypeVariantSettingDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "ErrorCode(NOT_ALLOWED_TO_EDIT_DEVICE_TYPE_VARIANT_SETTINGS): not allowed to edit device type variant settings ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "DeviceTypeVariantSettings" ], "summary": "Deletes customer device type variant settings", "operationId": "deleteDeviceTypeVariantSettingsDeviceTypeVariantSetting", "parameters": [ { "name": "deviceTypeVariantSettingId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "ErrorCode(NOT_ALLOWED_TO_EDIT_DEVICE_TYPE_VARIANT_SETTINGS): not allowed to edit device type variant settings ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/document-job-documents/{id}/file": { "get": { "tags": [ "DocumentJobDocuments" ], "summary": "Downloads a document job result file.", "operationId": "downloadDocumentJobDocumentDocumentJobDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The document job result file.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/document-job-documents/{id}": { "get": { "tags": [ "DocumentJobDocuments" ], "summary": "Gets a document job document", "operationId": "getDocumentJobDocumentDocumentJobDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The document job document.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentJobDocumentDto" } } } }, "403": { "description": "ErrorCode(NOT_OWNED): The job that was requested is not owned by the accessing user and the accessing user does not have MANAGE_DOCUMENT_JOBS permission ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/document-jobs": { "get": { "tags": [ "DocumentJobs" ], "summary": "Lists document jobs", "operationId": "getDocumentJobsDocumentJob", "parameters": [ { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "allUsers", "in": "query", "schema": { "type": "boolean" } }, { "name": "createdAtFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "createdAtTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "customerId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "predefinedAdaptiveInterval", "in": "query", "schema": { "$ref": "#/components/schemas/PredefinedAdaptiveInterval" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "documentJobTypes", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/DocumentJobType" } }, "explode": false }, { "name": "status", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/DocumentJobStatus" } }, "explode": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfDocumentJobDto" } } } }, "400": { "description": "BadRequest ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/document-jobs/{id}": { "get": { "tags": [ "DocumentJobs" ], "summary": "Gets details about a document job", "operationId": "getDocumentJobDocumentJob", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentJobDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/document-jobs/{id}/cancel": { "put": { "tags": [ "DocumentJobs" ], "summary": "An endpoint that cancels a job in status Queued or Processing", "operationId": "cancelDocumentJobDocumentJob", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "ErrorCode(NOT_IN_CANCELABLE_STATUS): The job to be canceled is not in a status where it can actually be canceled. Cancelable status are 'Queued' and 'Processing' ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "ErrorCode(NOT_OWNED): The job that should be cancelled is not owned by the accessing user and the accessing user does not have MANAGE_DOCUMENT_JOBS permission ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/document-jobs/{id}/documents": { "get": { "tags": [ "DocumentJobs" ], "summary": "Lists documents of a document job", "operationId": "getDocumentJobDocumentsDocumentJob", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfDocumentJobDocumentDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/free-service-periods": { "post": { "tags": [ "FreeServicePeriods" ], "summary": "Create a free service period", "operationId": "createFreeServicePeriodFreeServicePeriod", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateFreeServicePeriodDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateFreeServicePeriodDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateFreeServicePeriodDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateFreeServicePeriodDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FreeServicePeriodDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/free-service-periods/{id}": { "put": { "tags": [ "FreeServicePeriods" ], "summary": "Update a free service period", "operationId": "updateFreeServicePeriodFreeServicePeriod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateFreeServicePeriodDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFreeServicePeriodDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFreeServicePeriodDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFreeServicePeriodDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FreeServicePeriodDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "FreeServicePeriods" ], "summary": "Delete a free service period", "operationId": "deleteFreeServicePeriodFreeServicePeriod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/full-service-contracts/{id}": { "delete": { "tags": [ "FullServiceContracts" ], "summary": "Delete a full service contract", "operationId": "deleteServiceAreaFullServiceContract", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "FullServiceContracts" ], "summary": "Update a full service contract", "operationId": "updateServiceAreaFullServiceContract", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateFullServiceContractDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFullServiceContractDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFullServiceContractDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFullServiceContractDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullServiceContractDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/full-service-contracts": { "post": { "tags": [ "FullServiceContracts" ], "summary": "Create a full service contract", "operationId": "createFullServiceContractFullServiceContract", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateFullServiceContractDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateFullServiceContractDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateFullServiceContractDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateFullServiceContractDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullServiceContractDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/buildings/{id}/building-areas": { "get": { "tags": [ "Locations" ], "summary": "Gets building areas of a building", "operationId": "getBuildingAreasInBuildingLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Locations" ], "summary": "Creates a new building area", "operationId": "createBuildingAreaLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } }, "400": { "description": "ErrorCode(ILLEGAL_LOCATION_NAME): illegal location name ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/buildings/{id}/floors": { "get": { "tags": [ "Locations" ], "summary": "Gets floors of a building", "operationId": "getFloorsInBuildingLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Locations" ], "summary": "Creates a new floor in building", "operationId": "createFloorInBuildingLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } }, "400": { "description": "ErrorCode(ILLEGAL_LOCATION_NAME): illegal location name ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/buildings/{id}": { "get": { "tags": [ "Locations" ], "summary": "Gets a building", "operationId": "getBuildingLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "patch": { "tags": [ "Locations" ], "summary": "Partially updates a building", "operationId": "patchBuildingLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BuildingUpdateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BuildingUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BuildingUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BuildingUpdateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "Locations" ], "summary": "Deletes a building", "operationId": "deleteBuildingLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeSubLocations", "in": "query", "schema": { "type": "boolean" } }, { "name": "deleteDependentData", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/building-areas/{id}/floors": { "get": { "tags": [ "Locations" ], "summary": "Gets floors of a building area", "operationId": "getFloorsInBuildingAreaLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Locations" ], "summary": "Creates a new floor in building area", "operationId": "createFloorInBuildingAreaLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } }, "400": { "description": "ErrorCode(ILLEGAL_LOCATION_NAME): illegal location name ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/building-areas/{id}": { "get": { "tags": [ "Locations" ], "summary": "Gets a building area", "operationId": "getBuildingAreaLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "patch": { "tags": [ "Locations" ], "summary": "Partially updates a building area", "operationId": "patchBuildingAreaLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "Locations" ], "summary": "Deletes a building area", "operationId": "deleteBuildingAreaLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeSubLocations", "in": "query", "schema": { "type": "boolean" } }, { "name": "deleteDependentData", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/floors/{id}/floor-areas": { "get": { "tags": [ "Locations" ], "summary": "Gets floor areas of a floor", "operationId": "getFloorAreasInFloorLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Locations" ], "summary": "Creates a new floor area in floor", "operationId": "createFloorAreasInFloorLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewLocationDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } }, "400": { "description": "ErrorCode(ILLEGAL_LOCATION_NAME): illegal location name ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/floors/{id}/rooms": { "get": { "tags": [ "Locations" ], "summary": "Gets rooms of a floor", "operationId": "getRoomsInFloorLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Locations" ], "summary": "Creates a new room in floor", "operationId": "createRoomInFloorLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewRoomDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewRoomDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewRoomDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewRoomDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomDto" } } } }, "400": { "description": "ErrorCode(ILLEGAL_LOCATION_NAME): illegal location name ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/floors/{id}": { "get": { "tags": [ "Locations" ], "summary": "Gets a floor", "operationId": "getFloorLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "patch": { "tags": [ "Locations" ], "summary": "Partially updates a floor", "operationId": "patchFloorLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "Locations" ], "summary": "Deletes a floor", "operationId": "deleteFloorLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeSubLocations", "in": "query", "schema": { "type": "boolean" } }, { "name": "deleteDependentData", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/floor-areas/{id}/rooms": { "get": { "tags": [ "Locations" ], "summary": "Gets rooms of a floor area", "operationId": "getRoomsInFloorAreaLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Locations" ], "summary": "Creates a new room in floor area", "operationId": "createRoomInFloorAreaLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewRoomDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewRoomDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewRoomDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewRoomDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomDto" } } } }, "400": { "description": "ErrorCode(ILLEGAL_LOCATION_NAME): illegal location name ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/floor-areas/{id}": { "get": { "tags": [ "Locations" ], "summary": "Gets a floor area", "operationId": "getFloorAreaLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "patch": { "tags": [ "Locations" ], "summary": "Partially updates a floor area", "operationId": "patchFloorAreaLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "Locations" ], "summary": "Deletes a floor area", "operationId": "deleteFloorAreaLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeSubLocations", "in": "query", "schema": { "type": "boolean" } }, { "name": "deleteDependentData", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/rooms/{id}": { "get": { "tags": [ "Locations" ], "summary": "Gets a room", "operationId": "getRoomLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "patch": { "tags": [ "Locations" ], "summary": "Partially updates a room", "operationId": "patchRoomLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RoomUpdateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RoomUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RoomUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RoomUpdateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "Locations" ], "summary": "Deletes a room", "operationId": "deleteRoomLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deleteDependentData", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/locations/{id}/reorder": { "put": { "tags": [ "Locations" ], "summary": "Reorders the children locations of a location", "operationId": "reorderLocationsObsoleteLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "ErrorCode(ALL_CHILDREN_LOCATIONS_MUST_BE_PROVIDED): all children locations must be provided ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/locations/reorder": { "put": { "tags": [ "Locations" ], "summary": "Reorders locations within the same level", "operationId": "reorderLocationsLocation", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReorderLocationsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReorderLocationsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderLocationsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderLocationsDto" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "ErrorCode(ALL_CHILDREN_LOCATIONS_MUST_BE_PROVIDED): all children locations must be provided ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/locations/move-to-customer": { "put": { "tags": [ "Locations" ], "summary": "Moves locations and devices to a different customer", "operationId": "moveToCustomerLocation", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MoveLocationsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MoveLocationsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveLocationsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveLocationsDto" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/locations/{id}": { "patch": { "tags": [ "Locations" ], "summary": "Performs a partial update on a location", "operationId": "updateLocationGenericLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChildLocationUpdateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChildLocationDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "Locations" ], "summary": "Deletes a location", "operationId": "deleteLocationGenericLocation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeSubLocations", "in": "query", "schema": { "type": "boolean" } }, { "name": "deleteDependentData", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/rooms/{id}/images": { "post": { "tags": [ "Locations" ], "summary": "Add an image to a room.", "operationId": "addImageToRoomRoom", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" }, "fileLastModifiedAt": { "type": "string", "format": "date-time" } } }, "encoding": { "uploadedFile": { "style": "form" }, "fileLastModifiedAt": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/rooms/{id}/images/{imageId}": { "delete": { "tags": [ "Locations" ], "summary": "Delete an image within a room.", "operationId": "deleteImageOfRoomRoom", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "imageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/users/{id}/personal-access-tokens": { "post": { "tags": [ "PersonalAccessTokens" ], "summary": "Create a PersonalAccessToken", "operationId": "createPersonalAccessToken", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatePersonalAccessTokenDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonalAccessTokenDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePersonalAccessTokenDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePersonalAccessTokenDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonalAccessTokenResponseDto" } } } }, "409": { "description": "When a token for the same Name already exists", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "When the user does not exist" }, "403": { "description": "When the capability PERSONAL_ACCESS_TOKENS is not granted to the system or when creating a token for a different user" }, "400": { "description": "When the validation fails" } }, "security": [ { "bearer": [ ] } ] }, "get": { "tags": [ "PersonalAccessTokens" ], "summary": "Get all PersonalAccessTokens of a user", "operationId": "getPersonalAccessToken", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalAccessTokenResponseDto" } } } } }, "404": { "description": "When the user does not exist" }, "403": { "description": "When the capability PERSONAL_ACCESS_TOKENS is not granted to the system or when reading tokens from another user without the permission EDIT_USERS" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/users/{id}/personal-access-tokens/{tokenId}": { "delete": { "tags": [ "PersonalAccessTokens" ], "summary": "Delete a PersonalAccessToken of a user", "operationId": "deletePersonalAccessToken", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tokenId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "When the user or the token does not exist" }, "403": { "description": "When the capability PERSONAL_ACCESS_TOKENS is not granted to the system or when deleting a token from another user without the permission EDIT_USERS" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/refill-items/{id}": { "put": { "tags": [ "RefillItems" ], "summary": "Update a refill item", "operationId": "updateRefillItemRefillItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateRefillItemDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRefillItemDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateRefillItemDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateRefillItemDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillItemDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "RefillItems" ], "summary": "Delete refill item", "operationId": "deleteRefillItemsRefillItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/refill-items": { "post": { "tags": [ "RefillItems" ], "summary": "Create a new refill item for a reseller", "operationId": "createRefillItemRefillItem", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateRefillItemDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateRefillItemDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRefillItemDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateRefillItemDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillItemDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/refill-items/{id}/incompatibilities": { "get": { "tags": [ "RefillItems" ], "summary": "Get refill item incompatibilities", "operationId": "getRefillItemIncompatibilitiesRefillItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefillItemDto" } } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "RefillItems" ], "summary": "Create a new refill item incompatibility", "operationId": "createRefillItemIncompatibilityRefillItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateRefillItemIncompatibilityDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateRefillItemIncompatibilityDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRefillItemIncompatibilityDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateRefillItemIncompatibilityDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillItemIncompatibilityDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/refill-items/{id}/incompatibilities/{incompatibleRefillItemId}": { "delete": { "tags": [ "RefillItems" ], "summary": "Delete a refill item incompatibility", "operationId": "deleteRefillItemIncompatibilityRefillItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "incompatibleRefillItemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/resource-data-event-publication-rules/{ruleId}": { "get": { "tags": [ "ResourceDataEventPublicationRules" ], "operationId": "loadRuleResourceDataEventPublication", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "ResourceDataEventPublicationRules" ], "operationId": "deleteRuleResourceDataEventPublication", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "ResourceDataEventPublicationRules" ], "operationId": "updateRuleResourceDataEventPublication", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleUpdateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleUpdateDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/resource-data-event-publication-rules": { "get": { "tags": [ "ResourceDataEventPublicationRules" ], "operationId": "loadRulesResourceDataEventPublication", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Returns ResourceDataEventPublicationRule by CustomerId", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleResponseDto" } } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "ResourceDataEventPublicationRules" ], "operationId": "createResourceDataEventPublication", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleCreateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleCreateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleCreateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleCreateDto" } } } }, "responses": { "200": { "description": "Returns the ResourceDataEventPublicationRule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/resource-data-event-publication-rules/{ruleId}/toggle-active-state": { "put": { "tags": [ "ResourceDataEventPublicationRules" ], "operationId": "toggleRuleActivationStatusResourceDataEventPublication", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/resource-data-event-publication-rules/{ruleId}/force-update": { "put": { "tags": [ "ResourceDataEventPublicationRules" ], "operationId": "forceUpdateResourceDataEventPublication", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/resource-data-event-publication-rules/{ruleId}/regenerate-streaming-key": { "put": { "tags": [ "ResourceDataEventPublicationRules" ], "operationId": "regenerateStreamingKeyResourceDataEventPublication", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/customers/{customerId}/resource-data-event-publication-rules/{ruleId}/regenerate-queue-key": { "put": { "tags": [ "ResourceDataEventPublicationRules" ], "operationId": "regenerateQueueKeyResourceDataEventPublication", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleQueueConnectionResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/selected-inheritance-refill-items/{id}": { "delete": { "tags": [ "SelectedInheritanceRefillItems" ], "summary": "Delete a selected inheritance refill item", "operationId": "deleteSelectedInheritanceRefillItemSelectedInheritanceRefillItem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/selected-inheritance-refill-items": { "post": { "tags": [ "SelectedInheritanceRefillItems" ], "summary": "Create a new selected inheritance refill item", "operationId": "createSelectedInheritanceRefillItemSelectedInheritanceRefillItem", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateSelectedInheritanceRefillItemDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateSelectedInheritanceRefillItemDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSelectedInheritanceRefillItemDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSelectedInheritanceRefillItemDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectedInheritanceRefillItemDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "SelectedInheritanceRefillItems" ], "summary": "Update selected inheritance refill items", "operationId": "updateSelectedInheritanceRefillItemsSelectedInheritanceRefillItem", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerSelectedInheritanceRefillItemsDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerSelectedInheritanceRefillItemsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerSelectedInheritanceRefillItemsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerSelectedInheritanceRefillItemsDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SelectedInheritanceRefillItemDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/service-areas": { "post": { "tags": [ "ServiceAreas" ], "summary": "Create a service area", "operationId": "createServiceAreaServiceArea", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateServiceAreaDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateServiceAreaDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateServiceAreaDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateServiceAreaDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAreaDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/service-areas/{serviceAreaId}": { "delete": { "tags": [ "ServiceAreas" ], "summary": "Delete a service area", "operationId": "deleteServiceAreaServiceArea", "parameters": [ { "name": "serviceAreaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "ServiceAreas" ], "summary": "Update a service area", "operationId": "updateServiceAreaServiceArea", "parameters": [ { "name": "serviceAreaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateServiceAreaDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateServiceAreaDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateServiceAreaDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateServiceAreaDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAreaDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/service-areas/{id}": { "get": { "tags": [ "ServiceAreas" ], "summary": "Get service area details", "operationId": "getServiceAreaDetailsServiceArea", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAreaDetailsDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/problem-types": { "post": { "tags": [ "ServiceRequestProblemTypes" ], "summary": "Create a service request problem type", "operationId": "createServiceRequestProblemTypeServiceRequestProblemType", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestProblemTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestProblemTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestProblemTypeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestProblemTypeDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/problem-types/{id}": { "put": { "tags": [ "ServiceRequestProblemTypes" ], "summary": "Update a service request problem type", "operationId": "updateServiceRequestProblemTypeServiceRequestProblemType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestProblemTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestProblemTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestProblemTypeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestProblemTypeDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "ServiceRequestProblemTypes" ], "summary": "Delete a service request problem type", "operationId": "deleteServiceRequestProblemTypeServiceRequestProblemType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/resolution-types": { "post": { "tags": [ "ServiceRequestResolutionTypes" ], "summary": "Create a service request resolution type", "operationId": "createServiceRequestResolutionTypeServiceRequestResolutionType", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestResolutionTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestResolutionTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestResolutionTypeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDeviceServiceRequestResolutionTypeDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/resolution-types/{id}": { "put": { "tags": [ "ServiceRequestResolutionTypes" ], "summary": "Update a service request resolution type", "operationId": "updateServiceRequestResolutionTypeServiceRequestResolutionType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestResolutionTypeDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestResolutionTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestResolutionTypeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestResolutionTypeDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "ServiceRequestResolutionTypes" ], "summary": "Delete a service request resolution type", "operationId": "deleteServiceRequestResolutionTypeServiceRequestResolutionType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distinct-service-requests": { "post": { "tags": [ "ServiceRequests" ], "summary": "Creates a new distinct service request", "operationId": "createDistinctServiceRequestServiceRequest", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDistinctDeviceServiceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDistinctDeviceServiceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDistinctDeviceServiceRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDistinctDeviceServiceRequestDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/indistinct-service-requests": { "post": { "tags": [ "ServiceRequests" ], "summary": "Creates a new indistinct service request", "operationId": "createIndistinctServiceRequestServiceRequest", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateIndistinctDeviceServiceRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateIndistinctDeviceServiceRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateIndistinctDeviceServiceRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateIndistinctDeviceServiceRequestDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/service-requests/{id}": { "get": { "tags": [ "ServiceRequests" ], "summary": "Get service request details", "operationId": "getServiceRequestDetailsServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "ServiceRequests" ], "summary": "Delete service request", "operationId": "deleteServiceRequestServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/distinct-service-requests/{id}/original-data": { "put": { "tags": [ "ServiceRequests" ], "summary": "Update distinct service request original data", "operationId": "updateDistinctServiceRequestOriginalDataServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDistinctDeviceServiceRequestOriginalDataDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDistinctDeviceServiceRequestOriginalDataDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDistinctDeviceServiceRequestOriginalDataDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDistinctDeviceServiceRequestOriginalDataDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/indistinct-service-requests/{id}/original-data": { "put": { "tags": [ "ServiceRequests" ], "summary": "Update indistinct service request original data", "operationId": "updateIndistinctServiceRequestOriginalDataServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateIndistinctDeviceServiceRequestOriginalDataDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIndistinctDeviceServiceRequestOriginalDataDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateIndistinctDeviceServiceRequestOriginalDataDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateIndistinctDeviceServiceRequestOriginalDataDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/service-requests/{id}/handling-data": { "put": { "tags": [ "ServiceRequests" ], "summary": "Update service request handling data", "operationId": "updateServiceRequestHandlingDataServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestHandlingDataDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestHandlingDataDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestHandlingDataDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDeviceServiceRequestHandlingDataDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/service-requests/{id}/status": { "put": { "tags": [ "ServiceRequests" ], "summary": "Update service requests' status", "operationId": "updateServiceRequestStatusServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ServiceRequestStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRequestStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceRequestStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ServiceRequestStatus" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceServiceRequestDetailsDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/service-requests/order": { "put": { "tags": [ "ServiceRequests" ], "summary": "Order multiple service requests", "operationId": "orderMultipleServiceRequestsServiceRequest", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "204": { "description": "No Content" } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/service-requests/{serviceRequestId}/images": { "post": { "tags": [ "ServiceRequests" ], "summary": "Add image to service request", "operationId": "addServiceRequestImageServiceRequest", "parameters": [ { "name": "serviceRequestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" }, "fileLastModifiedAt": { "type": "string", "format": "date-time" } } }, "encoding": { "uploadedFile": { "style": "form" }, "fileLastModifiedAt": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRequestImageDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/service-requests/{id}/photos": { "post": { "tags": [ "ServiceRequests" ], "summary": "Add photo to service request", "operationId": "addServiceRequestPhotoServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" }, "fileLastModifiedAt": { "type": "string", "format": "date-time" } } }, "encoding": { "uploadedFile": { "style": "form" }, "fileLastModifiedAt": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRequestImageDto" } } } } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/service-requests/{serviceRequestId}/images/{imageId}": { "delete": { "tags": [ "ServiceRequests" ], "summary": "Deletes an image from service request", "operationId": "deleteServiceRequestImageServiceRequest", "parameters": [ { "name": "serviceRequestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "imageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/service-requests/{id}/photos/{photoId}": { "delete": { "tags": [ "ServiceRequests" ], "summary": "Deletes a photo from service request", "operationId": "deleteServiceRequestPhotoServiceRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "photoId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "deprecated": true, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/stored-device-filters/{id}": { "get": { "tags": [ "StoredDeviceFilters" ], "summary": "Get a single stored device filter by ID", "operationId": "getDeviceFilterStoredDeviceFilter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoredDeviceFilterDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "StoredDeviceFilters" ], "summary": "Update a stored device filter by ID", "operationId": "updateStoredDeviceFilterStoredDeviceFilter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateStoredDeviceFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStoredDeviceFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateStoredDeviceFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateStoredDeviceFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoredDeviceFilterDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "StoredDeviceFilters" ], "summary": "Delete a stored device filter by ID", "operationId": "deleteDeviceFilterStoredDeviceFilter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/stored-device-filters/{id}/validation-report": { "get": { "tags": [ "StoredDeviceFilters" ], "summary": "Validate stored device filter by ID", "operationId": "validateDeviceFilterStoredDeviceFilter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationResultDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/stored-device-filters/{id}/visibility": { "put": { "tags": [ "StoredDeviceFilters" ], "summary": "Update a stored device filter visibility by ID", "operationId": "updateStoredDeviceFilterVisibilityStoredDeviceFilter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateStoredDeviceFilterVisibilityDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStoredDeviceFilterVisibilityDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateStoredDeviceFilterVisibilityDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateStoredDeviceFilterVisibilityDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoredDeviceFilterDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/stored-device-filters/{id}/copy": { "put": { "tags": [ "StoredDeviceFilters" ], "summary": "Copy stored device filter by ID", "operationId": "copyDeviceFilterStoredDeviceFilter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CopyDeviceFilterDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CopyDeviceFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CopyDeviceFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CopyDeviceFilterDto" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoredDeviceFilterDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/assigned-users": { "get": { "tags": [ "System" ], "summary": "Get all users that have a role assigned on the system", "operationId": "getSystemAssignedUsersAssignedUsers", "parameters": [ { "name": "userStatus", "in": "query", "description": "List of user status to filter, separated by comma.", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/UserStatusDto" } }, "explode": false }, { "name": "fullTextSearch", "in": "query", "description": "String to perform full text search. Search is performed on columns FirstName, LastName, Email and Affiliation.\r\nString can include multiple terms (e.g., \"search this\") or match by prefix (e.g., \"sea*\").", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfUserDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/assigned-users/{id}/assigned-roles": { "get": { "tags": [ "System" ], "summary": "Get all roles that a user is assigned on the system securable", "operationId": "getSystemAssignedUserAssignedRolesAssignedUsers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientSystemIds", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "explode": false }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDto" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfSystemRoleAssignmentDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/countries": { "get": { "tags": [ "System" ], "summary": "Get available countries", "operationId": "getCountriesCountries", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountryDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/hygiene-portal-applications": { "get": { "tags": [ "System" ], "summary": "List of hygiene portal applications", "operationId": "getHygienePortalApplications", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalApplicationDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/instance-branding": { "get": { "tags": [ "System" ], "summary": "Get the branding definition for the whole instance.", "operationId": "getInstanceBranding", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandingDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/languages": { "get": { "tags": [ "System" ], "summary": "Get available languages", "operationId": "getLanguagesLanguages", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/permissions": { "get": { "tags": [ "System" ], "summary": "Get available permissions", "operationId": "getPermissionsPermissions", "parameters": [ { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "permissionType", "in": "query", "schema": { "$ref": "#/components/schemas/PermissionType" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } }, { "name": "X-Client-System-Id", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfPermissionDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/permissions/all-permissions": { "get": { "tags": [ "System" ], "summary": "Get all available permissions", "operationId": "getAllPermissionsPermissions", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/refill-families": { "get": { "tags": [ "System" ], "summary": "Get all refill families", "operationId": "getAllRefillFamiliesRefillFamily", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefillFamilyDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/resource-instance-equivalents": { "get": { "tags": [ "System" ], "summary": "Get available resource instance equivalents", "operationId": "getAllResourceInstanceEquivalentsResourceInstanceEquivalent", "parameters": [ { "name": "tags", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "explode": false }, { "name": "dataType", "in": "query", "schema": { "$ref": "#/components/schemas/SpecificDataType" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceInstanceEquivalentDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/roles": { "get": { "tags": [ "System" ], "summary": "Get available roles", "operationId": "getRolesRoles", "parameters": [ { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "clientSystemIds", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "explode": false }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfRoleDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "System" ], "summary": "Create a role", "operationId": "createRoleRoles", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/roles/{id}/associated-permissions": { "get": { "tags": [ "System" ], "summary": "Get associated permissions of role", "operationId": "getAssociatedPermissionsOfRoleRoles", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/roles/role-permission-assignments": { "get": { "tags": [ "System" ], "summary": "Get role permissions assignments.", "operationId": "getRolePermissionAssignmentsRoles", "parameters": [ { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfRolePermissionDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/roles/definitions": { "get": { "tags": [ "System" ], "summary": "Get role permissions definitions.", "operationId": "getRolePermissionDefinitionsRoles", "parameters": [ { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleDefinitionDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/roles/import-definitions": { "put": { "tags": [ "System" ], "summary": "Import role permissions definitions.", "operationId": "importRoleDefinitionsRoles", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleDefinitionDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleDefinitionDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleDefinitionDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleDefinitionDto" } } } } }, "responses": { "200": { "description": "Import successful" }, "207": { "description": "Returns a list of error messages", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportRoleDefinitionResultEntryDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/roles/{roleId}": { "delete": { "tags": [ "System" ], "summary": "Delete role", "operationId": "deleteRoleRoles", "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "System" ], "summary": "Update a role", "operationId": "updateRoleRoles", "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateRoleDto" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/user/{userId}/notifications/delivery-preferences": { "get": { "tags": [ "UserCommunication" ], "operationId": "loadNotifications", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Loads the notification delivery preferences for a recipient", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDeliveryPreferenceResponseContainerDto" } } } }, "422": { "description": "When validation fails, the errors are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "When the user cannot be found" } }, "security": [ { "bearer": [ ] } ] }, "patch": { "tags": [ "UserCommunication" ], "operationId": "upsertNotifications", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDeliveryPreferenceRequestDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDeliveryPreferenceRequestDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDeliveryPreferenceRequestDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDeliveryPreferenceRequestDto" } } } } }, "responses": { "204": { "description": "Updates the notification-preferences for a specific user." }, "422": { "description": "When validation fails, the errors are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "When the user cannot be found" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/user/{userId}/notifications/push-notification-tokens": { "put": { "tags": [ "UserCommunication" ], "operationId": "upsertPushNotificationTokensNotifications", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "204": { "description": "Adds a push-notification token to the the recipient." }, "422": { "description": "When the input values are invalid." }, "404": { "description": "When the user cannot be found" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/user/{userId}/notifications/push-notification-tokens/{token}": { "delete": { "tags": [ "UserCommunication" ], "operationId": "deletePushNotificationTokensNotifications", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Removes a push-notification token of the recipient." }, "404": { "description": "When the user cannot be found" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/user/{userId}/user-notifications": { "get": { "tags": [ "UserCommunication" ], "operationId": "loadUserNotifications", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the notifications for a specific user. Empty when notifications cannot be found", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotificationResponseDto" } } } } }, "403": { "description": "When the provided userId does not belong to the current user" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/user/{userId}/user-notifications/mark-as-read/{notificationId}": { "patch": { "tags": [ "UserCommunication" ], "operationId": "markAsReadUserNotifications", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "notificationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Marks the notification for the provided user as read." }, "403": { "description": "When the provided userId does not belong to the current user" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/user/{userId}/user-notifications/mark-as-unread/{notificationId}": { "patch": { "tags": [ "UserCommunication" ], "operationId": "markAsUnReadUserNotifications", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "notificationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Marks the notification for the provided user as unread." }, "403": { "description": "When the provided userId does not belong to the current user" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/user/{userId}/user-notifications/mark-all-unread-as-read": { "patch": { "tags": [ "UserCommunication" ], "operationId": "markAllAsReadUserNotifications", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Marks all unread notifications of the provided user as read." }, "403": { "description": "When the provided userId does not belong to the current user" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/user/{userId}/user-notifications/statistics": { "get": { "tags": [ "UserCommunication" ], "operationId": "statisticsUserNotifications", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Gets the user-notification-statistics for a specific user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotificationStatisticsResponseDto" } } } }, "403": { "description": "When the provided userId does not belong to the current user" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/users": { "get": { "tags": [ "Users" ], "summary": "Get users", "operationId": "getUsersUser", "parameters": [ { "name": "userStatus", "in": "query", "description": "List of user status to filter, separated by comma. No filter is applied by default.", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/UserStatusDto" } }, "explode": false }, { "name": "fullTextSearch", "in": "query", "description": "String to perform full text search. Search is performed on columns FirstName, LastName, Email and Affiliation.\r\nString can include multiple terms (e.g., \"search this\") or match by prefix (e.g., \"sea*\").", "schema": { "type": "string" } }, { "name": "externallyManagedFilter", "in": "query", "description": "Indicates if should return only externally managed, non externally managed or all users. Defaults to All.", "schema": { "$ref": "#/components/schemas/ExternallyManagedFilterDto" } }, { "name": "userOrdering", "in": "query", "description": "Indicates ordering of users in response. Defaults to ordering by Name.", "schema": { "$ref": "#/components/schemas/UserOrderingDto" } }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfUserDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/users/{id}": { "get": { "tags": [ "Users" ], "summary": "Get user by id", "operationId": "getUserUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/users/favorite-customers": { "get": { "tags": [ "CustomerSelection" ], "summary": "Gets the customer favorites of current user", "parameters": [ { "name": "X-Client-System-Id", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/users/recently-accessed-customers": { "get": { "tags": [ "CustomerSelection" ], "summary": "Gets the recently accessed customers of current user", "parameters": [ { "name": "X-Client-System-Id", "in": "header", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecentlyAccessedCustomerDto" } } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/users/{id}/availability-capability-grants": { "get": { "tags": [ "Capabilities" ], "summary": "Gets the availability capability grants on this user", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AvailabilityCapabilityGrantDto" } } } } } }, "security": [ { "bearer": [ ] } ] }, "post": { "tags": [ "Capabilities" ], "summary": "Grants an availability capability to this user", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUserCapabilityGrantDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserCapabilityGrantDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserCapabilityGrantDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUserCapabilityGrantDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCapabilityGrantDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/users/{id}/availability-capability-grants/{code}": { "get": { "tags": [ "Capabilities" ], "summary": "Gets the grant for a specific availability capability for this user", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCapabilityGrantDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "Capabilities" ], "summary": "Updates an availability capability for this user", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateUserCapabilityGrantDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserCapabilityGrantDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserCapabilityGrantDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUserCapabilityGrantDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityCapabilityGrantDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "delete": { "tags": [ "Capabilities" ], "summary": "Removes the availability capability grant for a specific capability from the user", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/users/{id}/status": { "put": { "tags": [ "Users" ], "summary": "Set a user's status", "operationId": "updateUserStatusUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserStatusDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserStatusDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserStatusDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/users/{id}/unit-preferences": { "get": { "tags": [ "Users" ], "summary": "Gets the user's unit preferences", "operationId": "getUserUnitPreferencesUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUnitPreferencesDto" } } } } }, "security": [ { "bearer": [ ] } ] }, "put": { "tags": [ "Users" ], "summary": "Set user's unit preferences", "operationId": "updateUserUnitPreferencesUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserUnitPreferencesDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserUnitPreferencesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserUnitPreferencesDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserUnitPreferencesDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUnitPreferencesDto" } } } } }, "security": [ { "bearer": [ ] } ] } }, "/api/standard/v1/users/{id}/customer-assigned-roles": { "get": { "tags": [ "Users" ], "summary": "Lists all role assignments a user has on any customers", "operationId": "getUserCustomersRoleAssignmentsUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientSystemIds", "in": "query", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "explode": false }, { "name": "pageSize", "in": "query", "description": "The number of entries returned per page. If none specified, returns all entries in a single page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number to be returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "accept-language", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResultDtoOfUserCustomerRoleAssignmentsDto" } } } } }, "security": [ { "bearer": [ ] } ] } } }, "components": { "schemas": { "AbsoluteDateIntervalDto": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "startIncluded": { "type": "boolean" }, "endIncluded": { "type": "boolean" } }, "additionalProperties": false }, "AddCustomerRelationChildDto": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AnalysisResourceDto": { "required": [ "identification", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AnalysisResourceType" }, "identification": { "$ref": "#/components/schemas/AnalysisResourceIdentificationDto" } }, "additionalProperties": false, "description": "Defines the resource selector for analysis requests." }, "AnalysisResourceIdentificationDto": { "type": "object", "properties": { "resourceEquivalentId": { "type": "string", "description": "UUID of the resource equivalent.\r\nRequired when `resource.type` is `ResourceEquivalent`.", "format": "uuid", "nullable": true }, "resourceType": { "type": "integer", "description": "Resource type identifier.\r\nRequired when `resource.type` is `ResourceInstance`.", "format": "int32", "nullable": true }, "resourceInstanceNumber": { "type": "integer", "description": "Resource instance number.\r\nRequired when `resource.type` is `ResourceInstance`.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Identification payload for Hsm.ClientService.Api.ApiGroups.Standard.V1.DTOs.NetChanges.AnalysisResourceDto.\r\nThe required property set depends on `resource.type`." }, "AnalysisResourceType": { "enum": [ "ResourceEquivalent", "ResourceInstance" ], "type": "string", "description": "Supported resource selector types for analysis requests." }, "AndDto": { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceFilterTermDto" }, "nullable": true } }, "additionalProperties": false }, "AssociatedCustomerCountDto": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "allCustomers": { "type": "boolean" } }, "additionalProperties": false }, "AttributeDto": { "type": "object", "properties": { "attributeId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "dataSettings": { "$ref": "#/components/schemas/DataSettingsDto" } }, "additionalProperties": false }, "AttributeGroupDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeDto" }, "nullable": true } }, "additionalProperties": false }, "AvailabilityCapabilityDto": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "availabilityLevel": { "$ref": "#/components/schemas/AvailabilityLevel" } }, "additionalProperties": false }, "AvailabilityCapabilityGrantDto": { "type": "object", "properties": { "capabilityCode": { "type": "string", "nullable": true }, "availabilityLevel": { "$ref": "#/components/schemas/AvailabilityLevel" }, "externallyManaged": { "type": "boolean" } }, "additionalProperties": false }, "AvailabilityCapabilityGrantWithTypeDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CapabilityType" }, "capabilityCode": { "type": "string", "nullable": true }, "availabilityLevel": { "$ref": "#/components/schemas/AvailabilityLevel" }, "externallyManaged": { "type": "boolean" } }, "additionalProperties": false }, "AvailabilityLevel": { "enum": [ "Hidden", "Disabled", "Available" ], "type": "string" }, "AverageStatusDurationDto": { "required": [ "durationInSeconds", "statusValue" ], "type": "object", "properties": { "statusValue": { "type": "integer", "description": "The numeric status value", "format": "int32" }, "statusName": { "type": "string", "description": "The translated name of the status (if available)", "nullable": true }, "durationInSeconds": { "type": "integer", "description": "The average duration in seconds for this status", "format": "int32" } }, "additionalProperties": false, "description": "DTO representing average duration for a specific status value with optional translated name" }, "AverageStatusDurationResponseDto": { "required": [ "durations" ], "type": "object", "properties": { "durations": { "type": "array", "items": { "$ref": "#/components/schemas/AverageStatusDurationDto" }, "description": "Collection of status durations with translated names" } }, "additionalProperties": false, "description": "Container response DTO for average status durations with translated status names" }, "AverageStatusDurationsAnalysisRequestDto": { "required": [ "dateIntervalDefinition", "deviceFilter", "locale", "resource", "statusValues", "timeZone" ], "type": "object", "properties": { "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "resource": { "$ref": "#/components/schemas/AnalysisResourceDto" }, "dateIntervalDefinition": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" }, "timeZone": { "maxLength": 40, "minLength": 1, "type": "string" }, "locale": { "maxLength": 35, "minLength": 1, "type": "string" }, "statusValues": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "BillingMode": { "enum": [ "FreeOfCharge", "CostsMayApply" ], "type": "string" }, "BillingModeDto": { "type": "object", "properties": { "billingMode": { "$ref": "#/components/schemas/BillingMode" } }, "additionalProperties": false }, "BinaryBaseDto": { "type": "object", "properties": { "title": { "maxLength": 100, "type": "string", "nullable": true }, "description": { "maxLength": 4000, "type": "string", "nullable": true }, "restrictedAccess": { "type": "boolean" } }, "additionalProperties": false }, "BinaryFileOrderOptions": { "enum": [ "TitleAscending", "TitleDescending", "UploadDateAscending", "UploadDateDescending" ], "type": "string" }, "BirthDateFilterDto": { "type": "object", "properties": { "dateIntervalDefinition": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" } }, "additionalProperties": false }, "BoolFilterConditionDto": { "allOf": [ { "$ref": "#/components/schemas/ExpressionedFilterConditionDto" }, { "type": "object", "properties": { "value": { "type": "boolean" } }, "additionalProperties": false } ] }, "BooleanDataSettingsDto": { "type": "object", "properties": { "trueTranslated": { "type": "string", "nullable": true }, "trueLokaliseKey": { "type": "string", "nullable": true }, "falseTranslated": { "type": "string", "nullable": true }, "falseLokaliseKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BooleanDisplayHintDto": { "type": "object", "additionalProperties": false }, "BooleanToggleDisplayControlDto": { "type": "object", "additionalProperties": false }, "BooleanValueClassification": { "type": "object", "properties": { "value": { "type": "boolean" } }, "additionalProperties": false }, "BooleanValueClassificationDto": { "type": "object", "properties": { "value": { "type": "boolean" } }, "additionalProperties": false }, "BrandingClientSpecificOptionsDto": { "type": "object", "properties": { "webPortal": { "$ref": "#/components/schemas/BrandingWebPortalSpecificOptionsDto" } }, "additionalProperties": false }, "BrandingColorDto": { "type": "object", "properties": { "hexCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BrandingDisplayModeVariablesDto": { "type": "object", "properties": { "companyLogo": { "type": "string", "format": "uri", "nullable": true }, "navigationBarCompanyLogo": { "type": "string", "format": "uri", "nullable": true }, "mainColor300": { "$ref": "#/components/schemas/BrandingColorDto" }, "mainColor500": { "$ref": "#/components/schemas/BrandingColorDto" }, "mainColor700": { "$ref": "#/components/schemas/BrandingColorDto" }, "mainContrastColor": { "$ref": "#/components/schemas/BrandingColorDto" }, "navigationBarColor": { "$ref": "#/components/schemas/BrandingColorDto" }, "navigationBarContrastColor": { "$ref": "#/components/schemas/BrandingColorDto" }, "selectionColor": { "$ref": "#/components/schemas/BrandingColorDto" }, "severityOkColor": { "$ref": "#/components/schemas/BrandingColorDto" }, "severityWarningColor": { "$ref": "#/components/schemas/BrandingColorDto" }, "severityErrorColor": { "$ref": "#/components/schemas/BrandingColorDto" }, "severityNeutralColor": { "$ref": "#/components/schemas/BrandingColorDto" } }, "additionalProperties": false }, "BrandingDto": { "type": "object", "properties": { "productName": { "type": "string", "nullable": true }, "productNameAbbreviation": { "type": "string", "nullable": true }, "instanceOperator": { "type": "string", "nullable": true }, "clientSpecificOptions": { "$ref": "#/components/schemas/BrandingClientSpecificOptionsDto" }, "displayModeDark": { "$ref": "#/components/schemas/BrandingDisplayModeVariablesDto" }, "displayModeLight": { "$ref": "#/components/schemas/BrandingDisplayModeVariablesDto" } }, "additionalProperties": false }, "BrandingWebPortalSpecificOptionsDto": { "type": "object", "properties": { "favIcon": { "type": "string", "format": "uri", "nullable": true }, "welcomePageImage": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "BuildingUpdateDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CapabilityCode": { "enum": [ "ADVANCED_DATA_ANALYSIS", "ANALYSIS_SLICED_NET_CHANGES", "ANALYSIS_NET_CHANGE", "ANALYSIS_RANKED_NET_CHANGES", "ANALYSIS_SUMMED_STATUS_DURATIONS", "ANALYSIS_AVERAGE_STATUS_DURATIONS", "ANALYSIS_CYCLED_SUMMED_NET_CHANGES", "ANALYSIS_SLICED_SUMMED_STATUS_DURATIONS", "ANALYSIS_STATUS_TRANSITION_COUNT", "ANALYSIS_STATUS_DURATIONS", "ANALYSIS_SIMPLE_MODE", "APP_DEVICE_CLASSIFICATION", "CONNECT_NON_MATCHING_OEM_DEVICES", "CUSTOMER_BRANDING", "CUSTOMER_CALENDAR", "CUSTOMER_CREATION", "CUSTOMER_SERVICE_REQUESTS", "CUSTOMER_DEVICE_TYPE_EXTENSIONS", "DEVICE_DOCUMENTS", "DEVICE_FORWARDING", "DEVICE_IMAGES", "DEVICE_LINKS", "DEVICE_MONITORING", "DEVICE_SYSTEMS", "CLOUD_TO_DEVICE_DISTRIBUTION", "DEVICE_SERVICE_REQUESTS", "FIRMWARE_PRERELEASE", "REFILLS", "RESOURCE_DATA_EVENT_PUBLICATION", "SALES_SUPPORT", "TECHNICAL_CHECK", "THIRD_PARTY_API", "DEVICES_WITHOUT_CUSTOMER_CONTEXT", "DOCUMENT_JOBS", "MANAGE_UNREGISTERED_DEVICES", "MY_ACCOUNT", "USER_INVITATION", "UNIT_PREFERENCES", "USER_NOTIFICATION", "PERSONAL_ACCESS_TOKENS", "4PLUS_LOG_DISTRIBUTION_TASK_JOBS", "CUSTOMER_DATA_SERVICE" ], "type": "string" }, "CapabilityDto": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/CapabilityType" } }, "additionalProperties": false }, "CapabilityType": { "enum": [ "UserCustomer", "System" ], "type": "string" }, "CatalogElementDescriptionDto": { "type": "object", "properties": { "title": { "$ref": "#/components/schemas/PhraseDto" }, "details": { "$ref": "#/components/schemas/PhraseDto" } }, "additionalProperties": false }, "ChildLocationDto": { "type": "object", "properties": { "parentLocationId": { "type": "integer", "format": "int32", "nullable": true }, "locationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "locationType": { "$ref": "#/components/schemas/LocationType" } }, "additionalProperties": false }, "ChildLocationUpdateDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "parentLocationId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ClassifiedFilterConditionDto": { "allOf": [ { "$ref": "#/components/schemas/FilterConditionDto" }, { "type": "object", "properties": { "valueClassifications": { "type": "array", "items": { "$ref": "#/components/schemas/FilterValueClassificationDto" }, "nullable": true } }, "additionalProperties": false } ] }, "ClientSystemDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CloudToDeviceDistributionErrorResponseDto": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskByDeviceResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "job": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskJobResponseDto" }, "status": { "$ref": "#/components/schemas/DistributionTaskStatus" }, "statusChangedAt": { "type": "string", "format": "date-time" }, "retryAt": { "type": "string", "format": "date-time" }, "retryCount": { "type": "integer", "format": "int32" }, "writeResourceInstanceValues": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionWriteResourceInstanceValueDto" } } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskJobCreateRequestDto": { "type": "object", "properties": { "timeToLive": { "$ref": "#/components/schemas/TimeToLive" }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "writeDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionWriteDefinitionDto" } } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskJobCreateResponseDto": { "type": "object", "properties": { "jobId": { "type": "string", "format": "uuid" }, "createdFrom": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobReferenceResponseDto" }, "executorReference": { "$ref": "#/components/schemas/UserReferenceDto" }, "jobType": { "$ref": "#/components/schemas/DistributionTaskJobType" }, "taskCount": { "type": "integer", "format": "int32" }, "timeToLive": { "$ref": "#/components/schemas/TimeToLive" }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskJobDetailResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "repeatableJobReference": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobReferenceResponseDto" }, "executorReference": { "$ref": "#/components/schemas/UserReferenceDto" }, "jobType": { "$ref": "#/components/schemas/DistributionTaskJobType" }, "taskCount": { "type": "integer", "format": "int32" }, "timeToLive": { "$ref": "#/components/schemas/TimeToLive" }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "statistics": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskJobStatisticsResponseDto" } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskJobResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "repeatableJobReference": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobReferenceResponseDto" }, "executorReference": { "$ref": "#/components/schemas/UserReferenceDto" }, "jobType": { "$ref": "#/components/schemas/DistributionTaskJobType" }, "taskCount": { "type": "integer", "format": "int32" }, "timeToLive": { "$ref": "#/components/schemas/TimeToLive" }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskJobStatisticsResponseDto": { "type": "object", "properties": { "progress": { "type": "number", "format": "double" }, "successRate": { "type": "number", "format": "double", "nullable": true }, "averageTimeToSuccess": { "type": "number", "format": "double", "nullable": true }, "averageTimeToCompleted": { "type": "number", "format": "double", "nullable": true }, "maximumTimeToSuccess": { "type": "number", "format": "double", "nullable": true }, "tasksStatusSummary": { "$ref": "#/components/schemas/CloudToDeviceDistributionTasksStatusSummaryResponseDto" } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskLogResponseDto": { "type": "object", "properties": { "loggedAt": { "type": "string", "format": "date-time" }, "severity": { "$ref": "#/components/schemas/DistributionTaskLogSeverity" }, "status": { "$ref": "#/components/schemas/DistributionTaskLogStatus" }, "gateway": { "$ref": "#/components/schemas/SlimDeviceDto" }, "error": { "$ref": "#/components/schemas/CloudToDeviceDistributionErrorResponseDto" }, "gatewayProcessErrors": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionErrorResponseDto" }, "nullable": true } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskRepeatableJobCreateRequestDto": { "type": "object", "properties": { "name": { "type": "string" }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "writeDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionWriteDefinitionDto" } }, "timeToLive": { "$ref": "#/components/schemas/TimeToLive" } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskRepeatableJobCreateResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "writeDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionWriteDefinitionDto" } }, "timeToLive": { "$ref": "#/components/schemas/TimeToLive" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "$ref": "#/components/schemas/UserReferenceDto" } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskRepeatableJobReferenceResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskRepeatableJobResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "writeDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionWriteDefinitionDto" } }, "timeToLive": { "$ref": "#/components/schemas/TimeToLive" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedBy": { "$ref": "#/components/schemas/UserReferenceDto" }, "numberOfCreatedJobs": { "type": "integer", "format": "int32" }, "latestJobCreation": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskRepeatableJobUpdateRequestDto": { "type": "object", "properties": { "name": { "type": "string" }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "writeDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionWriteDefinitionDto" } }, "timeToLive": { "$ref": "#/components/schemas/TimeToLive" } }, "additionalProperties": false }, "CloudToDeviceDistributionTaskResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "jobId": { "type": "string", "format": "uuid" }, "deviceReference": { "$ref": "#/components/schemas/SlimDeviceDto" }, "writeResourceInstanceValues": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionWriteResourceInstanceValueDto" } }, "createdAt": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/DistributionTaskStatus" }, "retryCount": { "type": "integer", "format": "int32" }, "retryAt": { "type": "string", "format": "date-time" }, "statusChangedAt": { "type": "string", "format": "date-time" }, "timeToCompletedInSeconds": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CloudToDeviceDistributionTasksStatusSummaryResponseDto": { "type": "object", "properties": { "openTasksCount": { "type": "integer", "format": "int32" }, "pendingTasksCount": { "type": "integer", "format": "int32" }, "successfulTasksCount": { "type": "integer", "format": "int32" }, "expiredTasksCount": { "type": "integer", "format": "int32" }, "failedTasksCount": { "type": "integer", "format": "int32" }, "retryingTasksCount": { "type": "integer", "format": "int32" }, "cancelledTasksCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CloudToDeviceDistributionWriteDefinitionDto": { "type": "object", "properties": { "deviceTypeId": { "type": "string", "format": "uuid" }, "resourceInstanceValues": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionWriteResourceInstanceValueDto" } } }, "additionalProperties": false }, "CloudToDeviceDistributionWriteResourceInstanceValueDto": { "type": "object", "properties": { "resourceType": { "type": "integer", "format": "int32" }, "resourceInstanceNumber": { "type": "integer", "format": "int32" }, "value": { "type": "string" } }, "additionalProperties": false }, "ComponentDto": { "type": "object", "properties": { "componentPlaceholderId": { "type": "string", "format": "uuid" }, "componentId": { "type": "string", "format": "uuid" }, "componentTypeId": { "type": "string", "format": "uuid" }, "serialNumber": { "type": "string", "nullable": true }, "networkId": { "type": "string", "nullable": true }, "firmwareTypeId": { "type": "string", "format": "uuid", "nullable": true }, "firmwareVersionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CompoundDeviceStatus": { "enum": [ "IsCompoundDevice", "IsNotCompoundDevice", "IsCompoundMemberDevice", "IsNotCompoundMemberDevice" ], "type": "string" }, "CompoundDeviceStatusFilterDto": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/CompoundDeviceStatus" } }, "additionalProperties": false }, "ConnectionStatusExpectationDto": { "enum": [ "HardOffline", "SoftOffline", "Online" ], "type": "string" }, "ConversionUnit": { "enum": [ "MicroLiter", "MilliLiter", "Liter", "ImperialGallon", "ImperialPint", "ImperialQuart", "ImperialFluidOunce", "UsGallon", "UsPint", "UsQuart", "UsFluidOunce", "MilliGram", "Gram", "KiloGram", "Ounce", "Pound", "MilliMeter", "CentiMeter", "Meter", "Inch", "Foot", "Yard", "Second", "Minute", "Hour", "Day", "Siemens", "MilliSiemens", "MicroSiemens", "Watt", "MilliWatt", "Volt", "MilliVolt", "Ampere", "MilliAmpere", "MilliMolPerLiter", "MilliValPerLiter", "MilliDegreeGermanWaterHardness", "AmericanWaterHardness", "GermanWaterHardness", "EnglishWaterHardness", "FrenchWaterHardness", "Celsius", "Fahrenheit", "GramPerLiter", "MilliGramPerLiter", "ImperialOuncePerGallon", "UsOuncePerGallon", "Bar", "Pascal", "PoundForcePerSquareInch" ], "type": "string" }, "ConvertedPredefinedDateIntervalDto": { "type": "object", "properties": { "isPredefined": { "type": "boolean" }, "predefinedDateInterval": { "$ref": "#/components/schemas/PredefinedDateIntervalDto" } }, "additionalProperties": false }, "CopyDeviceFilterDto": { "type": "object", "properties": { "targetCustomerId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CountryDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isoCode2": { "type": "string", "nullable": true }, "isoCode3": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateCustomerCapabilityGrantDto": { "type": "object", "properties": { "capabilityCode": { "type": "string", "nullable": true }, "availabilityLevel": { "$ref": "#/components/schemas/AvailabilityLevel" }, "propagateToSubCustomers": { "type": "boolean" }, "propagateToSubsidiaries": { "type": "boolean" }, "propagateToFacilityManagementClients": { "type": "boolean" } }, "additionalProperties": false }, "CreateCustomerDeviceTypeLinkDto": { "required": [ "deviceTypeId", "restrictedAccess", "url" ], "type": "object", "properties": { "deviceTypeId": { "type": "string", "format": "uuid" }, "title": { "maxLength": 100, "type": "string", "nullable": true }, "description": { "maxLength": 4000, "type": "string", "nullable": true }, "restrictedAccess": { "type": "boolean" }, "language": { "maxLength": 2, "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "CreateCustomerDeviceTypeVariantSettingDto": { "type": "object", "properties": { "deviceTypeVariantId": { "type": "string", "format": "uuid" }, "hidden": { "type": "boolean" } }, "additionalProperties": false }, "CreateCustomerServiceRequestDto": { "type": "object", "properties": { "serviceAreaId": { "type": "integer", "format": "int32" }, "customerServiceRequestTypeId": { "type": "integer", "format": "int32" }, "appointmentNeeded": { "type": "boolean" }, "earliestDateOfService": { "type": "string", "format": "date-time" }, "requestNotes": { "type": "string", "nullable": true }, "handlingNotes": { "type": "string", "nullable": true }, "startOrder": { "type": "boolean" } }, "additionalProperties": false }, "CreateDeviceLocationAssignmentDto": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid" }, "locationId": { "type": "integer", "format": "int32" }, "mountPoint": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateDeviceServiceRequestProblemTypeDto": { "type": "object", "properties": { "resellerId": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "deviceTypeId": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeStatus" }, "usage": { "$ref": "#/components/schemas/ServiceRequestProblemTypeUsage" } }, "additionalProperties": false }, "CreateDeviceServiceRequestResolutionTypeDto": { "type": "object", "properties": { "resellerId": { "type": "integer", "format": "int32" }, "deviceTypeId": { "type": "string", "format": "uuid" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "status": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeStatus" } }, "additionalProperties": false }, "CreateDeviceSystemDto": { "type": "object", "properties": { "deviceTypeId": { "type": "string", "format": "uuid" }, "mountPoint": { "type": "string", "nullable": true }, "locationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateDeviceSystemMemberAssignmentDto": { "required": [ "from", "memberDeviceDigitalTwinId", "to" ], "type": "object", "properties": { "memberDeviceDigitalTwinId": { "type": "string", "format": "uuid" }, "placeholderId": { "type": "string", "format": "uuid" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CreateDistinctDeviceServiceRequestDto": { "type": "object", "properties": { "digitalTwinDeviceId": { "type": "string", "format": "uuid" }, "problemTypeId": { "type": "integer", "format": "int32" }, "problemDescription": { "type": "string", "nullable": true }, "startOrder": { "type": "boolean" }, "appointmentNeeded": { "type": "boolean" }, "earliestDateOfService": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CreateFourPlusTechnicianDocumentJobRequestDto": { "required": [ "deviceId" ], "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CreateFreeServicePeriodDto": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int32" }, "serviceAreaId": { "type": "integer", "format": "int32" }, "periodInMonths": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateFullServiceContractDto": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int32" }, "serviceAreaId": { "type": "integer", "format": "int32" }, "fromUtc": { "type": "string", "format": "date-time" }, "toUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CreateIndistinctDeviceServiceRequestDto": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int32" }, "deviceTypeId": { "type": "string", "format": "uuid" }, "deviceTypeVariantId": { "type": "string", "format": "uuid", "nullable": true }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "problemTypeId": { "type": "integer", "format": "int32" }, "problemDescription": { "type": "string", "nullable": true }, "appointmentNeeded": { "type": "boolean" }, "earliestDateOfService": { "type": "string", "format": "date-time" }, "startOrder": { "type": "boolean" } }, "additionalProperties": false }, "CreateMultipleRoleAssignmentsDto": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true }, "roleAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/CreateRoleAssignmentDto" }, "nullable": true } }, "additionalProperties": false }, "CreateOrUpdateAttributeDto": { "type": "object", "properties": { "attributeId": { "type": "string", "format": "uuid" }, "intValue": { "type": "integer", "format": "int32", "nullable": true }, "floatValue": { "type": "number", "format": "float", "nullable": true }, "enumerationValue": { "type": "integer", "format": "int32", "nullable": true }, "stringValue": { "type": "string", "nullable": true }, "booleanValue": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreateOrUpdateCustomerServiceRequestTypeDto": { "type": "object", "properties": { "idForExternalSystems": { "type": "string", "format": "uuid" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "creationConstraint": { "$ref": "#/components/schemas/CustomerServiceRequestCreationConstraint" }, "visibilityConstraint": { "$ref": "#/components/schemas/CustomerServiceRequestVisibilityConstraint" } }, "additionalProperties": false }, "CreateOrUpdateDeviceSystemMemberConfigurationDto": { "required": [ "systemDeviceTypeMemberPlaceholderAssignments" ], "type": "object", "properties": { "systemDeviceTypeMemberPlaceholderAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/SystemDeviceTypeMemberPlaceholderAssignmentDto" } } }, "additionalProperties": false }, "CreateOrUpdateRoleDto": { "required": [ "code", "name", "propagateToBeneficiaries", "propagateToFacilityManagementClients", "propagateToInvoiceSources", "propagateToSubCustomers", "propagateToSubsidiaries" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "isProtected": { "type": "boolean" }, "propagateToSubCustomers": { "type": "boolean" }, "propagateToSubsidiaries": { "type": "boolean" }, "propagateToInvoiceSources": { "type": "boolean" }, "propagateToBeneficiaries": { "type": "boolean" }, "propagateToFacilityManagementClients": { "type": "boolean" }, "permissionCodes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CreatePersonalAccessTokenDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CreatePersonalAccessTokenResponseDto": { "type": "object", "properties": { "personalAccessTokenId": { "type": "integer", "format": "int32" }, "personalAccessToken": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CreateRefillItemDto": { "type": "object", "properties": { "resellerId": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "lifeCycleStatus": { "$ref": "#/components/schemas/RefillItemLifeCycleStatus" }, "itemNumber": { "type": "string", "nullable": true }, "automaticAssociationIdentifier": { "type": "string", "nullable": true }, "refillFamilyId": { "type": "string", "format": "uuid", "nullable": true }, "deviceTypes": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "CreateRefillItemIncompatibilityDto": { "type": "object", "properties": { "incompatibleRefillItemId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateRoleAssignmentDto": { "type": "object", "properties": { "roleId": { "type": "integer", "format": "int32" }, "applicableToRelatedCustomersOnly": { "type": "boolean" } }, "additionalProperties": false }, "CreateSelectedInheritanceRefillItemDto": { "type": "object", "properties": { "resellerId": { "type": "integer", "format": "int32" }, "refillItemId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateServiceAreaDto": { "type": "object", "properties": { "resellerId": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "deviceTypeIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "CreateUserCapabilityGrantDto": { "type": "object", "properties": { "capabilityCode": { "type": "string", "nullable": true }, "availabilityLevel": { "$ref": "#/components/schemas/AvailabilityLevel" } }, "additionalProperties": false }, "CustomerAvailabilityCapabilityGrantDto": { "type": "object", "properties": { "propagateToSubCustomers": { "type": "boolean" }, "propagateToSubsidiaries": { "type": "boolean" }, "propagateToFacilityManagementClients": { "type": "boolean" }, "capabilityCode": { "type": "string", "nullable": true }, "availabilityLevel": { "$ref": "#/components/schemas/AvailabilityLevel" }, "externallyManaged": { "type": "boolean" } }, "additionalProperties": false }, "CustomerBasicDto": { "type": "object", "properties": { "concatenatedName": { "type": "string", "nullable": true }, "customerNumber": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "name3": { "type": "string", "nullable": true }, "name4": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerBrandingDto": { "type": "object", "properties": { "displayModeDark": { "$ref": "#/components/schemas/BrandingDisplayModeVariablesDto" }, "displayModeLight": { "$ref": "#/components/schemas/BrandingDisplayModeVariablesDto" } }, "additionalProperties": false }, "CustomerDescedantDto": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int32" }, "ancestorId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CustomerDeviceImageDto": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "restrictedAccess": { "type": "boolean" }, "createdAtUtc": { "type": "string", "format": "date-time" }, "fileLastModifiedUtc": { "type": "string", "format": "date-time" }, "lastModifiedUtc": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "url": { "type": "string", "format": "uri", "nullable": true }, "mediaType": { "type": "string", "nullable": true }, "fileSize": { "type": "integer", "format": "int32" }, "thumbnails": { "type": "array", "items": { "$ref": "#/components/schemas/ThumbnailDto" }, "nullable": true } }, "additionalProperties": false }, "CustomerDeviceTypeLinkDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "lastModifiedAtUtc": { "type": "string", "format": "date-time" }, "createdAtUtc": { "type": "string", "format": "date-time" }, "restrictedAccess": { "type": "boolean" }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerDeviceTypeVariantSettingDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "resellerId": { "type": "integer", "format": "int32" }, "deviceTypeVariantId": { "type": "string", "format": "uuid" }, "hidden": { "type": "boolean" } }, "additionalProperties": false }, "CustomerDocumentSource": { "enum": [ "Device", "DeviceType" ], "type": "string" }, "CustomerDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "name3": { "type": "string", "nullable": true }, "name4": { "type": "string", "nullable": true }, "address1": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "customerNumber": { "type": "string", "nullable": true }, "resellerId": { "type": "integer", "format": "int32" }, "reseller": { "$ref": "#/components/schemas/CustomerResellerDto" }, "isReseller": { "type": "boolean" }, "externallyManaged": { "type": "boolean" }, "concatenatedName": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "vatIdentificationNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerFilterDto": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CustomerRelationAttributesDto": { "type": "object", "properties": { "externallyManaged": { "type": "boolean" } }, "additionalProperties": false }, "CustomerRelationChildDto": { "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/CustomerDto" }, "relation": { "$ref": "#/components/schemas/CustomerRelationAttributesDto" } }, "additionalProperties": false }, "CustomerRelationType": { "enum": [ "Hierarchy", "Reseller", "Invoicing", "Condition", "FacilityManagement" ], "type": "string" }, "CustomerResellerDto": { "type": "object", "properties": { "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "name3": { "type": "string", "nullable": true }, "name4": { "type": "string", "nullable": true }, "customerNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerRoleAssignmentDto": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "userId": { "type": "string", "nullable": true }, "userDisplayName": { "type": "string", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "roleCode": { "type": "string", "nullable": true }, "applicableToRelatedCustomersOnly": { "type": "boolean" }, "externallyManaged": { "type": "boolean" }, "assignedAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CustomerRoleInheritanceSettingsDto": { "type": "object", "properties": { "allowRoleInheritanceFromReseller": { "type": "boolean", "description": "Indicates if roles are inherited from reseller relationships" }, "allowRoleInheritanceFromParentCustomer": { "type": "boolean", "description": "Indicates if roles are inherited from hierarchy relationships" }, "allowRoleInheritanceFromInvoiceRecipient": { "type": "boolean", "description": "Indicates if roles are inherited from invoicing relationships" }, "allowRoleInheritanceFromConditionOwner": { "type": "boolean", "description": "Indicates if roles are inherited from condition relationships" }, "allowRoleInheritanceFromFacilityManagementProvider": { "type": "boolean", "description": "Indicates if roles are inherited from facility management relationships" }, "useExternallyManagedRoleInheritanceSettings": { "type": "boolean", "description": "Indicates if inherited roles are externally managed" } }, "additionalProperties": false }, "CustomerSelfAssignmentLightCredentialsDto": { "type": "object", "properties": { "resellerCode": { "type": "string", "nullable": true }, "customerNumber": { "type": "string", "nullable": true }, "token": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerServiceRequestBillingType": { "enum": [ "NoCostsApply", "CostsCoveredByFullServiceContracts", "CostsNotCoveredByFullServiceContracts" ], "type": "string" }, "CustomerServiceRequestCreationConstraint": { "enum": [ "Reseller", "Customer" ], "type": "string" }, "CustomerServiceRequestDetailsDto": { "required": [ "serviceArea", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "integer", "format": "int32" }, "relatedDevices": { "type": "array", "items": { "$ref": "#/components/schemas/SlimDeviceDto" } }, "serviceArea": { "$ref": "#/components/schemas/ServiceAreaReferenceDto" }, "type": { "$ref": "#/components/schemas/CustomerServiceRequestTypeReferenceDto" }, "actualType": { "$ref": "#/components/schemas/CustomerServiceRequestTypeReferenceDto" }, "status": { "$ref": "#/components/schemas/ServiceRequestStatus" }, "activeStatus": { "$ref": "#/components/schemas/ServiceRequestActiveStatus" }, "orderId": { "type": "string", "format": "uuid", "nullable": true }, "billingMode": { "$ref": "#/components/schemas/BillingMode" }, "createdAt": { "type": "string", "format": "date-time" }, "latestStatusChangedAt": { "type": "string", "format": "date-time", "nullable": true }, "appointmentNeeded": { "type": "boolean" }, "earliestDateOfService": { "type": "string", "format": "date-time", "nullable": true }, "requestNotes": { "type": "string", "nullable": true }, "handlingNotes": { "type": "string", "nullable": true }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceRequestImageDto" }, "nullable": true }, "notificationUsers": { "type": "array", "items": { "$ref": "#/components/schemas/UserReferenceDto" }, "nullable": true }, "originalDataLastModifiedUtc": { "type": "string", "format": "date-time" }, "numberOfInaccessibleRelatedDevices": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CustomerServiceRequestInheritanceMode": { "enum": [ "InheritAllButSelected", "InheritOnlySelected", "DoNotInherit" ], "type": "string" }, "CustomerServiceRequestOrderDto": { "type": "object", "properties": { "orderId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "customerServiceRequests": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "CustomerServiceRequestSettingsDto": { "type": "object", "properties": { "allowCustomerServiceRequests": { "type": "boolean" }, "inheritanceMode": { "$ref": "#/components/schemas/CustomerServiceRequestInheritanceMode" }, "termsAndConditionsUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerServiceRequestSummaryFilterDto": { "type": "object", "properties": { "typeIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "serviceAreas": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "dateInterval": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" }, "status": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceRequestStatus" }, "nullable": true }, "activeStatus": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceRequestActiveStatus" }, "nullable": true } }, "additionalProperties": false }, "CustomerServiceRequestTypeDto": { "type": "object", "properties": { "idForExternalSystems": { "type": "string", "format": "uuid" }, "resellerId": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "creationConstraint": { "$ref": "#/components/schemas/CustomerServiceRequestCreationConstraint" }, "visibilityConstraint": { "$ref": "#/components/schemas/CustomerServiceRequestVisibilityConstraint" }, "billing": { "$ref": "#/components/schemas/CustomerServiceRequestBillingType" } }, "additionalProperties": false }, "CustomerServiceRequestTypeReferenceDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "idForExternalSystems": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerServiceRequestVisibilityConstraint": { "enum": [ "Reseller", "Customer" ], "type": "string" }, "CustomerSharedDocumentDto": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/CustomerDocumentSource" }, "id": { "type": "integer", "format": "int32" }, "fileName": { "type": "string", "nullable": true }, "fileSize": { "type": "integer", "format": "int64" }, "mimeType": { "type": "string", "nullable": true }, "createdAtUtc": { "type": "string", "format": "date-time" }, "fileLastModifiedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "lastModifiedAtUtc": { "type": "string", "format": "date-time" }, "restrictedAccess": { "type": "boolean" }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerSlimDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "name3": { "type": "string", "nullable": true }, "name4": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerStatus": { "enum": [ "Active", "Deleted" ], "type": "string" }, "CustomerSupportOrganizationDto": { "type": "object", "properties": { "telephone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "businessHours": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CycleDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "nullable": true } }, "additionalProperties": false }, "CycledSummedNetChangesAnalysisRequestDto": { "required": [ "cycledSummedNetChangedSegment", "dateIntervalDefinition", "deviceFilter", "locale", "resource", "timeZone" ], "type": "object", "properties": { "dateIntervalDefinition": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "resource": { "$ref": "#/components/schemas/AnalysisResourceDto" }, "timeZone": { "maxLength": 40, "minLength": 1, "type": "string" }, "locale": { "maxLength": 35, "minLength": 1, "type": "string" }, "cycledSummedNetChangedSegment": { "$ref": "#/components/schemas/CycledSummedNetChangesSegment" } }, "additionalProperties": false }, "CycledSummedNetChangesResponseDto": { "type": "object", "properties": { "cycles": { "type": "array", "items": { "$ref": "#/components/schemas/CycleDto" }, "nullable": true } }, "additionalProperties": false }, "CycledSummedNetChangesSegment": { "enum": [ "YearMonth", "YearWeek", "MonthDay", "WeekDay", "DayHour" ], "type": "string" }, "DataSettingsDto": { "type": "object", "properties": { "integerDataSettings": { "$ref": "#/components/schemas/IntegerDataSettingsDto" }, "floatDataSettings": { "$ref": "#/components/schemas/FloatDataSettingsDto" }, "booleanDataSettings": { "$ref": "#/components/schemas/BooleanDataSettingsDto" }, "enumerationDataSettings": { "$ref": "#/components/schemas/EnumerationDataSettingsDto" }, "stringDataSettings": { "$ref": "#/components/schemas/StringDataSettingsDto" } }, "additionalProperties": false }, "DateIntervalDefinitionDto": { "type": "object", "properties": { "absoluteDateInterval": { "$ref": "#/components/schemas/AbsoluteDateIntervalDto" }, "relativeDateInterval": { "$ref": "#/components/schemas/RelativeDateIntervalDto" }, "predefinedDateInterval": { "$ref": "#/components/schemas/PredefinedDateIntervalDto" } }, "additionalProperties": false }, "DateTimeAdjustmentMethod": { "enum": [ "Round", "Ceiling", "Floor" ], "type": "string" }, "DateTimeOffsetAdjustmentPart": { "enum": [ "Year", "Month", "Week", "Day", "Hour", "Minute" ], "type": "string" }, "DayOfWeek": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string" }, "DeliverySetting": { "enum": [ "Low", "Medium", "High", "Never" ], "type": "string" }, "DeviceAssignmentDto": { "type": "object", "properties": { "deviceComponents": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceComponentIdentificationDto" }, "nullable": true }, "deviceId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "DeviceCatalogInformationDto": { "type": "object", "properties": { "deviceTypeId": { "type": "string", "format": "uuid" }, "deviceTypeAlias": { "type": "string", "nullable": true }, "deviceTypeVariantId": { "type": "string", "format": "uuid", "nullable": true }, "deviceTypeVariantName": { "type": "string", "nullable": true }, "displayImage": { "type": "string", "format": "uri", "nullable": true }, "deviceTypeImage": { "$ref": "#/components/schemas/DeviceTypeImageDto" } }, "additionalProperties": false }, "DeviceClass": { "enum": [ "Regular", "DeviceSystem" ], "type": "string" }, "DeviceClassificationClassDto": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "deviceCount": { "type": "integer", "format": "int32" }, "color": { "type": "string", "nullable": true, "deprecated": true }, "filter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "severity": { "$ref": "#/components/schemas/ValueClassificationKind" } }, "additionalProperties": false }, "DeviceClassificationDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DeviceClassificationTypeDto" }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "documentationUrl": { "type": "string", "nullable": true }, "totalDeviceCount": { "type": "integer", "format": "int32" }, "classes": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceClassificationClassDto" }, "nullable": true } }, "additionalProperties": false }, "DeviceClassificationRequestDto": { "type": "object", "properties": { "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "additionalProperties": false }, "DeviceClassificationResponseDto": { "type": "object", "properties": { "classifications": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceClassificationDto" }, "nullable": true } }, "additionalProperties": false }, "DeviceClassificationTypeDto": { "enum": [ "NeedForAction", "EnergyState", "FillState", "DataLinkState", "ErrorState", "RefillState" ], "type": "string" }, "DeviceComponentIdentificationDto": { "required": [ "serialNumber" ], "type": "object", "properties": { "componentPlaceholderId": { "type": "string", "format": "uuid" }, "serialNumber": { "type": "string" }, "networkId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceDataLinkInfoDto": { "type": "object", "properties": { "loggedAt": { "type": "string", "format": "date-time" }, "deviceLinkType": { "$ref": "#/components/schemas/DeviceLinkType" }, "deviceName": { "type": "string", "nullable": true }, "locationPath": { "type": "string", "nullable": true }, "mountPoint": { "type": "string", "nullable": true }, "displayImage": { "type": "string", "format": "uri", "nullable": true }, "deviceTypeImage": { "$ref": "#/components/schemas/DeviceTypeImageDto" }, "componentId": { "type": "string", "nullable": true }, "deviceId": { "type": "string", "format": "uuid" }, "connectionStatus": { "type": "string" }, "signalStrength": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "DeviceDto": { "required": [ "deviceTypeVariant" ], "type": "object", "properties": { "connectivity": { "$ref": "#/components/schemas/GatewayConnectionStatus" }, "compositionPositions": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceInstanceStatusDto" }, "nullable": true }, "compoundMemberDevices": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceDto" }, "nullable": true }, "refillItem": { "$ref": "#/components/schemas/RefillItemSlimDto" }, "refillFamily": { "$ref": "#/components/schemas/RefillFamilyDto" }, "deviceTypeVariant": { "$ref": "#/components/schemas/SlimDeviceTypeVariantDto" }, "refillItemAssociationMode": { "$ref": "#/components/schemas/RefillItemAssociationMode" }, "locationType": { "$ref": "#/components/schemas/LocationType" }, "lastSystemConfigurationAt": { "type": "string", "format": "date-time" }, "deviceId": { "type": "string", "format": "uuid" }, "deviceIdInt": { "type": "integer", "format": "int32" }, "deviceTypeAlias": { "type": "string", "nullable": true }, "deviceTypeName": { "type": "string", "nullable": true }, "deviceTypeDescription": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "networkId": { "type": "string", "nullable": true }, "displayImage": { "type": "string", "format": "uri", "nullable": true }, "deviceTypeImage": { "$ref": "#/components/schemas/DeviceTypeImageDto" }, "locationPath": { "type": "array", "items": { "$ref": "#/components/schemas/LocationPathDto" }, "nullable": true }, "mountPoint": { "type": "string", "nullable": true }, "lastDataReceived": { "type": "string", "format": "date-time", "nullable": true }, "deviceTypeCompetenceClassCode": { "type": "string", "nullable": true }, "deviceTypeCompetenceClassName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceFilterDto": { "type": "object", "properties": { "filterTerm": { "$ref": "#/components/schemas/DeviceFilterTermDto" } }, "additionalProperties": false }, "DeviceFilterHeuristicResultAnalysisDto": { "type": "object", "properties": { "deviceTypeIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "isCustomerSpecific": { "type": "boolean" } }, "additionalProperties": false }, "DeviceFilterTermDto": { "type": "object", "properties": { "and": { "$ref": "#/components/schemas/AndDto" }, "or": { "$ref": "#/components/schemas/OrDto" }, "locationFilter": { "$ref": "#/components/schemas/LocationFilterDto" }, "customerFilter": { "$ref": "#/components/schemas/CustomerFilterDto" }, "deviceTypeFilter": { "$ref": "#/components/schemas/DeviceTypeFilterDto" }, "deviceTypeIdFilter": { "$ref": "#/components/schemas/DeviceTypeIdFilterDto" }, "deviceIdFilter": { "$ref": "#/components/schemas/DeviceIdFilterDto" }, "installationDateFilter": { "$ref": "#/components/schemas/InstallationDateFilterDto" }, "latestResourceInstanceValueFilter": { "$ref": "#/components/schemas/LatestResourceInstanceValueFilterDto" }, "latestResourceInstanceEquivalentValueFilter": { "$ref": "#/components/schemas/LatestResourceInstanceEquivalentValueFilterDto" }, "birthDateFilter": { "$ref": "#/components/schemas/BirthDateFilterDto" }, "latestResourceInstanceUpdateFilter": { "$ref": "#/components/schemas/LatestResourceInstanceUpdateFilterDto" }, "compoundDeviceStatusFilter": { "$ref": "#/components/schemas/CompoundDeviceStatusFilterDto" }, "needForActionFilter": { "$ref": "#/components/schemas/NeedForActionFilterDto" }, "networkCompatibilityFilter": { "$ref": "#/components/schemas/NetworkCompatibilityFilterDto" }, "refillItemFilter": { "$ref": "#/components/schemas/RefillItemFilterDto" }, "deviceIdsFilter": { "$ref": "#/components/schemas/DeviceIdsFilterDto" } }, "additionalProperties": false }, "DeviceFilterTermTypeDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceFilterValidationMessageDto": { "type": "object", "properties": { "messageId": { "type": "string", "nullable": true }, "messageText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceFilterVisibility": { "enum": [ "Public", "Personal" ], "type": "string" }, "DeviceForwardingConnectionQueueConnectionResponseDto": { "type": "object", "properties": { "queueName": { "type": "string" }, "listenerConnectionString": { "type": "string" } }, "additionalProperties": false }, "DeviceForwardingConnectionStringsResponseDto": { "type": "object", "properties": { "signalR": { "type": "string" }, "queue": { "$ref": "#/components/schemas/DeviceForwardingConnectionQueueConnectionResponseDto" } }, "additionalProperties": false }, "DeviceForwardingRuleCreateDto": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "resourceInstanceEquivalentId": { "type": "string", "format": "uuid", "nullable": true }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "additionalProperties": false }, "DeviceForwardingRuleResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "customerId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "connectionStrings": { "$ref": "#/components/schemas/DeviceForwardingConnectionStringsResponseDto" }, "resourceInstanceEquivalentId": { "type": "string", "format": "uuid", "nullable": true }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "additionalProperties": false }, "DeviceForwardingRuleUpdateDto": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "resourceInstanceEquivalentId": { "type": "string", "format": "uuid", "nullable": true }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "additionalProperties": false }, "DeviceIdDto": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "DeviceIdFilterDto": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DeviceIdsFilterDto": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "DeviceLifeCycleState": { "enum": [ "Produced", "Inactive", "Active", "Hibernating", "Decommissioned" ], "type": "string" }, "DeviceLinkType": { "enum": [ "Unspecified", "KnownGateway", "KnownDevice", "UnknownGateway", "UnknownDevice" ], "type": "string" }, "DeviceLocationAssignmentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "deviceId": { "type": "string", "format": "uuid" }, "locationId": { "type": "integer", "format": "int32" }, "mountPoint": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceLocationDto": { "type": "object", "properties": { "locationId": { "type": "integer", "format": "int32" }, "mountPoint": { "type": "string", "nullable": true }, "locationPath": { "type": "array", "items": { "$ref": "#/components/schemas/LocationPathDto" }, "nullable": true } }, "additionalProperties": false }, "DeviceMonitoringAggregationPeriod": { "enum": [ "M30", "H1", "H2", "H3", "H4", "H6", "H8", "H12", "D1", "D2", "D3", "D4", "D5", "D6", "D7", "None" ], "type": "string" }, "DeviceMonitoringReNotificationPeriod": { "enum": [ "S0", "M30", "H1", "H2", "H3", "H4", "H6", "H8", "H12", "D1", "D2", "D3", "D4", "D5", "D6", "D7" ], "type": "string" }, "DeviceMonitoringRuleCreateDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "devicesFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "userIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "resourceEquivalentId": { "type": "string", "format": "uuid" }, "aggregationPeriod": { "$ref": "#/components/schemas/DeviceMonitoringAggregationPeriod" }, "reNotificationPeriod": { "$ref": "#/components/schemas/DeviceMonitoringReNotificationPeriod" }, "condition": { "oneOf": [ { "$ref": "#/components/schemas/ClassifiedFilterConditionDto" }, { "$ref": "#/components/schemas/ExpressionedFilterConditionDto" } ], "nullable": true } }, "additionalProperties": false }, "DeviceMonitoringRuleDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "devicesFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "affectedDevicesFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "redoDeviceMonitoringRuleId": { "type": "string", "format": "uuid" }, "isActive": { "type": "boolean" }, "customerId": { "type": "integer", "format": "int32" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserReferenceDto" }, "nullable": true }, "resourceEquivalentId": { "type": "string", "format": "uuid" }, "aggregationPeriod": { "$ref": "#/components/schemas/DeviceMonitoringAggregationPeriod" }, "reNotificationPeriod": { "$ref": "#/components/schemas/DeviceMonitoringReNotificationPeriod" }, "condition": { "oneOf": [ { "$ref": "#/components/schemas/ClassifiedFilterConditionDto" }, { "$ref": "#/components/schemas/ExpressionedFilterConditionDto" } ], "nullable": true } }, "additionalProperties": false }, "DeviceMonitoringRuleUpdateDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "devicesFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "userIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "resourceEquivalentId": { "type": "string", "format": "uuid" }, "aggregationPeriod": { "$ref": "#/components/schemas/DeviceMonitoringAggregationPeriod" }, "reNotificationPeriod": { "$ref": "#/components/schemas/DeviceMonitoringReNotificationPeriod" }, "condition": { "oneOf": [ { "$ref": "#/components/schemas/ClassifiedFilterConditionDto" }, { "$ref": "#/components/schemas/ExpressionedFilterConditionDto" } ], "nullable": true } }, "additionalProperties": false }, "DeviceOrdering": { "enum": [ "None", "LocationPath", "DeviceType" ], "type": "string" }, "DeviceServiceRequestDetailsDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "deviceId": { "type": "string", "format": "uuid", "nullable": true }, "device": { "$ref": "#/components/schemas/DeviceCatalogInformationDto" }, "location": { "$ref": "#/components/schemas/DeviceLocationDto" }, "status": { "$ref": "#/components/schemas/ServiceRequestStatus" }, "activeStatus": { "$ref": "#/components/schemas/ServiceRequestActiveStatus" }, "handlingNotes": { "type": "string", "nullable": true }, "problemDescription": { "type": "string", "nullable": true }, "problemType": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeReferenceDto" }, "actualProblemType": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeReferenceDto" }, "resolutionType": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeReferenceDto" }, "billingMode": { "$ref": "#/components/schemas/BillingMode" }, "type": { "$ref": "#/components/schemas/DeviceServiceRequestType" }, "createdAt": { "type": "string", "format": "date-time" }, "latestStatusChangedAt": { "type": "string", "format": "date-time" }, "originalDataLastModifiedAt": { "type": "string", "format": "date-time" }, "appointmentNeeded": { "type": "boolean" }, "earliestDateOfService": { "type": "string", "format": "date-time" }, "orderId": { "type": "string", "format": "uuid", "nullable": true }, "statusHistory": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceRequestStatusHistoryEntryDto" }, "nullable": true }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceRequestImageDto" }, "nullable": true }, "notificationUsers": { "type": "array", "items": { "$ref": "#/components/schemas/UserReferenceDto" }, "nullable": true } }, "additionalProperties": false }, "DeviceServiceRequestDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "deviceId": { "type": "string", "format": "uuid", "nullable": true }, "device": { "$ref": "#/components/schemas/DeviceCatalogInformationDto" }, "location": { "$ref": "#/components/schemas/DeviceLocationDto" }, "status": { "$ref": "#/components/schemas/ServiceRequestStatus" }, "activeStatus": { "$ref": "#/components/schemas/ServiceRequestActiveStatus" }, "handlingNotes": { "type": "string", "nullable": true }, "problemDescription": { "type": "string", "nullable": true }, "problemType": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeReferenceDto" }, "billingMode": { "$ref": "#/components/schemas/BillingMode" }, "type": { "$ref": "#/components/schemas/DeviceServiceRequestType" }, "createdAt": { "type": "string", "format": "date-time" }, "latestStatusChangedAt": { "type": "string", "format": "date-time" }, "appointmentNeeded": { "type": "boolean" }, "earliestDateOfService": { "type": "string", "format": "date-time" }, "orderId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "DeviceServiceRequestProblemTypeDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "resellerId": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "status": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeStatus" }, "usage": { "$ref": "#/components/schemas/ServiceRequestProblemTypeUsage" }, "deviceTypeId": { "type": "string", "format": "uuid" }, "isExternallyManaged": { "type": "boolean" } }, "additionalProperties": false }, "DeviceServiceRequestProblemTypeListingDto": { "type": "object", "properties": { "isExternallyManaged": { "type": "boolean" }, "serviceRequestProblemTypes": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeSlimDto" }, "nullable": true } }, "additionalProperties": false }, "DeviceServiceRequestProblemTypeReferenceDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceServiceRequestProblemTypeSlimDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "status": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeStatus" }, "usage": { "$ref": "#/components/schemas/ServiceRequestProblemTypeUsage" }, "deviceTypeId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "DeviceServiceRequestProblemTypeStatus": { "enum": [ "Active", "Inactive" ], "type": "string" }, "DeviceServiceRequestResellerSummaryDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "deviceId": { "type": "string", "format": "uuid", "nullable": true }, "device": { "$ref": "#/components/schemas/DeviceCatalogInformationDto" }, "status": { "$ref": "#/components/schemas/ServiceRequestStatus" }, "activeStatus": { "$ref": "#/components/schemas/ServiceRequestActiveStatus" }, "handlingNotes": { "type": "string", "nullable": true }, "problemDescription": { "type": "string", "nullable": true }, "problemType": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeReferenceDto" }, "appointmentNeeded": { "type": "boolean" }, "earliestDateOfService": { "type": "string", "format": "date-time" }, "billingMode": { "$ref": "#/components/schemas/BillingMode" }, "type": { "$ref": "#/components/schemas/DeviceServiceRequestType" }, "createdAt": { "type": "string", "format": "date-time" }, "latestStatusChangedAt": { "type": "string", "format": "date-time" }, "orderId": { "type": "string", "format": "uuid", "nullable": true }, "customer": { "$ref": "#/components/schemas/CustomerSlimDto" } }, "additionalProperties": false }, "DeviceServiceRequestResolutionTypeDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "resellerId": { "type": "integer", "format": "int32" }, "deviceTypeId": { "type": "string", "format": "uuid" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "status": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeStatus" }, "isExternallyManaged": { "type": "boolean" } }, "additionalProperties": false }, "DeviceServiceRequestResolutionTypeListingDto": { "type": "object", "properties": { "isExternallyManaged": { "type": "boolean" }, "serviceRequestResolutionTypes": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeSlimDto" }, "nullable": true } }, "additionalProperties": false }, "DeviceServiceRequestResolutionTypeReferenceDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceServiceRequestResolutionTypeSlimDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "deviceTypeId": { "type": "string", "format": "uuid" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "status": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeStatus" } }, "additionalProperties": false }, "DeviceServiceRequestResolutionTypeStatus": { "enum": [ "Active", "Inactive" ], "type": "string" }, "DeviceServiceRequestSettingsDto": { "type": "object", "properties": { "allowDistinctServiceRequests": { "type": "boolean" }, "allowIndistinctServiceRequests": { "type": "boolean" }, "termsAndConditionsUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceServiceRequestSummaryFilterDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DeviceServiceRequestType" }, "serviceAreas": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "dateInterval": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" }, "status": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceRequestStatus" }, "nullable": true }, "activeStatus": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceRequestActiveStatus" }, "nullable": true } }, "additionalProperties": false }, "DeviceServiceRequestType": { "enum": [ "Distinct", "Indistinct" ], "type": "string" }, "DeviceSettingsChangeDto": { "type": "object", "properties": { "changedAt": { "type": "string", "format": "date-time" }, "receivedAt": { "type": "string", "format": "date-time" }, "changedBy": { "$ref": "#/components/schemas/SimpleUser" }, "clientApplicationName": { "type": "string", "nullable": true }, "resourceValue": { "$ref": "#/components/schemas/ResourceValueDto" } }, "additionalProperties": false }, "DeviceSystemMemberConfigurationResponseDto": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid" }, "currentLifeCycleState": { "$ref": "#/components/schemas/LifeCycleStateValue" }, "birthDate": { "type": "string", "format": "date-time" }, "version": { "type": "string", "format": "date-time" }, "deviceTypeId": { "type": "string", "format": "uuid" }, "itemNumber": { "type": "string" }, "registrationApplicant": { "type": "string" }, "deviceSystemMembers": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceSystemMemberResponseDto" } } }, "additionalProperties": false }, "DeviceSystemMemberResponseDto": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid" }, "systemDeviceTypeMemberPlaceholder": { "type": "string", "format": "uuid" }, "installationDate": { "type": "string", "format": "date-time" }, "birthDate": { "type": "string", "format": "date-time", "nullable": true }, "deviceTypeId": { "type": "string", "format": "uuid", "nullable": true }, "currentLifeCycleState": { "$ref": "#/components/schemas/LifeCycleStateValue" }, "itemNumber": { "type": "string" }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentDto" }, "nullable": true } }, "additionalProperties": false }, "DeviceTypeClass": { "enum": [ "Regular", "DeviceSystem", "LegacyDevice" ], "type": "string" }, "DeviceTypeDto": { "type": "object", "properties": { "deviceTypeId": { "type": "string", "nullable": true }, "deviceTypeName": { "type": "string", "nullable": true }, "deviceTypeAlias": { "type": "string", "nullable": true }, "deviceTypeDescription": { "type": "string", "nullable": true }, "deviceTypeClass": { "$ref": "#/components/schemas/DeviceTypeClass" }, "displayImage": { "type": "string", "format": "uri", "nullable": true }, "deviceTypeImage": { "$ref": "#/components/schemas/DeviceTypeImageDto" }, "competenceClassCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceTypeFilterDto": { "type": "object", "properties": { "deviceType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceTypeIdFilterDto": { "type": "object", "properties": { "deviceTypeIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "DeviceTypeImageDto": { "type": "object", "properties": { "xs": { "type": "string", "format": "uri", "nullable": true }, "s": { "type": "string", "format": "uri", "nullable": true }, "m": { "type": "string", "format": "uri", "nullable": true }, "l": { "type": "string", "format": "uri", "nullable": true }, "xl": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "DeviceTypeLifecycleState": { "enum": [ "Unpublished", "Alpha", "Beta", "Published", "Deprecated" ], "type": "string" }, "DeviceTypeLinkDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "lastModifiedAtUtc": { "type": "string", "format": "date-time" }, "createdAtUtc": { "type": "string", "format": "date-time" }, "restrictedAccess": { "type": "boolean" }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "DeviceTypeResourceInstanceDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "resourceType": { "type": "string", "nullable": true }, "resourceInstanceNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceTypeVariantDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "displayImage": { "type": "string", "format": "uri", "nullable": true }, "deviceTypeImage": { "$ref": "#/components/schemas/DeviceTypeImageDto" } }, "additionalProperties": false }, "DeviceTypeWithVariantsDto": { "type": "object", "properties": { "deviceTypeId": { "type": "string", "nullable": true }, "deviceTypeAlias": { "type": "string", "nullable": true }, "deviceTypeClass": { "$ref": "#/components/schemas/DeviceTypeClass" }, "deviceTypeVariants": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceTypeVariantDto" }, "nullable": true } }, "additionalProperties": false }, "DiscreteStepBehaviorDto": { "type": "object", "properties": { "discreteValues": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "DisplayControlDto": { "type": "object", "properties": { "textBoxDisplayControl": { "$ref": "#/components/schemas/TextBoxDisplayControlDto" }, "stringDropDownControl": { "$ref": "#/components/schemas/StringDropDownControlDto" }, "numericDropDownDisplayControl": { "$ref": "#/components/schemas/NumericDropDownDisplayControlDto" }, "numericToggleDisplayControl": { "$ref": "#/components/schemas/NumericToggleDisplayControlDto" }, "stepDisplayControl": { "$ref": "#/components/schemas/StepDisplayControlDto" }, "booleanToggleDisplayControl": { "$ref": "#/components/schemas/BooleanToggleDisplayControlDto" } }, "additionalProperties": false }, "DisplayHintDto": { "type": "object", "properties": { "displayControl": { "$ref": "#/components/schemas/DisplayControlDto" }, "valueDisplayBehavior": { "$ref": "#/components/schemas/DisplayHintValueDisplayBehavior" }, "numericDisplayHint": { "$ref": "#/components/schemas/NumericDisplayHintDto" }, "stringDisplayHint": { "$ref": "#/components/schemas/StringDisplayHintDto" }, "booleanDisplayHint": { "$ref": "#/components/schemas/BooleanDisplayHintDto" } }, "additionalProperties": false }, "DisplayHintValueDisplayBehavior": { "enum": [ "ActualValue", "ClassificationName", "ClassificationIcon" ], "type": "string" }, "DisplayPostfixDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/PhraseDto" }, "abbreviation": { "$ref": "#/components/schemas/PhraseDto" } }, "additionalProperties": false }, "DisplayPostfixSlimDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "nameTranslationKey": { "type": "string", "nullable": true }, "abbreviation": { "type": "string", "nullable": true }, "abbreviationTranslationKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DistributionTaskJobType": { "enum": [ "System", "User" ], "type": "string" }, "DistributionTaskLogSeverity": { "enum": [ "Information", "Warning", "Error", "Critical" ], "type": "string" }, "DistributionTaskLogStatus": { "enum": [ "NoConnectedGatewayFound", "Distributed", "DistributionFailure", "Processed", "ProcessingFailure", "NoGatewayResponseAfterDistribution", "NextRetryExceedsExpiration" ], "type": "string" }, "DistributionTaskStatisticsResponseDto": { "type": "object", "properties": { "completedTasksCount": { "type": "integer", "format": "int32" }, "activeTasksCount": { "type": "integer", "format": "int32" }, "pendingTasksCount": { "type": "integer", "format": "int32" }, "succeededTasksCount": { "type": "integer", "format": "int32" }, "openTasksCount": { "type": "integer", "format": "int32" }, "canceledTasksCount": { "type": "integer", "format": "int32" }, "expiredTasksCount": { "type": "integer", "format": "int32" }, "failedTasksCount": { "type": "integer", "format": "int32" }, "averageTimeToSuccess": { "type": "integer", "format": "int32", "nullable": true }, "averageTimeToComplete": { "type": "integer", "format": "int32", "nullable": true }, "maximumTimeToSuccess": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "DistributionTaskStatus": { "enum": [ "Open", "Retry", "Pending", "Expired", "Cancelled", "Failed", "Succeeded" ], "type": "string" }, "DocumentBaseDto": { "type": "object", "properties": { "language": { "maxLength": 2, "type": "string", "nullable": true }, "title": { "maxLength": 100, "type": "string", "nullable": true }, "description": { "maxLength": 4000, "type": "string", "nullable": true }, "restrictedAccess": { "type": "boolean" } }, "additionalProperties": false }, "DocumentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "fileName": { "type": "string", "nullable": true }, "fileSize": { "type": "integer", "format": "int64" }, "mimeType": { "type": "string", "nullable": true }, "createdAtUtc": { "type": "string", "format": "date-time" }, "fileLastModifiedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "lastModifiedAtUtc": { "type": "string", "format": "date-time" }, "restrictedAccess": { "type": "boolean" }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentJobDocumentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "size": { "type": "integer", "format": "int32" }, "downloadUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentJobDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/DocumentJobStatus" }, "owner": { "$ref": "#/components/schemas/UserSlimDto" }, "customer": { "$ref": "#/components/schemas/CustomerBasicDto" }, "createdAt": { "type": "string", "format": "date-time" }, "processingStartedAt": { "type": "string", "format": "date-time" }, "processingEndedAt": { "type": "string", "format": "date-time" }, "resultsCount": { "type": "integer", "format": "int32" }, "timeZone": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/DocumentJobType" } }, "additionalProperties": false }, "DocumentJobStatus": { "enum": [ "Queued", "Processing", "Canceled", "Finished", "Failed" ], "type": "string" }, "DocumentJobType": { "enum": [ "FourPLUS_Technician", "FourPLUS_Systems_Summary" ], "type": "string" }, "EffectiveCustomerCapabilitiesDto": { "type": "object", "properties": { "availabilityCapabilities": { "type": "array", "items": { "$ref": "#/components/schemas/AvailabilityCapabilityDto" }, "nullable": true } }, "additionalProperties": false }, "EffectiveCustomerCapabilityGrantDto": { "type": "object", "properties": { "propagateToSubCustomers": { "type": "boolean", "nullable": true }, "propagateToSubsidiaries": { "type": "boolean", "nullable": true }, "propagateToFacilityManagementClients": { "type": "boolean", "nullable": true }, "capabilityCode": { "type": "string", "nullable": true }, "availabilityLevel": { "$ref": "#/components/schemas/AvailabilityLevel" }, "externallyManaged": { "type": "boolean", "nullable": true }, "sourceCustomerId": { "type": "integer", "format": "int32", "nullable": true }, "sourceCustomerName1": { "type": "string", "nullable": true }, "sourceCustomerName2": { "type": "string", "nullable": true }, "sourceCustomerName3": { "type": "string", "nullable": true }, "sourceCustomerName4": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EffectiveCustomerServiceRequestSettingsDto": { "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/CustomerSlimDto" }, "allowCustomerServiceRequests": { "type": "boolean" }, "inheritanceMode": { "$ref": "#/components/schemas/CustomerServiceRequestInheritanceMode" }, "termsAndConditionsUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EffectiveCustomerServiceRequestTypeDto": { "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/CustomerSlimDto" }, "idForExternalSystems": { "type": "string", "format": "uuid" }, "resellerId": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "creationConstraint": { "$ref": "#/components/schemas/CustomerServiceRequestCreationConstraint" }, "visibilityConstraint": { "$ref": "#/components/schemas/CustomerServiceRequestVisibilityConstraint" }, "billing": { "$ref": "#/components/schemas/CustomerServiceRequestBillingType" } }, "additionalProperties": false }, "EffectiveDeviceServiceRequestProblemTypeDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "resellerId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeStatus" }, "usage": { "$ref": "#/components/schemas/ServiceRequestProblemTypeUsage" }, "deviceTypeId": { "type": "string", "format": "uuid" }, "isExternallyManaged": { "type": "boolean" } }, "additionalProperties": false }, "EffectiveDeviceServiceRequestSettingsDto": { "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/CustomerSlimDto" }, "allowDistinctServiceRequests": { "type": "boolean" }, "allowIndistinctServiceRequests": { "type": "boolean" }, "termsAndConditionsUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EffectiveFreeServicePeriodListingDto": { "type": "object", "properties": { "isExternallyManaged": { "type": "boolean" }, "effectiveFreeServicePeriods": { "type": "array", "items": { "$ref": "#/components/schemas/EffectiveFreeServicePeriodSlimDto" }, "nullable": true } }, "additionalProperties": false }, "EffectiveFreeServicePeriodSlimDto": { "type": "object", "properties": { "sourceCustomerId": { "type": "integer", "format": "int32" }, "serviceAreaId": { "type": "integer", "format": "int32" }, "serviceAreaName": { "type": "string", "nullable": true }, "periodInMonths": { "type": "integer", "format": "int32" }, "sourceCustomerName1": { "type": "string", "nullable": true }, "sourceCustomerName2": { "type": "string", "nullable": true }, "sourceCustomerName3": { "type": "string", "nullable": true }, "sourceCustomerName4": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EffectivePermissionDto": { "type": "object", "properties": { "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EffectiveRoleAssignmentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "assignedAt": { "type": "string", "format": "date-time" }, "roleId": { "type": "integer", "format": "int32" }, "roleCode": { "type": "string", "nullable": true }, "roleName": { "type": "string", "nullable": true }, "applicableToRelatedCustomersOnly": { "type": "boolean" }, "externallyManaged": { "type": "boolean" }, "assignmentType": { "$ref": "#/components/schemas/RoleAssignmentTypeDto" }, "securableType": { "$ref": "#/components/schemas/SecurableTypeDto" }, "sourceCustomerId": { "type": "integer", "format": "int32", "nullable": true }, "sourceCustomerName1": { "type": "string", "nullable": true }, "sourceCustomerName2": { "type": "string", "nullable": true }, "sourceCustomerName3": { "type": "string", "nullable": true }, "sourceCustomerName4": { "type": "string", "nullable": true }, "clientSystems": { "type": "array", "items": { "$ref": "#/components/schemas/ClientSystemDto" }, "nullable": true } }, "additionalProperties": false }, "EffectiveServiceAreaListingDto": { "type": "object", "properties": { "isExternallyManaged": { "type": "boolean" }, "serviceAreas": { "type": "array", "items": { "$ref": "#/components/schemas/EffectiveServiceAreaSlimDto" }, "nullable": true } }, "additionalProperties": false }, "EffectiveServiceAreaSlimDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "sourceCustomerId": { "type": "integer", "format": "int32" }, "sourceCustomerName1": { "type": "string", "nullable": true }, "sourceCustomerName2": { "type": "string", "nullable": true }, "sourceCustomerName3": { "type": "string", "nullable": true }, "sourceCustomerName4": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EnumerationDataSettingsDto": { "type": "object", "properties": { "enumerationUnits": { "type": "array", "items": { "$ref": "#/components/schemas/EnumerationUnitDto" }, "nullable": true } }, "additionalProperties": false }, "EnumerationUnitDto": { "type": "object", "properties": { "enumerationTranslated": { "type": "string", "nullable": true }, "enumerationValue": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EqualStepBehaviorDto": { "type": "object", "properties": { "startValue": { "type": "string", "nullable": true }, "stepSize": { "type": "string", "nullable": true }, "numberOfSteps": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ErrorDto": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "displayMessage": { "type": "string", "nullable": true }, "target": { "type": "string", "nullable": true }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDto" }, "nullable": true }, "innerError": { "$ref": "#/components/schemas/ErrorDto" } }, "additionalProperties": false }, "ErrorResponseDto": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/ErrorDto" } }, "additionalProperties": false }, "ExpressionedFilterConditionDto": { "allOf": [ { "$ref": "#/components/schemas/FilterConditionDto" }, { "required": [ "$type" ], "type": "object", "properties": { "$type": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$type" } } ] }, "ExtendedRoleInheritanceSettingsDto": { "type": "object", "properties": { "externallyManagedAllowRoleInheritanceFromReseller": { "type": "boolean" }, "externallyManagedAllowRoleInheritanceFromParentCustomer": { "type": "boolean" }, "externallyManagedAllowRoleInheritanceFromInvoiceRecipient": { "type": "boolean" }, "externallyManagedAllowRoleInheritanceFromConditionOwner": { "type": "boolean" }, "externallyManagedAllowRoleInheritanceFromFacilityManagementProvider": { "type": "boolean" }, "allowRoleInheritanceFromReseller": { "type": "boolean", "description": "Indicates if roles are inherited from reseller relationships" }, "allowRoleInheritanceFromParentCustomer": { "type": "boolean", "description": "Indicates if roles are inherited from hierarchy relationships" }, "allowRoleInheritanceFromInvoiceRecipient": { "type": "boolean", "description": "Indicates if roles are inherited from invoicing relationships" }, "allowRoleInheritanceFromConditionOwner": { "type": "boolean", "description": "Indicates if roles are inherited from condition relationships" }, "allowRoleInheritanceFromFacilityManagementProvider": { "type": "boolean", "description": "Indicates if roles are inherited from facility management relationships" }, "useExternallyManagedRoleInheritanceSettings": { "type": "boolean", "description": "Indicates if inherited roles are externally managed" } }, "additionalProperties": false }, "ExternallyManagedFilterDto": { "enum": [ "All", "OnlyExternallyManaged", "OnlyNonExternallyManaged" ], "type": "string" }, "FactorConstantConversionDto": { "type": "object", "properties": { "conversionFactor": { "type": "integer", "format": "int32" }, "conversionConstant": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FilterConditionDto": { "required": [ "$type" ], "type": "object", "properties": { "$type": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$type" } }, "FilterValueClassificationDto": { "type": "object", "properties": { "numericValueClassification": { "$ref": "#/components/schemas/NumericValueClassification" }, "stringValueClassification": { "$ref": "#/components/schemas/StringValueClassification" }, "booleanValueClassification": { "$ref": "#/components/schemas/BooleanValueClassification" } }, "additionalProperties": false }, "FloatDataDto": { "type": "object", "properties": { "value": { "type": "number", "format": "float", "nullable": true }, "unitSymbol": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FloatDataSettingsDto": { "type": "object", "properties": { "minimumValue": { "type": "number", "format": "float" }, "maximumValue": { "type": "number", "format": "float" }, "displayUnits": { "$ref": "#/components/schemas/UnitSettingsSlimDto" }, "displayPostfix": { "$ref": "#/components/schemas/DisplayPostfixSlimDto" }, "precision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FreeServicePeriodDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customerId": { "type": "integer", "format": "int32" }, "serviceAreaId": { "type": "integer", "format": "int32" }, "periodInMonths": { "type": "integer", "format": "int32" }, "isExternallyManaged": { "type": "boolean" }, "synchronizationId": { "type": "string", "nullable": true }, "synchronizationInformation": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FreeServicePeriodListingDto": { "type": "object", "properties": { "isExternallyManaged": { "type": "boolean" }, "freeServicePeriodDtos": { "type": "array", "items": { "$ref": "#/components/schemas/FreeServicePeriodSlimDto" }, "nullable": true } }, "additionalProperties": false }, "FreeServicePeriodSlimDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "serviceAreaId": { "type": "integer", "format": "int32" }, "periodInMonths": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FullServiceContractDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customerId": { "type": "integer", "format": "int32" }, "serviceAreaId": { "type": "integer", "format": "int32" }, "isExternallyManaged": { "type": "boolean" }, "fromUtc": { "type": "string", "format": "date-time" }, "toUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FullServiceContractListingDto": { "type": "object", "properties": { "fullServiceContracts": { "type": "array", "items": { "$ref": "#/components/schemas/FullServiceContractSlimDto" }, "nullable": true }, "isExternallyManaged": { "type": "boolean" } }, "additionalProperties": false }, "FullServiceContractSlimDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customerId": { "type": "integer", "format": "int32" }, "serviceAreaId": { "type": "integer", "format": "int32" }, "fromUtc": { "type": "string", "format": "date-time" }, "toUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "GatewayConnectionStatus": { "enum": [ "Connected", "NotConnected" ], "type": "string" }, "ImageDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "url": { "type": "string", "format": "uri", "nullable": true }, "mediaType": { "type": "string", "nullable": true }, "fileSize": { "type": "integer", "format": "int32" }, "thumbnails": { "type": "array", "items": { "$ref": "#/components/schemas/ThumbnailDto" }, "nullable": true } }, "additionalProperties": false }, "ImportRoleDefinitionResultEntryDto": { "type": "object", "properties": { "roleCode": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InstallationDateFilterDto": { "type": "object", "properties": { "installationType": { "$ref": "#/components/schemas/InstallationDateFilterInstallationType" }, "dateIntervalDefinition": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" } }, "additionalProperties": false }, "InstallationDateFilterInstallationType": { "enum": [ "CurrentInstallation", "FirstInstallation" ], "type": "string" }, "IntegerDataDto": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32", "nullable": true }, "unitSymbol": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegerDataSettingsDto": { "type": "object", "properties": { "displayUnits": { "$ref": "#/components/schemas/UnitSettingsSlimDto" }, "displayPostfix": { "$ref": "#/components/schemas/DisplayPostfixSlimDto" }, "minimumValue": { "type": "integer", "format": "int32" }, "maximumValue": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "InviteUsersToSecurableDto": { "type": "object", "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "roleIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "personalMessage": { "type": "string", "nullable": true }, "sendInvitationMail": { "type": "boolean" }, "applicableToRelatedCustomersOnly": { "type": "boolean" } }, "additionalProperties": false }, "LanguageDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LatestResourceInstanceEquivalentValueFilterDto": { "type": "object", "properties": { "resourceInstanceEquivalentId": { "type": "string", "format": "uuid" }, "condition": { "oneOf": [ { "$ref": "#/components/schemas/ClassifiedFilterConditionDto" }, { "$ref": "#/components/schemas/ExpressionedFilterConditionDto" } ], "nullable": true } }, "additionalProperties": false }, "LatestResourceInstanceUpdateFilterDateType": { "enum": [ "LastUpdatedDate", "LastModifiedDate" ], "type": "string" }, "LatestResourceInstanceUpdateFilterDto": { "type": "object", "properties": { "dateType": { "$ref": "#/components/schemas/LatestResourceInstanceUpdateFilterDateType" }, "dateIntervalDefinition": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" } }, "additionalProperties": false }, "LatestResourceInstanceValueFilterDto": { "type": "object", "properties": { "deviceTypeId": { "type": "string", "format": "uuid" }, "resourceTypeId": { "type": "integer", "format": "int32" }, "resourceInstanceNumber": { "type": "integer", "format": "int32" }, "condition": { "oneOf": [ { "$ref": "#/components/schemas/ClassifiedFilterConditionDto" }, { "$ref": "#/components/schemas/ExpressionedFilterConditionDto" } ], "nullable": true } }, "additionalProperties": false }, "LifeCycleStateValue": { "enum": [ "Produced", "Inactive", "Active", "Hibernating", "Decommissioned" ], "type": "string" }, "LocationDto": { "type": "object", "properties": { "locationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "locationType": { "$ref": "#/components/schemas/LocationType" } }, "additionalProperties": false }, "LocationFilterDto": { "type": "object", "properties": { "locationIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "includeSubLocations": { "type": "boolean" } }, "additionalProperties": false }, "LocationPathDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LocationTreeDto": { "type": "object", "properties": { "subLocations": { "type": "array", "items": { "$ref": "#/components/schemas/LocationTreeDto" }, "nullable": true }, "locationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "locationType": { "$ref": "#/components/schemas/LocationType" } }, "additionalProperties": false }, "LocationType": { "enum": [ "Building", "BuildingArea", "Floor", "FloorArea", "Room", "Stash" ], "type": "string" }, "MarkCustomerAsFavoriteDto": { "type": "object", "properties": { "isFavorite": { "type": "boolean" } }, "additionalProperties": false }, "MonotonousBehavior": { "enum": [ "NonMonotonous", "MonotonouslyIncreasing" ], "type": "string" }, "MonthOffsetDto": { "type": "object", "properties": { "months": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MoveDeviceDto": { "type": "object", "properties": { "locationId": { "type": "integer", "format": "int32" }, "mountPoint": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MoveDevicesDto": { "type": "object", "properties": { "locationId": { "type": "integer", "format": "int32" }, "deviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "MoveDevicesToStashDto": { "type": "object", "properties": { "devicesToMove": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "MoveLocationsDto": { "type": "object", "properties": { "sourceCustomerId": { "type": "integer", "format": "int32" }, "destinationCustomerId": { "type": "integer", "format": "int32" }, "locationIdsToMove": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "MultiResourceValueHistoryEntryDto": { "type": "object", "properties": { "loggedAt": { "type": "string", "format": "date-time" }, "resourceType": { "type": "integer", "format": "int32" }, "resourceInstanceNumber": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "data": { "oneOf": [ { "$ref": "#/components/schemas/ResourceValueIntegerDto" }, { "$ref": "#/components/schemas/ResourceValueStringDto" }, { "$ref": "#/components/schemas/ResourceValueDoubleDto" }, { "$ref": "#/components/schemas/ResourceValueBooleanDto" } ], "nullable": true } }, "additionalProperties": false }, "NeedForActionFilterDto": { "type": "object", "properties": { "includeFillState": { "type": "boolean" }, "includeRefillState": { "type": "boolean" }, "includeErrorState": { "type": "boolean" }, "includePowerState": { "type": "boolean" }, "includeConnectionState": { "type": "boolean" }, "valueClassificationKindGroup": { "$ref": "#/components/schemas/ValueClassificationKindGroup" } }, "additionalProperties": false }, "NetChangeAnalysisRequestDto": { "required": [ "dateIntervalDefinition", "deviceFilter", "resource", "timeZone" ], "type": "object", "properties": { "dateIntervalDefinition": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "resource": { "$ref": "#/components/schemas/AnalysisResourceDto" }, "timeZone": { "maxLength": 40, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "NetworkCompatibility": { "enum": [ "NetworkCompatible", "NonNetworkCompatible" ], "type": "string" }, "NetworkCompatibilityFilterDto": { "type": "object", "properties": { "compatibility": { "$ref": "#/components/schemas/NetworkCompatibility" } }, "additionalProperties": false }, "NewCustomerDto": { "type": "object", "properties": { "vatIdentificationNumber": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "name3": { "type": "string", "nullable": true }, "name4": { "type": "string", "nullable": true }, "address1": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "customerNumber": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "invoiceRecipientId": { "type": "integer", "format": "int32", "nullable": true }, "conditionOwnerId": { "type": "integer", "format": "int32", "nullable": true }, "parentCustomerId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "NewLocationDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewRoomDto": { "type": "object", "properties": { "roomTypeId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewStoredDeviceFilterDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "visibility": { "$ref": "#/components/schemas/DeviceFilterVisibility" }, "propagateToSubCustomers": { "type": "boolean" }, "propagateToSubsidiaries": { "type": "boolean" }, "propagateToInvoiceSources": { "type": "boolean" }, "propagateToBeneficiaries": { "type": "boolean" }, "propagateToFacilityManagementClients": { "type": "boolean" }, "filterTerm": { "$ref": "#/components/schemas/DeviceFilterTermDto" } }, "additionalProperties": false }, "NotificationDeliveryPreferenceRequestDto": { "type": "object", "properties": { "deliverySetting": { "$ref": "#/components/schemas/DeliverySetting" }, "channelType": { "type": "string" }, "category": { "type": "string" } }, "additionalProperties": false }, "NotificationDeliveryPreferenceResponseContainerDto": { "type": "object", "properties": { "availableCategories": { "type": "array", "items": { "type": "string" } }, "availableChannelTypes": { "type": "array", "items": { "type": "string" } }, "configuredPreferences": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDeliveryPreferenceResponseDto" } } }, "additionalProperties": false }, "NotificationDeliveryPreferenceResponseDto": { "type": "object", "properties": { "deliverySetting": { "$ref": "#/components/schemas/DeliverySetting" }, "channelType": { "type": "string" }, "category": { "type": "string" } }, "additionalProperties": false }, "NumericComparisonOperator": { "enum": [ "Equal", "Higher", "Less" ], "type": "string" }, "NumericConditionEntryDto": { "type": "object", "properties": { "operator": { "$ref": "#/components/schemas/NumericComparisonOperator" }, "comparisonValue": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "NumericDisplayHintDto": { "type": "object", "properties": { "unitConversion": { "$ref": "#/components/schemas/UnitConversionDto" }, "formatString": { "type": "string", "nullable": true }, "displayPostfix": { "$ref": "#/components/schemas/DisplayPostfixDto" } }, "additionalProperties": false }, "NumericDropDownDisplayControlDto": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueDisplayBehavior": { "$ref": "#/components/schemas/ValueDisplayBehavior" } }, "additionalProperties": false }, "NumericFilterConditionDto": { "allOf": [ { "$ref": "#/components/schemas/ExpressionedFilterConditionDto" }, { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/NumericConditionEntryDto" }, "nullable": true } }, "additionalProperties": false } ] }, "NumericRange": { "type": "object", "properties": { "lowerBoundary": { "type": "string", "nullable": true }, "upperBoundary": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NumericRangeDto": { "type": "object", "properties": { "lowerBoundary": { "type": "string", "nullable": true }, "upperBoundary": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NumericToggleDisplayControlDto": { "type": "object", "properties": { "falseValue": { "type": "string", "nullable": true }, "trueValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NumericValueClassification": { "type": "object", "properties": { "range": { "$ref": "#/components/schemas/NumericRange" } }, "additionalProperties": false }, "NumericValueClassificationDto": { "type": "object", "properties": { "range": { "$ref": "#/components/schemas/NumericRangeDto" } }, "additionalProperties": false }, "OperationalContextDeviceRole": { "enum": [ "Canary", "Pilot", "Stable" ], "type": "string" }, "OperationalContextDto": { "type": "object", "properties": { "activatedAt": { "type": "string", "description": "Point in time the device was activated at.", "format": "date-time" }, "pendingRequests": { "type": "integer", "description": "Number of activation and deactivation requests that are not processed yet.", "format": "int32" }, "mobileDataConnection": { "$ref": "#/components/schemas/OperationalContextMobileDataConnection" }, "countryCode": { "type": "string", "description": "Country the device is operated in.", "nullable": true }, "timeZone": { "type": "string", "description": "Time zone the device is operated in.", "nullable": true }, "label": { "type": "string", "description": "Label the device was activated with.", "nullable": true }, "deviceRole": { "$ref": "#/components/schemas/OperationalContextDeviceRole" }, "geoCoordinate": { "$ref": "#/components/schemas/OperationalContextGeoCoordinateDto" } }, "additionalProperties": false, "description": "Current operational context of a device as reported by the operational context service." }, "OperationalContextGeoCoordinateDto": { "type": "object", "properties": { "latitude": { "type": "number", "description": "Latitude in degrees.", "format": "double" }, "longitude": { "type": "number", "description": "Longitude in degrees.", "format": "double" } }, "additionalProperties": false, "description": "Geo coordinate of a device as reported by the operational context service." }, "OperationalContextMobileDataConnection": { "enum": [ "NotCapable", "Enabled", "Disabled" ], "type": "string" }, "OrDto": { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceFilterTermDto" }, "nullable": true } }, "additionalProperties": false }, "OrderDirection": { "enum": [ "Ascending", "Descending" ], "type": "string" }, "PagedResultDtoOfCloudToDeviceDistributionTaskByDeviceResponseDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskByDeviceResponseDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfCloudToDeviceDistributionTaskJobResponseDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskJobResponseDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfCloudToDeviceDistributionTaskRepeatableJobResponseDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskRepeatableJobResponseDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfCloudToDeviceDistributionTaskResponseDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CloudToDeviceDistributionTaskResponseDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfCustomerDescedantDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDescedantDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfCustomerDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfCustomerRelationChildDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerRelationChildDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfCustomerServiceRequestDetailsDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerServiceRequestDetailsDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfDeviceDataLinkInfoDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceDataLinkInfoDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfDeviceDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfDeviceServiceRequestDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceServiceRequestDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfDeviceServiceRequestResellerSummaryDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceServiceRequestResellerSummaryDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfDeviceSettingsChangeDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceSettingsChangeDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfDocumentDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfDocumentJobDocumentDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentJobDocumentDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfDocumentJobDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentJobDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfEffectiveRoleAssignmentDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/EffectiveRoleAssignmentDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfPermissionDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfResourceValueHistoryEntryDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceValueHistoryEntryDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfRoleDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RoleDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfRolePermissionDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RolePermissionDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfStoredDeviceFilterWithoutTermDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/StoredDeviceFilterWithoutTermDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfSystemRoleAssignmentDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SystemRoleAssignmentDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfUserCustomerRoleAssignmentsDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserCustomerRoleAssignmentsDto" }, "nullable": true } }, "additionalProperties": false }, "PagedResultDtoOfUserDto": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" }, "nullable": true } }, "additionalProperties": false }, "PermissionCode": { "enum": [ "ADD_BENEFICIARIES", "ADD_FACILITY_MANAGEMENT_CLIENT", "ADD_INVOICESOURCES", "ADD_SUBCUSTOMERS", "ADD_SUBSIDIARIES", "ADMINISTER_SYSTEM", "CHANGE_TECHNICAL_CHECK_DUE_DATE", "CREATE_CUSTOMER_SERVICE_REQUEST_CUSTOMER", "CREATE_CUSTOMER_SERVICE_REQUEST_RESELLER", "CREATE_DISTINCT_DEVICE_SERVICE_REQUESTS", "CREATE_DISTINCT_SERVICE_REQUESTS", "CREATE_INDISTINCT_DEVICE_SERVICE_REQUESTS", "CREATE_INDISTINCT_SERVICE_REQUESTS", "DEFINE_RESELLERS", "DELETE_CUSTOMERS", "EDIT_ANALYSIS_TEMPLATES", "EDIT_CALENDAR", "EDIT_CAPABILITY_GRANTS_ON_CUSTOMERS", "EDIT_COMPETITORS", "EDIT_CUSTOMER", "EDIT_CUSTOMER_BRANDING", "EDIT_CUSTOMER_SERVICE_REQUEST_SETTINGS", "EDIT_CUSTOMER_STATUS", "EDIT_CUSTOMER_SUPPORT_INFORMATION", "EDIT_DEVICE_FORWARDING_RULES", "EDIT_DEVICE_MONITORING_RULES", "EDIT_DEVICES_NETWORK_INFRASTRUCTURE", "EDIT_DEVICE_NETWORK_SETTINGS", "EDIT_DEVICES", "EDIT_DEVICES_LAUNDRY", "EDIT_DEVICES_WASHROOM", "EDIT_DEVICES_OBJECT_HYGIENE", "EDIT_DEVICES_KITCHEN", "EDIT_DEVICES_RESTRICTED", "MAINTAIN_DEVICES_KITCHEN", "MANAGE_CUSTOMER_DEVICE_TYPE_VARIANT_SETTINGS", "EDIT_DISTRIBUTION_TASK_REPEATABLE_JOBS", "EDIT_DEVICE_DOCUMENTS", "EDIT_RESTRICTED_DEVICE_DOCUMENTS", "EDIT_CUSTOMER_DEVICE_TYPE_EXTENSIONS", "VIEW_DISTRIBUTION_TASK_REPEATABLE_JOBS", "EDIT_DISTRIBUTION_TASK_JOBS", "VIEW_DISTRIBUTION_TASK_JOBS", "EDIT_EXTERNAL_ACCESS_CLASS_DEVELOPMENT", "EDIT_EXTERNAL_ACCESS_CLASS_DEVELOPMENT_SYSTEM", "EDIT_EXTERNAL_ACCESS_CLASS_EVERYONE", "EDIT_EXTERNAL_ACCESS_CLASS_EVERYONE_SYSTEM", "EDIT_EXTERNAL_ACCESS_CLASS_MAINTENANCE", "EDIT_EXTERNAL_ACCESS_CLASS_MAINTENANCE_SYSTEM", "EDIT_EXTERNAL_ACCESS_CLASS_OEM", "EDIT_EXTERNAL_ACCESS_CLASS_OEM_SYSTEM", "EDIT_ITEM_CATEGORIES", "EDIT_ITEM_PRICES", "EDIT_ITEMS", "EDIT_LOCATION_IMAGES", "EDIT_LOCATION_NAME_SUGGESTIONS", "EDIT_LOCATIONS", "EDIT_OPERATIONAL_PROFILES", "EDIT_ORDERS", "EDIT_PERSONAL_STORED_DEVICE_FILTERS", "EDIT_PUBLIC_STORED_DEVICE_FILTERS", "EDIT_REFILL_ITEM_SETTINGS", "EDIT_REFILLS", "EDIT_RESOURCE_DATA_EVENT_PUBLICATION_RULES", "EDIT_ROLE_INHERITANCE_ALLOWANCE", "EDIT_ROLES", "EDIT_ROOM_TYPES", "EDIT_SERVICE_AREAS", "EDIT_SERVICE_REQUEST_SETTINGS", "EDIT_SERVICE_SETTINGS", "EDIT_SUBCUSTOMER_RESELLER_PROPERTIES", "EDIT_UNREGISTERED_DEVICES", "EDIT_USER_ASSIGNMENTS", "EDIT_USERS", "FORCE_UNBLOCK_CUSTOMER", "HANDLE_CUSTOMER_SERVICE_REQUESTS", "HANDLE_DEVICE_SERVICE_REQUESTS", "HANDLE_SERVICE_REQUESTS", "MANAGE_DOCUMENT_JOBS", "ORDER_CUSTOMER_SERVICE_REQUESTS", "ORDER_DEVICE_SERVICE_REQUESTS", "ORDER_SERVICE_REQUESTS", "PERFORM_STOCKTAKING", "PERFORM_TECHNICAL_CHECKS", "READ_TECHNICAL_CHECKS", "RESET_DATA_LINK_STATISTICS", "UNREGISTER_DEVICES", "VIEW_ANALYSIS_TEMPLATES", "VIEW_CALENDAR", "VIEW_CAPABILITY_GRANTS_ON_CUSTOMER", "VIEW_COMPETITORS", "VIEW_CUSTOMER", "VIEW_CUSTOMER_SELF_ASSIGNMENT_CREDENTIALS", "VIEW_CUSTOMER_SERVICE_REQUEST_CUSTOMER", "VIEW_CUSTOMER_SERVICE_REQUEST_RESELLER", "VIEW_CUSTOMER_DEVICE_TYPE_EXTENSIONS", "VIEW_RESTRICTED_CUSTOMER_DEVICE_TYPE_EXTENSIONS", "VIEW_DEVICE_FORWARDING_RULES", "VIEW_DEVICE_LIFE_CYCLE_DATA", "VIEW_DEVICE_MONITORING_RULES", "VIEW_DEVICE_SETTING_CHANGES", "VIEW_DEVICES", "VIEW_DEVICES_RESTRICTED", "VIEW_RESTRICTED_DEVICE_DOCUMENTS", "VIEW_EXTERNAL_ACCESS_CLASS_DEVELOPMENT", "VIEW_EXTERNAL_ACCESS_CLASS_DEVELOPMENT_SYSTEM", "VIEW_EXTERNAL_ACCESS_CLASS_EVERYONE", "VIEW_EXTERNAL_ACCESS_CLASS_EVERYONE_SYSTEM", "VIEW_EXTERNAL_ACCESS_CLASS_MAINTENANCE", "VIEW_EXTERNAL_ACCESS_CLASS_MAINTENANCE_SYSTEM", "VIEW_EXTERNAL_ACCESS_CLASS_OEM", "VIEW_EXTERNAL_ACCESS_CLASS_OEM_SYSTEM", "VIEW_ITEMS", "VIEW_OPERATIONAL_INFORMATION", "VIEW_ORDERS", "VIEW_RESOURCE_DATA_EVENT_PUBLICATION_RULES", "VIEW_ROOM_TYPES", "VIEW_UNREGISTERED_DEVICES", "VIEW_USER_BLOCKING_CUSTOMER", "VIEW_USER_ROLE_ASSIGNMENTS", "VIEW_USER_ROLE_ASSIGNMENTS_FROM_CONDITIONOWNER", "VIEW_USER_ROLE_ASSIGNMENTS_FROM_FACILITY_MANAGEMENT_PROVIDER", "VIEW_USER_ROLE_ASSIGNMENTS_FROM_INVOICERECIPIENT", "VIEW_USER_ROLE_ASSIGNMENTS_FROM_PARENT", "VIEW_USER_ROLE_ASSIGNMENTS_FROM_RESELLER", "VIEW_USER_ROLE_ASSIGNMENTS_FROM_SYSTEM", "VIEW_USERS" ], "type": "string" }, "PermissionDto": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/PermissionType" }, "description": { "type": "string", "nullable": true }, "deprecated": { "type": "boolean" }, "clientSystems": { "type": "array", "items": { "$ref": "#/components/schemas/ClientSystemDto" }, "nullable": true } }, "additionalProperties": false }, "PermissionType": { "enum": [ "System", "Customer" ], "type": "string" }, "PersonalAccessTokenResponseDto": { "type": "object", "properties": { "personalAccessTokenId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "PhraseDto": { "type": "object", "properties": { "translations": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationDto" } }, "bestMatchingLanguageTag": { "type": "string" } }, "additionalProperties": false }, "PortalApplicationDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/PhraseDto" }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PredefinedAdaptiveInterval": { "enum": [ "CurrentMinute", "CurrentHour", "CurrentDay", "CurrentWeek", "CurrentMonth", "CurrentYear", "LastMinute", "LastHour", "LastDay", "LastWeek", "LastMonth", "LastYear" ], "type": "string" }, "PredefinedDateIntervalDto": { "type": "object", "properties": { "firstDayOfWeek": { "$ref": "#/components/schemas/DayOfWeek" }, "predefinedAdaptiveInterval": { "$ref": "#/components/schemas/PredefinedAdaptiveInterval" } }, "additionalProperties": false }, "RankedNetChangesAnalysisRequestDto": { "required": [ "dateIntervalDefinition", "deviceFilter", "resource", "timeZone" ], "type": "object", "properties": { "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "resource": { "$ref": "#/components/schemas/AnalysisResourceDto" }, "dateIntervalDefinition": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" }, "timeZone": { "maxLength": 40, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "ReInviteUserToSecurableDto": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RecentlyAccessedCustomerDto": { "type": "object", "properties": { "latestAccessedAt": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "code": { "type": "string", "nullable": true }, "name1": { "type": "string", "nullable": true }, "name2": { "type": "string", "nullable": true }, "name3": { "type": "string", "nullable": true }, "name4": { "type": "string", "nullable": true }, "address1": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "customerNumber": { "type": "string", "nullable": true }, "resellerId": { "type": "integer", "format": "int32" }, "reseller": { "$ref": "#/components/schemas/CustomerResellerDto" }, "isReseller": { "type": "boolean" }, "externallyManaged": { "type": "boolean" }, "concatenatedName": { "type": "string", "nullable": true }, "locale": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "vatIdentificationNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RefillFamilyDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "lifeCycleStatus": { "$ref": "#/components/schemas/RefillFamilyLifeCycleStatus" } }, "additionalProperties": false }, "RefillFamilyLifeCycleStatus": { "enum": [ "Active", "Inactive" ], "type": "string" }, "RefillItemAssociationMode": { "enum": [ "None", "Manual", "Automatic" ], "type": "string" }, "RefillItemDeviceAssociationDto": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time", "nullable": true }, "refillItem": { "$ref": "#/components/schemas/RefillItemSlimDto" } }, "additionalProperties": false }, "RefillItemDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "resellerId": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "lifeCycleStatus": { "$ref": "#/components/schemas/RefillItemLifeCycleStatus" }, "itemNumber": { "type": "string", "nullable": true }, "automaticAssociationIdentifier": { "type": "string", "nullable": true }, "refillFamily": { "$ref": "#/components/schemas/RefillFamilyDto" }, "isExternallyManaged": { "type": "boolean" }, "deviceTypes": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceTypeDto" }, "nullable": true }, "incompatibleRefillItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "RefillItemFilterDto": { "type": "object", "properties": { "refillItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "RefillItemIncompatibilityDto": { "type": "object", "properties": { "refillItem1Id": { "type": "integer", "format": "int32" }, "refillItem2Id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RefillItemInheritanceMode": { "enum": [ "InheritAllButSelected", "InheritOnlySelected", "DoNotInherit" ], "type": "string" }, "RefillItemLifeCycleStatus": { "enum": [ "Active", "Deprecated", "Archived" ], "type": "string" }, "RefillItemSettingsDto": { "type": "object", "properties": { "refillItemInheritanceMode": { "$ref": "#/components/schemas/RefillItemInheritanceMode" } }, "additionalProperties": false }, "RefillItemSlimDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "itemNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RelativeDateIntervalDto": { "type": "object", "properties": { "startOffset": { "$ref": "#/components/schemas/TimeOffsetDto" }, "endOffset": { "$ref": "#/components/schemas/TimeOffsetDto" }, "dateTimeAdjustmentMethod": { "$ref": "#/components/schemas/DateTimeAdjustmentMethod" }, "dateTimeRoundingPart": { "$ref": "#/components/schemas/DateTimeOffsetAdjustmentPart" }, "firstDayOfWeek": { "$ref": "#/components/schemas/DayOfWeek" }, "startIncluded": { "type": "boolean" }, "endIncluded": { "type": "boolean" } }, "additionalProperties": false }, "ReorderLocationsDto": { "type": "object", "properties": { "parentLocationId": { "type": "integer", "format": "int32", "nullable": true }, "orderedChildrenLocationIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "ResourceDataEventPublicationRuleConnectionStringsResponseDto": { "type": "object", "properties": { "signalR": { "type": "string" }, "queue": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleQueueConnectionResponseDto" } }, "additionalProperties": false }, "ResourceDataEventPublicationRuleCreateDto": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "resourceInstanceEquivalentId": { "type": "string", "format": "uuid", "nullable": true }, "resourceInstanceIdentifier": { "$ref": "#/components/schemas/ResourceIdentifierWithoutEquivalenceDto" }, "condition": { "oneOf": [ { "$ref": "#/components/schemas/ClassifiedFilterConditionDto" }, { "$ref": "#/components/schemas/ExpressionedFilterConditionDto" } ] }, "devicesFilter": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "additionalProperties": false }, "ResourceDataEventPublicationRuleQueueConnectionResponseDto": { "type": "object", "properties": { "queueName": { "type": "string" }, "listenerConnectionString": { "type": "string" } }, "additionalProperties": false }, "ResourceDataEventPublicationRuleResponseDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "customerId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "connectionStrings": { "$ref": "#/components/schemas/ResourceDataEventPublicationRuleConnectionStringsResponseDto" }, "resourceInstanceEquivalentId": { "type": "string", "format": "uuid", "nullable": true }, "resourceInstanceIdentifier": { "$ref": "#/components/schemas/ResourceIdentifierWithoutEquivalenceResponseDto" }, "condition": { "oneOf": [ { "$ref": "#/components/schemas/ClassifiedFilterConditionDto" }, { "$ref": "#/components/schemas/ExpressionedFilterConditionDto" } ] }, "devicesFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ResourceDataEventPublicationRuleUpdateDto": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "resourceInstanceEquivalentId": { "type": "string", "format": "uuid", "nullable": true }, "resourceInstanceIdentifier": { "$ref": "#/components/schemas/ResourceIdentifierWithoutEquivalenceDto" }, "condition": { "oneOf": [ { "$ref": "#/components/schemas/ClassifiedFilterConditionDto" }, { "$ref": "#/components/schemas/ExpressionedFilterConditionDto" } ] }, "devicesFilter": { "$ref": "#/components/schemas/DeviceFilterDto" } }, "additionalProperties": false }, "ResourceIdentifierWithoutEquivalenceDto": { "type": "object", "properties": { "resourceTypeId": { "type": "integer", "format": "int32" }, "resourceInstanceNo": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResourceIdentifierWithoutEquivalenceResponseDto": { "type": "object", "properties": { "resourceTypeId": { "type": "integer", "format": "int32" }, "resourceInstanceNo": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResourceInstanceEquivalentDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "string", "format": "date-time" }, "description": { "$ref": "#/components/schemas/CatalogElementDescriptionDto" }, "dataType": { "$ref": "#/components/schemas/SpecificDataType" }, "displayHint": { "$ref": "#/components/schemas/DisplayHintDto" }, "valueClassifications": { "type": "array", "items": { "$ref": "#/components/schemas/ValueClassificationDto" }, "nullable": true }, "monotonousBehavior": { "$ref": "#/components/schemas/MonotonousBehavior" }, "isEnumeratedType": { "type": "boolean" }, "absoluteResourceInstanceEquivalentId": { "type": "string", "format": "uuid", "nullable": true }, "unitSettings": { "$ref": "#/components/schemas/UnitSettingsDto" } }, "additionalProperties": false }, "ResourceInstanceStatusDto": { "type": "object", "properties": { "actualValue": { "type": "string", "nullable": true }, "unit": { "type": "string", "nullable": true }, "className": { "type": "string", "nullable": true }, "classDescription": { "type": "string", "nullable": true }, "classIcon": { "type": "string", "format": "uri", "nullable": true }, "neutralIcon": { "type": "string", "format": "uri", "nullable": true }, "valueClassification": { "$ref": "#/components/schemas/ValueClassificationKind" } }, "additionalProperties": false }, "ResourceValueBooleanDto": { "allOf": [ { "$ref": "#/components/schemas/ResourceValueDataDto" }, { "type": "object", "properties": { "value": { "type": "boolean" }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "ResourceValueDataDto": { "required": [ "$type" ], "type": "object", "properties": { "$type": { "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "$type" } }, "ResourceValueDoubleDto": { "allOf": [ { "$ref": "#/components/schemas/ResourceValueDataDto" }, { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "ResourceValueDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "data": { "oneOf": [ { "$ref": "#/components/schemas/ResourceValueIntegerDto" }, { "$ref": "#/components/schemas/ResourceValueStringDto" }, { "$ref": "#/components/schemas/ResourceValueDoubleDto" }, { "$ref": "#/components/schemas/ResourceValueBooleanDto" } ], "nullable": true } }, "additionalProperties": false }, "ResourceValueHistoryEntryDto": { "type": "object", "properties": { "loggedAt": { "type": "string", "format": "date-time" }, "resourceValue": { "$ref": "#/components/schemas/ResourceValueDto" } }, "additionalProperties": false }, "ResourceValueIntegerDto": { "allOf": [ { "$ref": "#/components/schemas/ResourceValueDataDto" }, { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "ResourceValueStringDto": { "allOf": [ { "$ref": "#/components/schemas/ResourceValueDataDto" }, { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "RoleAssignmentTypeDto": { "enum": [ "System", "Direct", "Reseller", "Hierarchy", "Invoice", "Condition", "FacilityManagement" ], "type": "string" }, "RoleDefinitionDto": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "isProtected": { "type": "boolean" }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDto" }, "nullable": true }, "propagateToSubCustomers": { "type": "boolean" }, "propagateToSubsidiaries": { "type": "boolean" }, "propagateToInvoiceSources": { "type": "boolean" }, "propagateToBeneficiaries": { "type": "boolean" }, "propagateToFacilityManagementClients": { "type": "boolean" } }, "additionalProperties": false }, "RoleDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "string", "nullable": true }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "isProtected": { "type": "boolean" }, "propagateToSubCustomers": { "type": "boolean" }, "propagateToSubsidiaries": { "type": "boolean" }, "propagateToInvoiceSources": { "type": "boolean" }, "propagateToBeneficiaries": { "type": "boolean" }, "propagateToFacilityManagementClients": { "type": "boolean" }, "clientSystems": { "type": "array", "items": { "$ref": "#/components/schemas/ClientSystemDto" }, "nullable": true } }, "additionalProperties": false }, "RolePermissionDto": { "type": "object", "properties": { "roleCode": { "type": "string", "nullable": true }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "isProtected": { "type": "boolean" }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDto" }, "nullable": true } }, "additionalProperties": false }, "RoomDto": { "type": "object", "properties": { "roomTypeId": { "type": "integer", "format": "int32", "nullable": true }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/ImageDto" }, "nullable": true }, "parentLocationId": { "type": "integer", "format": "int32", "nullable": true }, "locationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "locationType": { "$ref": "#/components/schemas/LocationType" } }, "additionalProperties": false }, "RoomUpdateDto": { "type": "object", "properties": { "roomTypeId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "parentLocationId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SecurableTypeDto": { "enum": [ "System", "Customer" ], "type": "string" }, "SegmentDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "netChange": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "SelectedInheritanceRefillItemDto": { "type": "object", "properties": { "resellerId": { "type": "integer", "format": "int32" }, "refillItemId": { "type": "integer", "format": "int32" }, "refillItemName": { "$ref": "#/components/schemas/PhraseDto" } }, "additionalProperties": false }, "ServiceAreaDetailsDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "resellerId": { "type": "integer", "format": "int32" }, "deviceTypes": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceTypeDto" }, "nullable": true } }, "additionalProperties": false }, "ServiceAreaDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "resellerId": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "isExternallyManaged": { "type": "boolean" } }, "additionalProperties": false }, "ServiceAreaListingDto": { "type": "object", "properties": { "isExternallyManaged": { "type": "boolean" }, "serviceAreas": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceAreaSlimDto" }, "nullable": true } }, "additionalProperties": false }, "ServiceAreaReferenceDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServiceAreaSlimDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "resellerId": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" } }, "additionalProperties": false }, "ServiceRequestActiveStatus": { "enum": [ "Active", "Inactive" ], "type": "string" }, "ServiceRequestImageDto": { "type": "object", "properties": { "binaryFileId": { "type": "string", "format": "uuid" }, "fileId": { "type": "integer", "format": "int32" }, "url": { "type": "string", "nullable": true }, "mediaType": { "type": "string", "nullable": true }, "fileSize": { "type": "integer", "format": "int32" }, "thumbnails": { "type": "array", "items": { "$ref": "#/components/schemas/ThumbnailDto" }, "nullable": true } }, "additionalProperties": false }, "ServiceRequestProblemTypeUsage": { "enum": [ "ProblemTypeAndActualProblemType", "OnlyProblemType", "OnlyActualProblemType" ], "type": "string" }, "ServiceRequestStatus": { "enum": [ "Created", "Ordered", "InProgress", "Cancelled", "Closed" ], "type": "string" }, "ServiceRequestStatusHistoryEntryDto": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/UserReferenceDto" }, "status": { "$ref": "#/components/schemas/ServiceRequestStatus" }, "modifiedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "SeverityDto": { "enum": [ "Error", "Warning", "Info" ], "type": "string" }, "SimpleUser": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SlicedNetChangesAnalysisRequestDto": { "required": [ "dateIntervalDefinition", "deviceFilter", "locale", "resource", "timeSliceSize", "timeZone" ], "type": "object", "properties": { "dateIntervalDefinition": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" }, "timeSliceSize": { "$ref": "#/components/schemas/TimeBucket" }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "resource": { "$ref": "#/components/schemas/AnalysisResourceDto" }, "timeZone": { "maxLength": 40, "minLength": 1, "type": "string" }, "locale": { "maxLength": 35, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "SlicedSummedStatusDurationDto": { "required": [ "durationInSeconds", "statusName", "statusValue" ], "type": "object", "properties": { "statusName": { "minLength": 1, "type": "string", "description": "Translated ValueClassification value" }, "statusValue": { "type": "integer", "description": "The numeric status value", "format": "int32" }, "durationInSeconds": { "type": "integer", "description": "Duration in seconds", "format": "int32" } }, "additionalProperties": false, "description": "Status duration DTO for sliced analysis with translated status name" }, "SlicedSummedStatusDurationResponseDto": { "required": [ "statusDurations", "timeRange", "timeSliceName" ], "type": "object", "properties": { "timeSliceName": { "minLength": 1, "type": "string", "description": "The name of the time slice" }, "timeRange": { "$ref": "#/components/schemas/TimeRangeDto" }, "statusDurations": { "type": "array", "items": { "$ref": "#/components/schemas/SlicedSummedStatusDurationDto" }, "description": "The status durations for this time slice" } }, "additionalProperties": false, "description": "Response DTO for a single time slice in sliced summed status durations analysis" }, "SlicedSummedStatusDurationsAnalysisRequestDto": { "required": [ "dateIntervalDefinition", "deviceFilter", "locale", "resource", "statusValues", "timeSliceSize", "timeZone" ], "type": "object", "properties": { "dateIntervalDefinition": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" }, "timeSliceSize": { "$ref": "#/components/schemas/TimeBucket" }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "resource": { "$ref": "#/components/schemas/AnalysisResourceDto" }, "timeZone": { "maxLength": 40, "minLength": 0, "type": "string", "description": "The TZ identifier of a timezone. E.g. Europe/Vienna. This timezone is used for all time-zone relevant operations in the analysis, e.g. when slicing time." }, "locale": { "maxLength": 35, "minLength": 0, "type": "string", "description": "IETF BCP 47 language tag. Locale specific data in the response will be generated based on this locale." }, "statusValues": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The status values to include in the analysis" } }, "additionalProperties": false, "description": "Request DTO for sliced summed status durations analysis" }, "SlimAttributeDetailsDto": { "type": "object", "properties": { "attributeId": { "type": "string", "format": "uuid" }, "lastUpdatedAt": { "type": "string", "format": "date-time", "nullable": true }, "integerData": { "$ref": "#/components/schemas/IntegerDataDto" }, "floatData": { "$ref": "#/components/schemas/FloatDataDto" }, "enumerationData": { "type": "integer", "format": "int32", "nullable": true }, "stringData": { "type": "string", "nullable": true }, "booleanData": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "SlimDeviceDto": { "type": "object", "properties": { "itemNumber": { "type": "string", "nullable": true }, "productTypeCode": { "type": "string", "nullable": true }, "class": { "$ref": "#/components/schemas/DeviceClass" }, "state": { "$ref": "#/components/schemas/DeviceLifeCycleState" }, "deviceTypeVariant": { "$ref": "#/components/schemas/SlimDeviceTypeVariantDto" }, "deviceId": { "type": "string", "format": "uuid" }, "deviceIdInt": { "type": "integer", "format": "int32" }, "deviceTypeAlias": { "type": "string", "nullable": true }, "deviceTypeName": { "type": "string", "nullable": true }, "deviceTypeDescription": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "networkId": { "type": "string", "nullable": true }, "displayImage": { "type": "string", "format": "uri", "nullable": true }, "deviceTypeImage": { "$ref": "#/components/schemas/DeviceTypeImageDto" }, "locationPath": { "type": "array", "items": { "$ref": "#/components/schemas/LocationPathDto" }, "nullable": true }, "mountPoint": { "type": "string", "nullable": true }, "lastDataReceived": { "type": "string", "format": "date-time", "nullable": true }, "deviceTypeCompetenceClassCode": { "type": "string", "nullable": true }, "deviceTypeCompetenceClassName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SlimDeviceTypeVariantDto": { "type": "object", "properties": { "deviceTypeVariantId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "displayImage": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "SpecificDataType": { "enum": [ "None", "Int8", "Int16", "Int32", "Int64", "Uint8", "Uint16", "Uint32", "Uint64", "Double", "String", "Bool", "Array" ], "type": "string" }, "StatusTransitionCountAnalysisRequestDto": { "required": [ "dateIntervalDefinition", "deviceFilter", "resource", "statusTransitions", "timeZone" ], "type": "object", "properties": { "dateIntervalDefinition": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" }, "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "resource": { "$ref": "#/components/schemas/AnalysisResourceDto" }, "timeZone": { "maxLength": 40, "minLength": 1, "type": "string" }, "statusTransitions": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/StatusTransitionDto" } } }, "additionalProperties": false }, "StatusTransitionCountResponseDto": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "StatusTransitionDto": { "required": [ "from", "to" ], "type": "object", "properties": { "from": { "type": "integer", "format": "int32" }, "to": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "StepDisplayControlDto": { "type": "object", "properties": { "valueDisplayBehavior": { "$ref": "#/components/schemas/ValueDisplayBehavior" }, "stepControlType": { "type": "string", "nullable": true }, "steppingBehavior": { "$ref": "#/components/schemas/SteppingBehaviorDto" } }, "additionalProperties": false }, "SteppingBehaviorDto": { "type": "object", "properties": { "equalStepBehavior": { "$ref": "#/components/schemas/EqualStepBehaviorDto" }, "discreteStepBehavior": { "$ref": "#/components/schemas/DiscreteStepBehaviorDto" } }, "additionalProperties": false }, "StoredDeviceFilterDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customerId": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "visibility": { "$ref": "#/components/schemas/DeviceFilterVisibility" }, "propagateToSubCustomers": { "type": "boolean" }, "propagateToSubsidiaries": { "type": "boolean" }, "propagateToInvoiceSources": { "type": "boolean" }, "propagateToBeneficiaries": { "type": "boolean" }, "propagateToFacilityManagementClients": { "type": "boolean" }, "filterTerm": { "$ref": "#/components/schemas/DeviceFilterTermDto" } }, "additionalProperties": false }, "StoredDeviceFilterWithoutTermDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customerId": { "type": "integer", "format": "int32" }, "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "visibility": { "$ref": "#/components/schemas/DeviceFilterVisibility" }, "propagateToSubCustomers": { "type": "boolean" }, "propagateToSubsidiaries": { "type": "boolean" }, "propagateToInvoiceSources": { "type": "boolean" }, "propagateToBeneficiaries": { "type": "boolean" }, "propagateToFacilityManagementClients": { "type": "boolean" } }, "additionalProperties": false }, "StringConditionComparisonType": { "enum": [ "Equal", "StartsWith" ], "type": "string" }, "StringDataSettingsDto": { "type": "object", "properties": { "maxLength": { "type": "integer", "format": "int32" }, "isMultiline": { "type": "boolean" } }, "additionalProperties": false }, "StringDisplayHintDto": { "type": "object", "additionalProperties": false }, "StringDropDownControlDto": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueDisplayBehavior": { "$ref": "#/components/schemas/ValueDisplayBehavior" } }, "additionalProperties": false }, "StringFilterConditionDto": { "allOf": [ { "$ref": "#/components/schemas/ExpressionedFilterConditionDto" }, { "type": "object", "properties": { "comparisonType": { "$ref": "#/components/schemas/StringConditionComparisonType" }, "comparisonValue": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "StringValueClassification": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringValueClassificationDto": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SummedNetChangeResponseDto": { "type": "object", "properties": { "timeBucketName": { "type": "string", "nullable": true }, "timeRange": { "$ref": "#/components/schemas/TimeRangeDto" }, "netChange": { "type": "number", "format": "double" } }, "additionalProperties": false }, "SummedRankedNetChangeDeviceDto": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/DeviceDto" }, "netChange": { "type": "number", "format": "double" } }, "additionalProperties": false }, "SummedRankedNetChangesDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SummedRankedNetChangeDeviceDto" }, "nullable": true } }, "additionalProperties": false }, "SummedStatusDurationDto": { "required": [ "durationInSeconds", "statusValue" ], "type": "object", "properties": { "statusValue": { "type": "integer", "description": "The numeric status value", "format": "int32" }, "statusName": { "type": "string", "description": "The translated status name (e.g., \"Full\", \"Empty\", etc.)", "nullable": true }, "durationInSeconds": { "type": "integer", "description": "Duration in seconds", "format": "int32" } }, "additionalProperties": false, "description": "Response DTO for status duration with translated status name" }, "SummedStatusDurationResponseDto": { "required": [ "durations" ], "type": "object", "properties": { "durations": { "type": "array", "items": { "$ref": "#/components/schemas/SummedStatusDurationDto" }, "description": "Collection of status durations with translated names" } }, "additionalProperties": false, "description": "Container response DTO for summed status durations with translated status names" }, "SummedStatusDurationsAnalysisRequestDto": { "required": [ "dateIntervalDefinition", "deviceFilter", "locale", "resource", "statusValues", "timeSliceSize", "timeZone" ], "type": "object", "properties": { "deviceFilter": { "$ref": "#/components/schemas/DeviceFilterDto" }, "resource": { "$ref": "#/components/schemas/AnalysisResourceDto" }, "dateIntervalDefinition": { "$ref": "#/components/schemas/DateIntervalDefinitionDto" }, "timeSliceSize": { "$ref": "#/components/schemas/TimeBucket" }, "timeZone": { "maxLength": 40, "minLength": 1, "type": "string" }, "locale": { "maxLength": 35, "minLength": 1, "type": "string" }, "statusValues": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "SummedUpNetChangeResponseDto": { "type": "object", "properties": { "netChange": { "type": "number", "format": "double" } }, "additionalProperties": false }, "SystemDeviceTypeMemberPlaceholderAssignmentDto": { "required": [ "deviceAssignments" ], "type": "object", "properties": { "systemDeviceTypeMemberPlaceholderId": { "type": "string", "format": "uuid" }, "deviceAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceAssignmentDto" } } }, "additionalProperties": false }, "SystemRoleAssignmentDto": { "type": "object", "properties": { "roleName": { "type": "string", "nullable": true }, "clientSystems": { "type": "array", "items": { "$ref": "#/components/schemas/ClientSystemDto" }, "nullable": true }, "id": { "type": "integer", "format": "int32" }, "userId": { "type": "string", "nullable": true }, "userDisplayName": { "type": "string", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "roleCode": { "type": "string", "nullable": true }, "applicableToRelatedCustomersOnly": { "type": "boolean" }, "externallyManaged": { "type": "boolean" }, "assignedAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TemperatureUnit": { "enum": [ "Celsius", "Fahrenheit" ], "type": "string" }, "TextBoxDisplayControlDto": { "type": "object", "additionalProperties": false }, "ThumbnailDto": { "type": "object", "properties": { "sizeVariant": { "$ref": "#/components/schemas/ThumbnailSizeVariant" }, "url": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "ThumbnailSizeVariant": { "enum": [ "Square256" ], "type": "string" }, "TimeBucket": { "enum": [ "FiveMinutes", "TenMinutes", "FifteenMinutes", "ThirtyMinutes", "FortyFiveMinutes", "OneHour", "ThreeHours", "SixHours", "EightHours", "TwelveHours", "OneDay", "OneWeek", "OneMonth" ], "type": "string" }, "TimeIntervalOffsetDto": { "type": "object", "properties": { "timeSpan": { "type": "string", "format": "date-span" } }, "additionalProperties": false }, "TimeOffsetDto": { "type": "object", "properties": { "monthOffset": { "$ref": "#/components/schemas/MonthOffsetDto" }, "timeIntervalOffset": { "$ref": "#/components/schemas/TimeIntervalOffsetDto" } }, "additionalProperties": false }, "TimeRangeDto": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TimeToLive": { "enum": [ "OneMinute", "FiveMinutes", "TenMinutes", "FifteenMinutes", "ThirtyMinutes", "OneHour", "TwoHours", "ThreeHours", "SixHours", "TwelveHours", "OneDay", "TwoDays", "OneWeek", "TwoWeeks", "OneMonth" ], "type": "string" }, "TranslationDto": { "type": "object", "properties": { "languageTag": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UnitConversionDto": { "type": "object", "properties": { "factorConstantConversion": { "$ref": "#/components/schemas/FactorConstantConversionDto" } }, "additionalProperties": false }, "UnitSettingsDto": { "type": "object", "properties": { "unitMetric": { "$ref": "#/components/schemas/ConversionUnit" }, "unitImperial": { "$ref": "#/components/schemas/ConversionUnit" }, "unitUsCustomary": { "$ref": "#/components/schemas/ConversionUnit" }, "unitStorage": { "$ref": "#/components/schemas/ConversionUnit" } }, "additionalProperties": false }, "UnitSettingsSlimDto": { "type": "object", "properties": { "unitMetric": { "type": "string", "nullable": true }, "unitImperial": { "type": "string", "nullable": true }, "unitUsCustomary": { "type": "string", "nullable": true }, "unitStorage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UnitSystem": { "enum": [ "Imperial", "Metric", "UsCustomary" ], "type": "string" }, "UnregisterDevicesDto": { "required": [ "deviceIds" ], "type": "object", "properties": { "deviceIds": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "UpdateCustomerCapabilityGrantDto": { "type": "object", "properties": { "availabilityLevel": { "$ref": "#/components/schemas/AvailabilityLevel" }, "propagateToSubCustomers": { "type": "boolean" }, "propagateToSubsidiaries": { "type": "boolean" }, "propagateToFacilityManagementClients": { "type": "boolean" } }, "additionalProperties": false }, "UpdateCustomerDeviceTypeLinkDto": { "required": [ "restrictedAccess", "url" ], "type": "object", "properties": { "title": { "maxLength": 100, "type": "string", "nullable": true }, "description": { "maxLength": 4000, "type": "string", "nullable": true }, "restrictedAccess": { "type": "boolean" }, "language": { "maxLength": 2, "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "UpdateCustomerSelectedInheritanceRefillItemsDto": { "type": "object", "properties": { "resellerId": { "type": "integer", "format": "int32" }, "refillItemIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "UpdateCustomerServiceRequestHandlingDataDto": { "type": "object", "properties": { "actualCustomerServiceRequestTypeId": { "type": "string", "format": "uuid", "nullable": true }, "handlingNotes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateCustomerServiceRequestOriginalDataDto": { "type": "object", "properties": { "appointmentNeeded": { "type": "boolean" }, "earliestDateOfService": { "type": "string", "format": "date-time" }, "requestNotes": { "type": "string", "nullable": true }, "relatedDeviceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "UpdateDeviceLocationAssignmentDto": { "type": "object", "properties": { "mountPoint": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateDeviceServiceRequestHandlingDataDto": { "type": "object", "properties": { "actualProblemTypeId": { "type": "integer", "format": "int32", "nullable": true }, "resolutionTypeId": { "type": "integer", "format": "int32", "nullable": true }, "handlingNotes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateDeviceServiceRequestProblemTypeDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/PhraseDto" }, "deviceTypeId": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/DeviceServiceRequestProblemTypeStatus" }, "usage": { "$ref": "#/components/schemas/ServiceRequestProblemTypeUsage" } }, "additionalProperties": false }, "UpdateDeviceServiceRequestResolutionTypeDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/PhraseDto" }, "deviceTypeId": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/DeviceServiceRequestResolutionTypeStatus" } }, "additionalProperties": false }, "UpdateDeviceServiceRequestSettingsDto": { "type": "object", "properties": { "allowDistinctServiceRequests": { "type": "boolean" }, "allowIndistinctServiceRequests": { "type": "boolean" }, "termsAndConditionsUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateDistinctDeviceServiceRequestOriginalDataDto": { "type": "object", "properties": { "problemTypeId": { "type": "integer", "format": "int32" }, "problemDescription": { "type": "string", "nullable": true }, "appointmentNeeded": { "type": "boolean" }, "earliestDateOfService": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "UpdateFreeServicePeriodDto": { "type": "object", "properties": { "serviceAreaId": { "type": "integer", "format": "int32" }, "periodInMonths": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UpdateFullServiceContractDto": { "type": "object", "properties": { "serviceAreaId": { "type": "integer", "format": "int32" }, "fromUtc": { "type": "string", "format": "date-time" }, "toUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "UpdateIndistinctDeviceServiceRequestOriginalDataDto": { "type": "object", "properties": { "deviceTypeId": { "type": "string", "format": "uuid" }, "deviceTypeVariantId": { "type": "string", "format": "uuid", "nullable": true }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "problemTypeId": { "type": "integer", "format": "int32" }, "problemDescription": { "type": "string", "nullable": true }, "appointmentNeeded": { "type": "boolean" }, "earliestDateOfService": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "UpdateRefillItemDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "resellerId": { "type": "integer", "format": "int32" }, "itemNumber": { "type": "string", "nullable": true }, "automaticAssociationIdentifier": { "type": "string", "nullable": true }, "lifeCycleStatus": { "$ref": "#/components/schemas/RefillItemLifeCycleStatus" }, "refillFamilyId": { "type": "string", "format": "uuid", "nullable": true }, "deviceTypes": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "UpdateServiceAreaDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "deviceTypeIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "UpdateStoredDeviceFilterDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "propagateToSubCustomers": { "type": "boolean", "nullable": true }, "propagateToSubsidiaries": { "type": "boolean", "nullable": true }, "propagateToInvoiceSources": { "type": "boolean", "nullable": true }, "propagateToBeneficiaries": { "type": "boolean", "nullable": true }, "propagateToFacilityManagementClients": { "type": "boolean", "nullable": true }, "filterTerm": { "$ref": "#/components/schemas/DeviceFilterTermDto" } }, "additionalProperties": false }, "UpdateStoredDeviceFilterVisibilityDto": { "type": "object", "properties": { "visibility": { "$ref": "#/components/schemas/DeviceFilterVisibility" } }, "additionalProperties": false }, "UpdateUserCapabilityGrantDto": { "type": "object", "properties": { "availabilityLevel": { "$ref": "#/components/schemas/AvailabilityLevel" } }, "additionalProperties": false }, "UserCustomerRoleAssignmentsDto": { "type": "object", "properties": { "roleAssignmentId": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" }, "roleName": { "type": "string", "nullable": true }, "roleCode": { "type": "string", "nullable": true }, "customerId": { "type": "integer", "format": "int32" }, "customerName1": { "type": "string", "nullable": true }, "customerName2": { "type": "string", "nullable": true }, "customerName3": { "type": "string", "nullable": true }, "customerName4": { "type": "string", "nullable": true }, "applicableToRelatedCustomersOnly": { "type": "boolean" }, "assignedAtUtc": { "type": "string", "format": "date-time" }, "isExternallyManaged": { "type": "boolean" }, "clientSystems": { "type": "array", "items": { "$ref": "#/components/schemas/ClientSystemDto" }, "nullable": true } }, "additionalProperties": false }, "UserDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "givenName": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "preferredCulture": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "synchronizationId": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/UserStatusDto" }, "lastActionUtc": { "type": "string", "format": "date-time", "nullable": true }, "externallyManaged": { "type": "boolean" }, "affiliation": { "type": "string", "nullable": true }, "openIdPictureUrl": { "type": "string", "nullable": true }, "openIdProfileUrl": { "type": "string", "nullable": true }, "systemOfUnits": { "$ref": "#/components/schemas/UnitSystem" }, "temperatureUnit": { "$ref": "#/components/schemas/TemperatureUnit" }, "waterHardnessUnit": { "$ref": "#/components/schemas/WaterHardnessUnit" } }, "additionalProperties": false }, "UserInvitationResultDto": { "type": "object", "properties": { "invitedUsers": { "type": "array", "items": { "$ref": "#/components/schemas/UserInvitationSuccessDto" }, "nullable": true } }, "additionalProperties": false }, "UserInvitationSuccessDto": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserLifecycleStatus": { "enum": [ "Active", "Created", "Deleted" ], "type": "string" }, "UserNotificationResponseDto": { "type": "object", "properties": { "sender": { "$ref": "#/components/schemas/UserResponseDto" }, "recipientId": { "type": "string" }, "sticky": { "type": "boolean" }, "readAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "notificationId": { "type": "string", "format": "uuid" }, "priority": { "type": "string" }, "notificationTypeDefinition": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { }, "nullable": true } }, "additionalProperties": false }, "UserNotificationStatisticsResponseDto": { "type": "object", "properties": { "unreadCount": { "type": "integer", "format": "int32" }, "readCount": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UserOrderingDto": { "enum": [ "ByName", "ByCreatedAt" ], "type": "string" }, "UserReferenceDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "givenName": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "affiliation": { "type": "string", "nullable": true }, "openIdPictureUrl": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/UserLifecycleStatus" } }, "additionalProperties": false }, "UserResponseDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "firstName": { "type": "string" }, "lastName": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserSlimDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserStatusDto": { "enum": [ "Active", "Created", "Deleted" ], "type": "string" }, "UserUnitPreferencesDto": { "type": "object", "properties": { "systemOfUnits": { "$ref": "#/components/schemas/UnitSystem" }, "temperatureUnit": { "$ref": "#/components/schemas/TemperatureUnit" }, "waterHardnessUnit": { "$ref": "#/components/schemas/WaterHardnessUnit" } }, "additionalProperties": false }, "ValidationMessageDto": { "type": "object", "properties": { "messageId": { "type": "string", "nullable": true }, "messageText": { "type": "string", "nullable": true }, "severity": { "$ref": "#/components/schemas/SeverityDto" } }, "additionalProperties": false }, "ValidationResultDto": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationMessageDto" }, "nullable": true } }, "additionalProperties": false }, "ValueClassificationDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/PhraseDto" }, "description": { "$ref": "#/components/schemas/PhraseDto" }, "iconId": { "type": "string", "format": "uuid", "nullable": true }, "neutralIconId": { "type": "string", "format": "uuid", "nullable": true }, "color": { "type": "string", "nullable": true }, "classValue": { "type": "integer", "format": "int32", "nullable": true }, "valueClassificationKind": { "$ref": "#/components/schemas/ValueClassificationKind" }, "numericValueClassification": { "$ref": "#/components/schemas/NumericValueClassificationDto" }, "stringValueClassification": { "$ref": "#/components/schemas/StringValueClassificationDto" }, "booleanValueClassification": { "$ref": "#/components/schemas/BooleanValueClassificationDto" } }, "additionalProperties": false }, "ValueClassificationKind": { "enum": [ "None", "Warning", "Error", "Information" ], "type": "string" }, "ValueClassificationKindGroup": { "enum": [ "ErrorAndWarning", "Error", "Warning", "Ok" ], "type": "string" }, "ValueDisplayBehavior": { "enum": [ "ActualValueBehavior", "ClassifiedValueBehavior" ], "type": "string" }, "WaterHardnessUnit": { "enum": [ "GermanWaterHardness", "MilliMolPerLiter", "MilliValPerLiter", "AmericanWaterHardness", "EnglishWaterHardness", "FrenchWaterHardness" ], "type": "string" } }, "securitySchemes": { "bearer": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://app-hag-identityserver-dev.azurewebsites.net/connect/authorize", "tokenUrl": "https://app-hag-identityserver-dev.azurewebsites.net/connect/token", "scopes": { "client-service": "" } } } } } }, "security": [ { } ] }