{ "openapi": "3.0.4", "info": { "title": "DataService API", "description": "Represents a data integration and modeling service.", "version": "v1.0" }, "servers": [ { "url": "https://demo.avaplace.com/api/asol/ds" } ], "paths": { "/api/v1/DataAgents": { "get": { "tags": [ "DataAgents" ], "summary": "Get a filtered collection of data-agent definitions.", "parameters": [ { "name": "ProviderCode", "in": "query", "description": "The data-provider code (optional).", "schema": { "type": "string" } }, { "name": "CustomCode", "in": "query", "description": "The data-agent custom code (optional).", "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } }, { "name": "includeDeleted", "in": "query", "description": "The include deleted flag", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentDefinitionCollectionResult" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "DataAgents" ], "summary": "Get a filtered collection of data-agent definitions.", "parameters": [ { "name": "ProviderCode", "in": "query", "description": "The data-provider code (optional).", "schema": { "type": "string" } }, { "name": "CustomCode", "in": "query", "description": "The data-agent custom code (optional).", "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } }, { "name": "includeDeleted", "in": "query", "description": "The include deleted flag", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentDefinitionCollectionResult" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "post": { "tags": [ "DataAgents" ], "summary": "Create a new data-agent definition.", "parameters": [ { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "requestBody": { "description": "The data-agent definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentDefinitionCreate" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentDefinition" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataAgents/{id}": { "get": { "tags": [ "DataAgents" ], "summary": "Get a data-agent definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-agent identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "DataAgents" ], "summary": "Get a data-agent definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-agent identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "put": { "tags": [ "DataAgents" ], "summary": "Update an existing data-agent definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-agent identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "requestBody": { "description": "The data-agent definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentDefinitionUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentDefinition" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "delete": { "tags": [ "DataAgents" ], "summary": "Delete a data-agent definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-agent identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataAgents/{code}": { "get": { "tags": [ "DataAgents" ], "summary": "Get a data-agent definition.", "parameters": [ { "name": "code", "in": "path", "description": "The unique code of data-agent instance.", "required": true, "schema": { "type": "string" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "DataAgents" ], "summary": "Get a data-agent definition.", "parameters": [ { "name": "code", "in": "path", "description": "The unique code of data-agent instance.", "required": true, "schema": { "type": "string" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataAgents/{id}/SwitchEnabled": { "post": { "tags": [ "DataAgents" ], "summary": "Switch enabled in data-agent definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-agent identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } }, { "name": "enabled", "in": "query", "description": "The enabled flag", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataAgents/{id}/Status": { "get": { "tags": [ "DataAgents" ], "summary": "Get a filtered collection of data-agent status history.", "parameters": [ { "name": "id", "in": "path", "description": "The data-agent identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "SourceId", "in": "query", "description": "The data-source identifier (optional).", "schema": { "type": "string" } }, { "name": "OperationId", "in": "query", "description": "The operation identifier (optional).", "schema": { "type": "string" } }, { "name": "StatusItemId", "in": "query", "description": "The status-item identifier (optional).", "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentStatusModelCollectionResult" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataModels": { "get": { "tags": [ "DataModels" ], "summary": "Get a filtered collection of data-model definitions.", "parameters": [ { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelDefinitionCollectionResult" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "DataModels" ], "summary": "Get a filtered collection of data-model definitions.", "parameters": [ { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelDefinitionCollectionResult" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataModels/{id}": { "get": { "tags": [ "DataModels" ], "summary": "Get a data-model definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "DataModels" ], "summary": "Get a data-model definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "delete": { "tags": [ "DataModels" ], "summary": "Delete a data-model definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataModels/Code/{code}": { "get": { "tags": [ "DataModels" ], "summary": "Get a data-model definition.", "parameters": [ { "name": "code", "in": "path", "description": "The data-model code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "DataModels" ], "summary": "Get a data-model definition.", "parameters": [ { "name": "code", "in": "path", "description": "The data-model code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataModels/{id}/Verify/DataObject": { "post": { "tags": [ "DataModels" ], "summary": "Verifies the given data object within a specified data model.", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the data model.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The data object to be verified.", "content": { "application/json": { "schema": { "description": "Represents a data object record model used to store key-value pairs representing the fields of a data object, along with its unique identifier." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelValidationResultModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataSources": { "get": { "tags": [ "DataSources" ], "summary": "Get a filtered collection of data-source definitions.", "parameters": [ { "name": "AgentId", "in": "query", "description": "The data-agent identifier (optional).", "schema": { "type": "string" } }, { "name": "ApplicationCode", "in": "query", "description": "The application code (optional).", "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceDefinitionCollectionResult" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "DataSources" ], "summary": "Get a filtered collection of data-source definitions.", "parameters": [ { "name": "AgentId", "in": "query", "description": "The data-agent identifier (optional).", "schema": { "type": "string" } }, { "name": "ApplicationCode", "in": "query", "description": "The application code (optional).", "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceDefinitionCollectionResult" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "post": { "tags": [ "DataSources" ], "summary": "Create a new data-source definition.", "parameters": [ { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "requestBody": { "description": "The data-source definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceDefinitionCreate" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceDefinition" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataSources/{id}": { "get": { "tags": [ "DataSources" ], "summary": "Get a data-source definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-source identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "DataSources" ], "summary": "Get a data-source definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-source identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "put": { "tags": [ "DataSources" ], "summary": "Update an existing data-source definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-source identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "requestBody": { "description": "The data-source definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceDefinitionUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "delete": { "tags": [ "DataSources" ], "summary": "Delete a data-source definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-source identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataSources/{id}/SwitchEnabled": { "post": { "tags": [ "DataSources" ], "summary": "Switch enabled in data-source definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-source identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "enabled", "in": "query", "description": "The enabled flag", "required": true, "schema": { "type": "boolean" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataSources/{id}/Status": { "get": { "tags": [ "DataSources" ], "summary": "Get a filtered collection of data-source status history.", "parameters": [ { "name": "id", "in": "path", "description": "The data-source identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "OperationId", "in": "query", "description": "The operation identifier (optional).", "schema": { "type": "string" } }, { "name": "StatusItemId", "in": "query", "description": "The status-item identifier (optional).", "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentStatusModelCollectionResult" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataSources/{id}/ConsumerSettings/Model": { "put": { "tags": [ "DataSources" ], "summary": "Upserts consumer settings for given model into data-source definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-source identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "requestBody": { "description": "The consumer settings for given model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceConsumedModelSettings" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataSources/{id}/ConsumerSettings/Model/{modelId}": { "delete": { "tags": [ "DataSources" ], "summary": "Removes consumer settings for given model from data-source definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-source identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "modelId", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataSources/{id}/IntegrationSettings": { "patch": { "tags": [ "DataSources" ], "summary": "Set integration settings (i.e. application code of integrated-application and clientId of service account) to data-source definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-source identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "requestBody": { "description": "The integration settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceIntegrationSettings" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataSources/{id}/ConfigureConsumer": { "patch": { "tags": [ "DataSources" ], "summary": "Configure MessageGateway consumer defined by the data-source integration settings.\nWarning: The registration of MessageGateway consumer is shared across all tenants.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceConsumerSettings" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataTransformations": { "get": { "tags": [ "DataTransformations" ], "summary": "Get a filtered collection of data-transformation definitions.", "parameters": [ { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } }, { "name": "sourceId", "in": "query", "description": "The data-source identifier or null", "schema": { "type": "string" } }, { "name": "agentId", "in": "query", "description": "The data-agent identifier or null", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataTransformationDefinitionCollectionResult" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "DataTransformations" ], "summary": "Get a filtered collection of data-transformation definitions.", "parameters": [ { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } }, { "name": "sourceId", "in": "query", "description": "The data-source identifier or null", "schema": { "type": "string" } }, { "name": "agentId", "in": "query", "description": "The data-agent identifier or null", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataTransformationDefinitionCollectionResult" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "post": { "tags": [ "DataTransformations" ], "summary": "Create a new data-transformation definition.", "parameters": [ { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "requestBody": { "description": "The data-transformation definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataTransformationDefinitionCreate" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataTransformationDefinition" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/DataTransformations/{id}": { "get": { "tags": [ "DataTransformations" ], "summary": "Get a data-transformation definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-transformation identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataTransformationDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "DataTransformations" ], "summary": "Get a data-transformation definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-transformation identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataTransformationDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "put": { "tags": [ "DataTransformations" ], "summary": "Update an existing data-transformation definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-transformation identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "requestBody": { "description": "The data-transformation definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataTransformationDefinitionUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataTransformationDefinition" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "delete": { "tags": [ "DataTransformations" ], "summary": "Delete a data-transformation definition.", "parameters": [ { "name": "id", "in": "path", "description": "The data-transformation identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accessLevel", "in": "query", "description": "The data access level (optional , auto if not set)", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Diagnostics/PerformanceStatistics": { "get": { "tags": [ "Diagnostics" ], "summary": "Gets the aggregated performance statistics", "parameters": [ { "name": "ApplicationCode", "in": "query", "description": "The code of application (optional if datasource ID is provided)", "schema": { "type": "string" } }, { "name": "SourceId", "in": "query", "description": "The data source ID (optional if application code is provided)", "schema": { "type": "string" } }, { "name": "From", "in": "query", "description": "The date and time range to get the statistics from date (example value 2025-01-31T15:30:00Z)", "schema": { "type": "string", "format": "date-time" } }, { "name": "To", "in": "query", "description": "The date and time range to get the statistics to date (example value 2025-02-04T15:30:00Z)", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceStatisticsAggregatedModelCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Diagnostics/PerformanceStatistics/{operationId}": { "get": { "tags": [ "Diagnostics" ], "summary": "Gets the performance statistics", "parameters": [ { "name": "ApplicationCode", "in": "query", "description": "The code of application (optional if datasource ID is provided)", "schema": { "type": "string" } }, { "name": "SourceId", "in": "query", "description": "The data source ID (optional if application code is provided)", "schema": { "type": "string" } }, { "name": "operationId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PerformanceStatisticsNonAggregatedModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Diagnostics/PerformanceDiagram": { "get": { "tags": [ "Diagnostics" ], "summary": "Gets the aggregated performance diagram for the given definition with time interval", "parameters": [ { "name": "ApplicationCode", "in": "query", "description": "The code of application (optional if datasource ID is provided)", "schema": { "type": "string" } }, { "name": "SourceId", "in": "query", "description": "The data source ID (optional if application code is provided)", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "description": "The start date of the interval for which the performance statistics are requested.", "schema": { "type": "string", "format": "date-time" } }, { "name": "DateTo", "in": "query", "description": "The end date of the interval for which the performance statistics are requested.", "schema": { "type": "string", "format": "date-time" } }, { "name": "MetricType", "in": "query", "description": "The type of metric to be used in the performance diagram.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Scale", "in": "query", "description": "The scale of the performance diagram, which determines the time unit for the diagram.", "schema": { "type": "integer", "format": "int32" } }, { "name": "preferInline", "in": "query", "description": "", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Diagnostics/PerformanceDiagram/{operationId}": { "get": { "tags": [ "Diagnostics" ], "summary": "Gets the performance diagram for the given definition with operation id", "parameters": [ { "name": "ApplicationCode", "in": "query", "description": "The code of application (optional if datasource ID is provided)", "schema": { "type": "string" } }, { "name": "SourceId", "in": "query", "description": "The data source ID (optional if application code is provided)", "schema": { "type": "string" } }, { "name": "MetricType", "in": "query", "description": "The type of metric to be used in the performance diagram.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Scale", "in": "query", "description": "The scale of the performance diagram, which determines the time unit for the diagram.", "schema": { "type": "integer", "format": "int32" } }, { "name": "operationId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "preferInline", "in": "query", "description": "", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Diagnostics/DataModel/{dataModelId}/ValidateDataObjectRecords": { "get": { "tags": [ "Diagnostics" ], "summary": "Validates data object records associated with a specific data model.", "parameters": [ { "name": "dataModelId", "in": "path", "description": "The unique identifier of the data model to validate.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "The optional identifier of the source to validate.", "schema": { "type": "string" } }, { "name": "batchSize", "in": "query", "description": "The optional maximum number of records to process in each validation batch.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelValidationResultModelCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegratedApplications": { "get": { "tags": [ "IntegratedApplications" ], "summary": "Get summary of integrated-applications.", "parameters": [ { "name": "IsNative", "in": "query", "description": "The filter to native (=true) or external (=false) applications. (optional)", "schema": { "type": "boolean" } }, { "name": "IsOnPremise", "in": "query", "description": "The filter to on-premise installation (=true) or cloud service (=false). (optional)", "schema": { "type": "boolean" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Released", "in": "query", "schema": { "type": "boolean" } }, { "name": "Unreleased", "in": "query", "schema": { "type": "boolean" } }, { "name": "Deleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Undeleted", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegratedApplicationSummaryCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegratedApplications/{codeOrId}": { "get": { "tags": [ "IntegratedApplications" ], "summary": "Get detail of integrated-application.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integrated-application identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationScenarioModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "delete": { "tags": [ "IntegratedApplications" ], "summary": "Delete integrated-application definition.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integrated-application identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegratedApplications/Import": { "post": { "tags": [ "IntegratedApplications" ], "summary": "Import integrated-application definition. Definition will be created or updated (when allowUpdate is turned on).\nWarning: Use with caution!", "parameters": [ { "name": "allowUpdate", "in": "query", "description": "The flag if existing definition will be updated or not", "schema": { "type": "boolean", "default": false } }, { "name": "release", "in": "query", "description": "The flag to release imported definition (optional)", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The integrated-application definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegratedApplicationDefinition" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegratedApplications/{codeOrId}/Export": { "get": { "tags": [ "IntegratedApplications" ], "summary": "Export integrated-application definition.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integrated-application identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegratedApplicationDefinition" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegratedApplications/{codeOrId}/Release": { "put": { "tags": [ "IntegratedApplications" ], "summary": "Release integrated-application definition.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integrated-application identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegratedApplications/Import/{globalApplicationCode}": { "post": { "tags": [ "IntegratedApplications" ], "summary": "Import the application from PDM, creates if does not exist in metadata, updates if exists", "parameters": [ { "name": "globalApplicationCode", "in": "path", "description": "The part code of the package", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegratedApplicationModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Integration/SynchronizeAuthorizationMetadata": { "post": { "tags": [ "Integration" ], "summary": "Synchronize authorization metadata (i.e. rights, roles and authorizations) for all data-models and integration-features (Master).", "responses": { "200": { "description": "OK" } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Integration/RemoveAuthorizationMetadata": { "delete": { "tags": [ "Integration" ], "summary": "Remove authorization metadata (i.e. rights, roles and authorizations) for all data-models and integration-features (Master).", "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Integration/SynchronizeAuthorizationMetadataOfIntegratedApplication": { "post": { "tags": [ "Integration" ], "summary": "Synchronize authorization metadata of integrated application (i.e. app roles and app feature roles, Master).", "parameters": [ { "name": "codeOrId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationFeatures": { "get": { "tags": [ "IntegrationFeatures" ], "summary": "Get summary of integration-features.", "parameters": [ { "name": "queryFilter", "in": "query", "description": "The query filter", "schema": { "$ref": "#/components/schemas/IntegrationFeatureFilter" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Released", "in": "query", "schema": { "type": "boolean" } }, { "name": "Unreleased", "in": "query", "schema": { "type": "boolean" } }, { "name": "Deleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Undeleted", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationFeatureSummaryCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationFeatures/{codeOrId}": { "get": { "tags": [ "IntegrationFeatures" ], "summary": "Get detail of integration-feature.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-feature identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationFeatureModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "delete": { "tags": [ "IntegrationFeatures" ], "summary": "Delete integration-feature definition.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-feature identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationFeatures/{codeOrId}/Applications": { "get": { "tags": [ "IntegrationFeatures" ], "summary": "Get list of applications supporting usage of integration-feature.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-feature identifier", "required": true, "schema": { "type": "string" } }, { "name": "usage", "in": "query", "description": "The application usage filter (optional)", "schema": { "$ref": "#/components/schemas/IntegrationFeatureAppUsage" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationFeatures/{codeOrId}/Flattened": { "get": { "tags": [ "IntegrationFeatures" ], "summary": "Get the flattened detail of integration-feature.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-feature identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationFeatures/{codeOrId}/DataModels": { "get": { "tags": [ "IntegrationFeatures" ], "summary": "Get the flattened list of available data-models for feature.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-feature identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationFeatures/Import": { "post": { "tags": [ "IntegrationFeatures" ], "summary": "Import integration-feature definition. Definition will be created or updated (when allowUpdate is turned on).\nWarning: Use with caution!", "parameters": [ { "name": "allowUpdate", "in": "query", "description": "The flag if existing definition will be updated or not", "schema": { "type": "boolean", "default": false } }, { "name": "release", "in": "query", "description": "The flag to release imported definition (optional)", "schema": { "type": "boolean", "default": false } }, { "name": "targetVersion", "in": "query", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "The integration-feature definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationFeatureDefinition" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationFeatures/{codeOrId}/Export": { "get": { "tags": [ "IntegrationFeatures" ], "summary": "Export integration-feature definition.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-feature identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationScenarioDefinition" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationFeatures/{codeOrId}/Release": { "put": { "tags": [ "IntegrationFeatures" ], "summary": "Release integration-feature definition.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-feature identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationFeatures/{codeOrId}/Verify/DataObject": { "post": { "tags": [ "IntegrationFeatures" ], "summary": "Verifies a data object against the provided code or ID.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The feature identifier, which can be either a code or ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Data object to validate against the rules.", "content": { "application/json": { "schema": { "description": "Represents a data object record model used to store key-value pairs representing the fields of a data object, along with its unique identifier." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifiedDataObjectModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationFeatures/{codeOrId}/ValidationRules/Verify/Integrity": { "get": { "tags": [ "IntegrationFeatures" ], "summary": "Verify the integrity of validation rules for a specified integration feature.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The code or identifier of the integration feature.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationFeatureRulesValidationResultModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationFeatures/ValidationRules/Verify/Integrity": { "post": { "tags": [ "IntegrationFeatures" ], "summary": "Verify the integrity of validation rules for a specific integration feature.", "requestBody": { "description": "The definition of the integration feature whose validation rules need to be checked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationFeatureDefinition" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationFeatureRulesValidationResultModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationMaps/{mapId}/AvailableFeatures": { "get": { "tags": [ "IntegrationMaps" ], "summary": "Get the flattened list of available features for application.", "parameters": [ { "name": "mapId", "in": "path", "description": "The identifier of integration-map", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "description": "The data-source identifier (mandatory)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMapAppFeatureUsageCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationMaps/{mapId}/AvailableModels": { "get": { "tags": [ "IntegrationMaps" ], "summary": "Get the flattened list of available data-models for application.", "parameters": [ { "name": "mapId", "in": "path", "description": "The identifier of integration-map", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "description": "The data-source identifier (mandatory)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMapAppModelUsageCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationMaps/Current": { "get": { "tags": [ "IntegrationMaps" ], "summary": "Get the current integration-map.", "parameters": [ { "name": "sourceId", "in": "query", "description": "The data-source identifier filter (optional)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMapModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationMaps/Current/AvailableFeatures": { "get": { "tags": [ "IntegrationMaps" ], "summary": "Get the flattened list of available features for application.", "parameters": [ { "name": "sourceId", "in": "query", "description": "The data-source identifier (mandatory)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMapAppFeatureUsageCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationMaps/Current/AvailableModels": { "get": { "tags": [ "IntegrationMaps" ], "summary": "Get the flattened list of available data-models for application.", "parameters": [ { "name": "sourceId", "in": "query", "description": "The data-source identifier (mandatory)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMapAppModelUsageCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationRequests": { "get": { "tags": [ "IntegrationRequests" ], "summary": "Get a filtered collection of integration-scenario requests.", "parameters": [ { "name": "Statuses", "in": "query", "description": "The status filter (optional).", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationRequestStatus" } } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationRequestSummaryCollectionResult" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "post": { "tags": [ "IntegrationRequests" ], "summary": "Create integration-scenario request.", "requestBody": { "description": "The integration-scenario request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationRequestCreate" } } } }, "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationRequests/{id}": { "get": { "tags": [ "IntegrationRequests" ], "summary": "Get an integration-scenario request.", "parameters": [ { "name": "id", "in": "path", "description": "The identifier of integration-scenario request", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationRequestModel" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationRequests/RefreshProfile": { "post": { "tags": [ "IntegrationRequests" ], "summary": "Create request to refresh integration-profile for tenant.", "requestBody": { "description": "The settings of refresh integration-profile request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshProfileRequestSettings" } } } }, "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationRequests/ActivateApplication": { "post": { "tags": [ "IntegrationRequests" ], "summary": "Create request to activate integrated-application for tenant using \"I'm Feeling Lucky\" built-in strategy.", "requestBody": { "description": "The application request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationRequestApplication" } } } }, "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationRequests/DeactivateApplication": { "post": { "tags": [ "IntegrationRequests" ], "summary": "Create request to deactivate integrated-application for tenant (i.e. deactivate application from dependencies).", "requestBody": { "description": "The application request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationRequestApplication" } } } }, "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationRequests/{id}/Cancel": { "put": { "tags": [ "IntegrationRequests" ], "summary": "Cancel integration-scenario request.", "parameters": [ { "name": "id", "in": "path", "description": "The identifier of integration-scenario request", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationScenarios": { "get": { "tags": [ "IntegrationScenarios" ], "summary": "Get summary of integration-scenarios.", "parameters": [ { "name": "queryFilter", "in": "query", "description": "The query filter", "schema": { "$ref": "#/components/schemas/IntegrationScenarioFilter" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Released", "in": "query", "schema": { "type": "boolean" } }, { "name": "Unreleased", "in": "query", "schema": { "type": "boolean" } }, { "name": "Deleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Undeleted", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationScenarioSummaryCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationScenarios/{codeOrId}": { "get": { "tags": [ "IntegrationScenarios" ], "summary": "Get detail of integration-scenario.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-scenario identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationScenarioModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "delete": { "tags": [ "IntegrationScenarios" ], "summary": "Delete integration-scenario definition.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-scenario identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationScenarios/{codeOrId}/Applications": { "get": { "tags": [ "IntegrationScenarios" ], "summary": "Get list of applications supporting usage of integration-scenario.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-scenario identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationScenarios/{codeOrId}/PreviousScenarios": { "get": { "tags": [ "IntegrationScenarios" ], "summary": "Get list of integration-scenarios preceding the given integration-scenario.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-scenario identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationScenarioSummaryCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationScenarios/{codeOrId}/NextScenarios": { "get": { "tags": [ "IntegrationScenarios" ], "summary": "Get list of integration-scenarios following the given integration-scenario.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-scenario identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationScenarioSummaryCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationScenarios/Import": { "post": { "tags": [ "IntegrationScenarios" ], "summary": "Import integration-scenario definition. Definition will be created or updated (when allowUpdate is turned on).\nIf Target version is filled, only the history change under specific version will be updated. There will not be changes to current integration scenario.\nWarning: Use with caution!", "parameters": [ { "name": "allowUpdate", "in": "query", "description": "The flag if existing definition will be updated or not", "schema": { "type": "boolean", "default": false } }, { "name": "release", "in": "query", "description": "The flag to release imported definition (optional)", "schema": { "type": "boolean", "default": false } }, { "name": "targetVersion", "in": "query", "description": "Code of version in yyyyMMdd-00. Year, month, day and two digits number format.", "schema": { "type": "string" } } ], "requestBody": { "description": "The integration-scenario definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationScenarioDefinition" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationScenarios/{codeOrId}/Export": { "get": { "tags": [ "IntegrationScenarios" ], "summary": "Export integration-scenario definition.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-scenario identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationScenarioDefinition" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/IntegrationScenarios/{codeOrId}/Release": { "put": { "tags": [ "IntegrationScenarios" ], "summary": "Release integration-scenario definition.", "parameters": [ { "name": "codeOrId", "in": "path", "description": "The integration-scenario identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Maintenance/CleanupOperatingLogHistory": { "post": { "tags": [ "Maintenance" ], "summary": "Cleanup operating-log history.", "parameters": [ { "name": "sourceId", "in": "query", "description": "The data-source identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "keepDays", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Maintenance/ClearInputQueueHistory/{sourceId}": { "post": { "tags": [ "Maintenance" ], "summary": "Cleanup input queue history.", "parameters": [ { "name": "sourceId", "in": "path", "description": "The data-source identifier (mandatory)", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "keepDays", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Maintenance/CleanupDeletedFromQueryStore": { "post": { "tags": [ "Maintenance" ], "summary": "Cleanup deleted data-objects from query store.", "parameters": [ { "name": "modelId", "in": "query", "description": "The data-model identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "keepDays", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Maintenance/DataModel/{dataModelId}/ValidateAndCorrectDataObjectRecords": { "post": { "tags": [ "Maintenance" ], "summary": "Validates and corrects data object records for a given data model.", "parameters": [ { "name": "dataModelId", "in": "path", "description": "The unique identifier of the data model.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "An optional identifier for the data source.", "schema": { "type": "string" } }, { "name": "batchSize", "in": "query", "description": "The size of the batch for processing records (optional).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelValidationResultModelCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Maintenance/MergeDataObjectsCollections": { "post": { "tags": [ "Maintenance" ], "summary": "Merges data objects collections based on the provided request model.", "requestBody": { "description": "The request model containing details for merging data objects collections.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeDataObjectsCollectionRequestModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeDataObjectsCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Maintenance/MergeDataObjectsCollections/{processId}": { "get": { "tags": [ "Maintenance" ], "summary": "Retrieves the result of a merge data objects collections process by its identifier.", "parameters": [ { "name": "processId", "in": "path", "description": "The unique identifier of the merge data objects collections process.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeDataObjectsCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/MigratingData/MigrateStringToLocalizedStringFields/{modelId}": { "post": { "tags": [ "MigratingData" ], "summary": "Migrate string values to localized string values in data-model using model id.", "parameters": [ { "name": "modelId", "in": "path", "description": "The model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "The data-source identifier", "schema": { "type": "string" } }, { "name": "preferredLocale", "in": "query", "description": "The preferred locale (e.g. 'en-US') or null", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/MigratingData/MigrateStringToLocalizedStringFields/{modelCode}": { "post": { "tags": [ "MigratingData" ], "summary": "Migrate string values to localized string values in data-model using model code.", "parameters": [ { "name": "modelCode", "in": "path", "description": "The model code", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "description": "The data-source identifier", "schema": { "type": "string" } }, { "name": "preferredLocale", "in": "query", "description": "The preferred locale (e.g. 'en-US') or null", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/MigratingData/MigrateLocalizedStringFieldsToStringFields/{modelId}": { "post": { "tags": [ "MigratingData" ], "summary": "Migrate localized string values to string values in data-model using model id.", "parameters": [ { "name": "modelId", "in": "path", "description": "The model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "The data-source identifier", "schema": { "type": "string" } }, { "name": "preferredLocale", "in": "query", "description": "The preferred locale (e.g. 'en-US') or null", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/MigratingData/MigrateLocalizedStringToStringFields/{modelCode}": { "post": { "tags": [ "MigratingData" ], "summary": "Migrate localized string values to string values in data-model using model code.", "parameters": [ { "name": "modelCode", "in": "path", "description": "The model code", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "description": "The data-source identifier", "schema": { "type": "string" } }, { "name": "preferredLocale", "in": "query", "description": "The preferred locale (e.g. 'en-US') or null", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/MigratingData/RemoveFields/{modelIdOrCode}": { "post": { "tags": [ "MigratingData" ], "summary": "Remove fields in data-model using model code.", "parameters": [ { "name": "modelIdOrCode", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelMigrationRequest" } } } }, "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/OperatingLogs": { "get": { "tags": [ "OperatingLogs" ], "summary": "Get a filtered collection of operating logs.", "parameters": [ { "name": "OperationId", "in": "query", "description": "The operation identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "IncludeSystemLevel", "in": "query", "description": "Flag to include system-level items. (default: false)", "schema": { "type": "boolean" } }, { "name": "SeverityLevel", "in": "query", "description": "The minimal severity level (info, warning, error).", "schema": { "$ref": "#/components/schemas/StatusSeverity" } }, { "name": "AgentCode", "in": "query", "description": "The data-agent code of log-item owner (optional).", "schema": { "type": "string" } }, { "name": "AgentId", "in": "query", "description": "The data-agent identifier of log-item owner (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "SourceId", "in": "query", "description": "The data-source identifier of log-item owner (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "OperationScope", "in": "query", "description": "The operation scope (optional).", "schema": { "$ref": "#/components/schemas/OperationScope" } }, { "name": "CreatedFrom", "in": "query", "description": "The CreatedOn greater than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "CreatedTo", "in": "query", "description": "The CreatedOn less than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperatingLogModelCollectionResult" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "OperatingLogs" ], "summary": "Get a filtered collection of operating logs.", "parameters": [ { "name": "OperationId", "in": "query", "description": "The operation identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "IncludeSystemLevel", "in": "query", "description": "Flag to include system-level items. (default: false)", "schema": { "type": "boolean" } }, { "name": "SeverityLevel", "in": "query", "description": "The minimal severity level (info, warning, error).", "schema": { "$ref": "#/components/schemas/StatusSeverity" } }, { "name": "AgentCode", "in": "query", "description": "The data-agent code of log-item owner (optional).", "schema": { "type": "string" } }, { "name": "AgentId", "in": "query", "description": "The data-agent identifier of log-item owner (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "SourceId", "in": "query", "description": "The data-source identifier of log-item owner (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "OperationScope", "in": "query", "description": "The operation scope (optional).", "schema": { "$ref": "#/components/schemas/OperationScope" } }, { "name": "CreatedFrom", "in": "query", "description": "The CreatedOn greater than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "CreatedTo", "in": "query", "description": "The CreatedOn less than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperatingLogModelCollectionResult" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "post": { "tags": [ "OperatingLogs" ], "summary": "Create a new operating log.", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperatingLogModelCreate" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperatingLogModel" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/OperatingLogs/{id}": { "get": { "tags": [ "OperatingLogs" ], "summary": "Get an operating log.", "parameters": [ { "name": "id", "in": "path", "description": "The operating log identifier", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperatingLogModel" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "OperatingLogs" ], "summary": "Get an operating log.", "parameters": [ { "name": "id", "in": "path", "description": "The operating log identifier", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperatingLogModel" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ReloadTenantCache": { "post": { "tags": [ "Process" ], "summary": "Reload tenant cache of background service.\nWarning: Use with caution!", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ResetManager": { "post": { "tags": [ "Process" ], "summary": "Reset processing manager in background service for current tenant.\nWarning: Use with caution!", "responses": { "200": { "description": "OK" } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/Refresh/{sourceId}": { "post": { "tags": [ "Process" ], "summary": "Process incoming data from specific source and update affected data models.", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/GetCurrentStatus": { "get": { "tags": [ "Process" ], "summary": "Get a current status of data service.", "parameters": [ { "name": "sourceId", "in": "query", "description": "The source identifier (optional)", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentStatus" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/RemoveQueryStoreStatusLock/{lockId}": { "post": { "tags": [ "Process" ], "summary": "Remove query-store status lock.\nWarning: Use with caution!", "parameters": [ { "name": "lockId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ClearQueryStoreStatus/{sourceId}": { "post": { "tags": [ "Process" ], "summary": "Clear query-store status table. Use Refresh method to process the complete incoming data from specific source again.\nWarning: Use with caution!", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/TriggerRefreshDataEvent/{sourceId}": { "post": { "tags": [ "Process" ], "summary": "Triggers a ASOL.DataService.Edge.Contracts.Events.RefreshDataEvent for specific data-source.", "parameters": [ { "name": "sourceId", "in": "path", "description": "The data-source identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mandantCode", "in": "query", "description": "The mandant identifier (optional)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/TriggerOnDemandDataEvent/{sourceId}": { "post": { "tags": [ "Process" ], "summary": "Triggers a ASOL.DataService.Edge.Contracts.Events.OnDemandDataEvent for specific data-source.", "parameters": [ { "name": "sourceId", "in": "path", "description": "The data-source identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mandantCode", "in": "query", "description": "The mandant identifier (optional)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/TriggerRefreshConfigEvent/{sourceId}": { "post": { "tags": [ "Process" ], "summary": "Triggers a ASOL.DataService.Edge.Contracts.Events.RefreshConfigEvent for specific data-source.", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/TriggerRefreshAgentConfigEvent/{agentCode}": { "post": { "tags": [ "Process" ], "summary": "Triggers a ASOL.DataService.Edge.Contracts.Events.RefreshAgentConfigEvent for specific data-agent.", "parameters": [ { "name": "agentCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/TriggerRefreshStatusEvent/{sourceId}": { "post": { "tags": [ "Process" ], "summary": "Triggers a ASOL.DataService.Edge.Contracts.Events.RefreshStatusEvent for specific data-source.", "parameters": [ { "name": "sourceId", "in": "path", "description": "The data-source identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mandantCode", "in": "query", "description": "The mandant identifier (optional)", "schema": { "type": "string" } }, { "name": "checkConnection", "in": "query", "description": "The flag if data-source connection will be checked", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/TriggerRefreshAgentStatusEvent/{agentCode}": { "post": { "tags": [ "Process" ], "summary": "Triggers a ASOL.DataService.Edge.Contracts.Events.RefreshAgentStatusEvent for specific data-agent.", "parameters": [ { "name": "agentCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "checkConnection", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/SetVaultDataAndTriggerRefreshConfigEvent/{sourceId}": { "post": { "tags": [ "Process" ], "summary": "Sets vault-data and triggers a ASOL.DataService.Edge.Contracts.Events.RefreshConfigEvent for specific data-source.\nWarning: Use with caution!", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ClearDataFromInputQueue/{sourceId}": { "post": { "tags": [ "Process" ], "summary": "Clear incoming data from input queue.\nWarning: Use with caution!", "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ImportDataModel": { "post": { "tags": [ "Process" ], "summary": "Import data-model definition. Definition will be created or updated (when allowUpdate is turned on).\nIf Target version is filled, only the history change under specific version will be updated. There will not be changes to current data-model.\nWarning: Use with caution!", "parameters": [ { "name": "allowUpdate", "in": "query", "description": "The flag if existing definition will be updated or not", "schema": { "type": "boolean", "default": false } }, { "name": "targetVersion", "in": "query", "description": "Code of version in yyyyMMdd-00. Year, month, day and two digits number format.", "schema": { "type": "string" } } ], "requestBody": { "description": "The data-model definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelDefinitionImport" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ImportDataModelV2": { "post": { "tags": [ "Process" ], "summary": "Import data-model definition. Definition will be created or updated (when allowUpdate is turned on).\nIf Target version is filled, only the history change under specific version will be updated. There will not be changes to current data-model.\nWarning: Use with caution!", "parameters": [ { "name": "allowUpdate", "in": "query", "description": "The flag if existing definition will be updated or not", "schema": { "type": "boolean", "default": false } }, { "name": "targetVersion", "in": "query", "description": "Code of version in yyyyMMdd-00. Year, month, day and two digits number format.", "schema": { "type": "string" } } ], "requestBody": { "description": "The data-model definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelDefinitionImportV2" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ImportUnifiedData/{modelIdOrCode}": { "post": { "tags": [ "Process" ], "summary": "Import unified-data definitions. Definitions will be created or updated (when allowUpdate is turned on).\nIf Target version is filled, only the history change under specific version will be updated. There will not be changes to current unified-data.\nWarning: Use with caution!", "parameters": [ { "name": "modelIdOrCode", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string" } }, { "name": "allowUpdate", "in": "query", "description": "The flag if existing unified-data will be updated or not", "schema": { "type": "boolean", "default": false } }, { "name": "allowChangeExternalId", "in": "query", "description": "The flag if it is allowed to change externalId for existing unified-data or not", "schema": { "type": "boolean", "default": false } }, { "name": "targetVersion", "in": "query", "description": "Code of version in yyyyMMdd-00. Year, month, day and two digits number format.", "schema": { "type": "string" } } ], "requestBody": { "description": "The seeded unified-data collection.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeedDataObject" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/GetUnifiedData/{modelIdOrCode}": { "get": { "tags": [ "Process" ], "summary": "Get unified-data definitions.", "parameters": [ { "name": "modelIdOrCode", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeDeleted", "in": "query", "description": "Flag to include deleted definitions. (default: false)", "schema": { "type": "boolean" } }, { "name": "ExternalId", "in": "query", "description": "The external id (optional).", "schema": { "type": "string" } }, { "name": "options", "in": "query", "description": "The format options", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JObjectCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/SeedUnifiedData/{modelIdOrCode}": { "post": { "tags": [ "Process" ], "summary": "Seed unified-data into tenant data-objects. Records will be created, updated or deleted (if allowed otherwise skipped).\nWarning: Use with caution!", "parameters": [ { "name": "modelIdOrCode", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string" } }, { "name": "allowUpdate", "in": "query", "description": "The flag if existing data will be updated or skipped", "schema": { "type": "boolean", "default": false } }, { "name": "allowDelete", "in": "query", "description": "The flag if existing data will be marked as deleted or skipped", "schema": { "type": "boolean", "default": false } }, { "name": "allowChangeExternalId", "in": "query", "description": "The flag if it is allowed to change externalId for existing data or not (conflicting data will be skipped)", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/CleanupUnifiedData/{modelIdOrCode}": { "delete": { "tags": [ "Process" ], "summary": "Cleanup unified-data from tenant data-objects when master definition exists.\nWarning: Use with caution!", "parameters": [ { "name": "modelIdOrCode", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string" } }, { "name": "hardDelete", "in": "query", "description": "The flag if existing data will be hard deleted or marked as deleted", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ImportDataAgent": { "post": { "tags": [ "Process" ], "summary": "Import data-agent definition. Definition will be created or updated.\nWarning: Use with caution!", "parameters": [ { "name": "allowUpdate", "in": "query", "description": "The flag if existing definition will be updated or skipped", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The data-agent definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentDefinitionImport" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ImportDataSource": { "post": { "tags": [ "Process" ], "summary": "Import data-source definition. Definition will be created or updated.\nWarning: Use with caution!", "parameters": [ { "name": "allowUpdate", "in": "query", "description": "The flag if existing definition will be updated or skipped", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The data-source definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceDefinitionImport" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ImportDataTransformation": { "post": { "tags": [ "Process" ], "summary": "Import data-transformation definition. Definition will be created or updated.\nWarning: Use with caution!", "parameters": [ { "name": "allowUpdate", "in": "query", "description": "The flag if existing definition will be updated or skipped", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The data-transformation definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataTransformationDefinitionImport" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/SeedData": { "post": { "tags": [ "Process" ], "summary": "Seed raw data-objects into data-models. Records will be created if don't exist.\nWarning: Use with caution!", "parameters": [ { "name": "allowUpdate", "in": "query", "description": "The flag if existing definition will be updated or not", "schema": { "type": "boolean", "default": false } }, { "name": "allowChangeExternalId", "in": "query", "description": "The flag if it is allowed to change externalId for existing records or not", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The seeded data-object collection.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeedDataObject" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/SeedDataToMandant": { "post": { "tags": [ "Process" ], "summary": "Seed raw data-objects into data-models and assign to specified mandant. Records will be created if don't exist.\nWarning: Use with caution!", "parameters": [ { "name": "mandantCode", "in": "query", "description": "The target mandant code (or null to set as non-mandant)", "schema": { "type": "string" } }, { "name": "allowUpdate", "in": "query", "description": "The flag if existing definition will be updated or not", "schema": { "type": "boolean", "default": false } }, { "name": "allowChangeExternalId", "in": "query", "description": "The flag if it is allowed to change externalId for existing records or not", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The seeded data-object collection.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SeedDataObject" } } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/PurgeData/{modelIdOrCode}": { "post": { "tags": [ "Process" ], "summary": "Purge data in data-model. Identifiers will be preserved as orphan records with deleted status.\nWarning: Use with caution!", "parameters": [ { "name": "modelIdOrCode", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "description": "The source identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "query", "description": "The record identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "purgeFields", "in": "query", "description": "The flag if fields will be purged or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/PurgeDataByModelId/{modelId}": { "post": { "tags": [ "Process" ], "summary": "Purge data in data-model using model id. Identifiers will be preserved as orphan records with deleted status.\nWarning: Use with caution!", "parameters": [ { "name": "modelId", "in": "path", "description": "The model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "The source identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "query", "description": "The record identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "purgeFields", "in": "query", "description": "The flag if fields will be purged or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/PurgeDataByModelName/{modelName}": { "post": { "tags": [ "Process" ], "summary": "Purge data in data-model using model name. Identifiers will be preserved as orphan records with deleted status.\nWarning: Use with caution!", "parameters": [ { "name": "modelName", "in": "path", "description": "The model name", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "description": "The source identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "query", "description": "The record identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "purgeFields", "in": "query", "description": "The flag if fields will be purged or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/RaiseDataRecordUpdatedEvent/{modelIdOrCode}": { "post": { "tags": [ "Process" ], "summary": "Raise ASOL.DataService.Events.DataRecordUpdatedEvent for existing data in data-model.\nWarning: Use with caution!", "parameters": [ { "name": "modelIdOrCode", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "description": "The source identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "query", "description": "The record identifier (optional)", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/RaiseDataRecordUpdatedEventByModelId/{modelId}": { "post": { "tags": [ "Process" ], "summary": "Raise ASOL.DataService.Events.DataRecordUpdatedEvent for existing data in data-model using model id.\nWarning: Use with caution!", "parameters": [ { "name": "modelId", "in": "path", "description": "The model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "The source identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "query", "description": "The record identifier (optional)", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/RaiseDataRecordUpdatedEventByModelName/{modelName}": { "post": { "tags": [ "Process" ], "summary": "Raise ASOL.DataService.Events.DataRecordUpdatedEvent for existing data in data-model using model name.\nWarning: Use with caution!", "parameters": [ { "name": "modelName", "in": "path", "description": "The model name", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "description": "The source identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "query", "description": "The record identifier (optional)", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/RaiseDataRecordDeletedAndCreatedEvent/{modelIdOrCode}": { "post": { "tags": [ "Process" ], "summary": "Raise ASOL.DataService.Events.DataRecordDeletedEvent+ASOL.DataService.Events.DataRecordCreatedEvent for existing data in data-model.\nWarning: Use with caution!", "parameters": [ { "name": "modelIdOrCode", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "description": "The source identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "query", "description": "The record identifier (optional)", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/RaiseDataRecordDeletedAndCreatedEventByModelId/{modelId}": { "post": { "tags": [ "Process" ], "summary": "Raise ASOL.DataService.Events.DataRecordDeletedEvent+ASOL.DataService.Events.DataRecordCreatedEvent for existing data in data-model using model id.\nWarning: Use with caution!", "parameters": [ { "name": "modelId", "in": "path", "description": "The model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "The source identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "query", "description": "The record identifier (optional)", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/RaiseDataRecordDeletedAndCreatedEventByModelName/{modelName}": { "post": { "tags": [ "Process" ], "summary": "Raise ASOL.DataService.Events.DataRecordDeletedEvent+ASOL.DataService.Events.DataRecordCreatedEvent for existing data in data-model using model name.\nWarning: Use with caution!", "parameters": [ { "name": "modelName", "in": "path", "description": "The model name", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "description": "The source identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "query", "description": "The record identifier (optional)", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/RaiseIntegrationProfileChangeStartedAndCompletedEvent/{sourceId}": { "post": { "tags": [ "Process" ], "summary": "Raise ASOL.DataService.Edge.Contracts.Events.IntegrationProfileChangeStarted and ASOL.DataService.Edge.Contracts.Events.IntegrationProfileChangeCompleted events for current profile and specified data-source.\nWarning: Use with caution!", "parameters": [ { "name": "sourceId", "in": "path", "description": "The data-source identifier.", "required": true, "schema": { "type": "string" } }, { "name": "delay", "in": "query", "description": "The delay between events in seconds. (default: 30)", "schema": { "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/RaiseIntegrationDataChangedEvent/{resultId}": { "post": { "tags": [ "Process" ], "summary": "Raise ASOL.DataService.Events.IntegrationDataChanged event for existing result in processed-data results.\nWarning: Use with caution!", "parameters": [ { "name": "resultId", "in": "path", "description": "The processed-data result identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/MarkdownDocument/{modelIdOrCode}": { "get": { "tags": [ "Process" ], "summary": "Get markdown document for data-model.", "parameters": [ { "name": "modelIdOrCode", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string" } }, { "name": "months", "in": "query", "description": "Number of months until the history will be processed backwards (optional - default value is 0 e.g. current month)", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/MarkdownDocumentByModelId/{modelId}": { "get": { "tags": [ "Process" ], "summary": "Get markdown document for data-model using model id.", "parameters": [ { "name": "modelId", "in": "path", "description": "The model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "months", "in": "query", "description": "Number of months until the history will be processed backwards (optional - default value is 0 e.g. current month)", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/MarkdownDocumentByModelName/{modelName}": { "get": { "tags": [ "Process" ], "summary": "Get markdown document for data-model using model name.", "parameters": [ { "name": "modelName", "in": "path", "description": "The model name", "required": true, "schema": { "type": "string" } }, { "name": "months", "in": "query", "description": "Number of months until the history will be processed backwards (optional - default value is 0 e.g. current month)", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/MetadataDifferencesMarkdownDocument": { "get": { "tags": [ "Process" ], "summary": "Get markdown document for differences in metadata", "parameters": [ { "name": "fromVersion", "in": "query", "description": "The version when the metadata and changes becomes valid (Optional)", "schema": { "type": "string" } }, { "name": "toVersion", "in": "query", "description": "The version until the metadata and changes becomes valid (Optional)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/MonthlyMetadataDifferencesDocument": { "get": { "tags": [ "Process" ], "summary": "Get markdown document for differences in metadata", "parameters": [ { "name": "months", "in": "query", "description": "Number of months ago until which the changes will be computed (optional - default value is 0 e.g. current month)", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ClassDiagram/{modelIdOrCode}": { "get": { "tags": [ "Process" ], "summary": "Get class diagram for data-model.", "parameters": [ { "name": "modelIdOrCode", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string" } }, { "name": "preferInline", "in": "query", "description": "", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ClassDiagram/{modelIdOrCode}/ViewLink": { "get": { "tags": [ "Process" ], "summary": "Get class diagram for data-model.", "parameters": [ { "name": "modelIdOrCode", "in": "path", "description": "The data-model identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ClassDiagramByModelId/{modelId}": { "get": { "tags": [ "Process" ], "summary": "Get class diagram for data-model using model id.", "parameters": [ { "name": "modelId", "in": "path", "description": "The model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "preferInline", "in": "query", "description": "", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ClassDiagramByModelId/{modelId}/ViewLink": { "get": { "tags": [ "Process" ], "summary": "Get class diagram for data-model using model id.", "parameters": [ { "name": "modelId", "in": "path", "description": "The model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ClassDiagramByModelName/{modelName}": { "get": { "tags": [ "Process" ], "summary": "Get class diagram for data-model using model name.", "parameters": [ { "name": "modelName", "in": "path", "description": "The model name", "required": true, "schema": { "type": "string" } }, { "name": "preferInline", "in": "query", "description": "", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ClassDiagramByModelName/{modelName}/ViewLink": { "get": { "tags": [ "Process" ], "summary": "Get class diagram for data-model using model name.", "parameters": [ { "name": "modelName", "in": "path", "description": "The model name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/IntegrationMapFlowChart/ViewLink": { "get": { "tags": [ "Process" ], "summary": "Get the complete integration-map flow chart.", "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/IntegrationProfileFlowChart/ViewLink": { "get": { "tags": [ "Process" ], "summary": "Get integration-profile flow chart for current or specific integration-profile.", "parameters": [ { "name": "profileId", "in": "query", "description": "The integration-profile identifier (optional) otherwise the current profile is used", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/PublisherConsumerFlowDiagram": { "get": { "tags": [ "Process" ], "summary": "Get publisher-consumer flow diagram using model id and/or source id.", "parameters": [ { "name": "modelId", "in": "query", "description": "The selected model identifier (optional)", "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "The selected source identifier (optional)", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/CreateMetadataVersion": { "post": { "tags": [ "Process" ], "summary": "Create metadata version based on actual state", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataVersionModel" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/MetadataVersions": { "get": { "tags": [ "Process" ], "summary": "Get the metadata versions describing the DataModels, Integration scenarios etc...", "parameters": [ { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataVersionModelCollectionResult" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Process/ResetDataModelNameCache": { "post": { "tags": [ "Process" ], "summary": "Reset cache of data-model codes.", "responses": { "200": { "description": "OK" } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/QueryingData/ProcessedDataResults": { "get": { "tags": [ "QueryingData" ], "summary": "Get a collection of data-processing results.", "parameters": [ { "name": "ScenarioId", "in": "query", "description": "The integration-scenario identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "FeatureId", "in": "query", "description": "The integration-feature identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "ProfileId", "in": "query", "description": "The integration-profile identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "PublisherSourceId", "in": "query", "description": "The publisher data-source identifier (optional).", "schema": { "type": "string" } }, { "name": "SelfSourceOnly", "in": "query", "description": "The flag to apply self-source filter, the bypass used for testing purposes (optional).\nNote: used for integration profiles", "schema": { "type": "boolean" } }, { "name": "OperationId", "in": "query", "description": "The operating-log identifier (optional).", "schema": { "type": "string" } }, { "name": "CreatedFrom", "in": "query", "description": "The CreatedOn greater than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "CreatedTo", "in": "query", "description": "The CreatedOn less than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Released", "in": "query", "schema": { "type": "boolean" } }, { "name": "Unreleased", "in": "query", "schema": { "type": "boolean" } }, { "name": "Deleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Undeleted", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProcessingResultModelCollectionResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/QueryingData/ProcessedDataResults/{resultId}/Items": { "get": { "tags": [ "QueryingData" ], "summary": "Get a collection of result items using data-processing result id.\nNote: The data-processing result id = the identifier of published queue-item.", "parameters": [ { "name": "resultId", "in": "path", "description": "The data-processing result identifier", "required": true, "schema": { "type": "string" } }, { "name": "UseCurrentProfile", "in": "query", "description": "The flag to specify if current integration-profile will be used for filtering instead of the original one.", "schema": { "type": "boolean" } }, { "name": "SelfSourceOnly", "in": "query", "description": "The flag to apply self-source filter, the bypass used for testing purposes (optional).\nNote: used for integration profiles", "schema": { "type": "boolean" } }, { "name": "PublisherSourceId", "in": "query", "description": "The publisher data-source identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Released", "in": "query", "schema": { "type": "boolean" } }, { "name": "Unreleased", "in": "query", "schema": { "type": "boolean" } }, { "name": "Deleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Undeleted", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProcessingResultItemModelCollectionResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/QueryingData/FindDataByModelId/{modelId}": { "get": { "tags": [ "QueryingData" ], "summary": "Get a filtered collection of data from data-model using model id.", "parameters": [ { "name": "modelId", "in": "path", "description": "The model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ScenarioId", "in": "query", "description": "The integration-scenario identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "FeatureId", "in": "query", "description": "The integration-feature identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "SelfSourceOnly", "in": "query", "description": "The flag to apply self-source filter, the bypass used for testing purposes (optional).\nNote: used for integration profiles", "schema": { "type": "boolean" } }, { "name": "PublisherSourceId", "in": "query", "description": "The publisher source identifier (optional).", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "description": "Flag to include deleted records. (default: false)", "schema": { "type": "boolean" } }, { "name": "MandantCode", "in": "query", "description": "The mandant code (optional).\nNote: if AllMandants flag is true, this is not allowed.", "schema": { "type": "string" } }, { "name": "AllMandants", "in": "query", "description": "Flag to include all mandants (default: false).\nNote: if true, MandantCode is not allowed.", "schema": { "type": "boolean" } }, { "name": "RecordId", "in": "query", "description": "The internal record identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "ExternalId", "in": "query", "description": "The external identifier (optional).", "schema": { "type": "string" } }, { "name": "ReferenceId", "in": "query", "description": "The reference identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "ModelId", "in": "query", "description": "The model identifier", "schema": { "type": "string" } }, { "name": "ModifiedFrom", "in": "query", "description": "The ModifiedOn greater than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "ModifiedTo", "in": "query", "description": "The ModifiedOn less than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "IncludeLookupProperties", "in": "query", "description": "The comma-separated list of navigation properties representing records included to query result.", "schema": { "type": "string" } }, { "name": "selfSourceId", "in": "query", "description": "OBSOLETE", "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "OBSOLETE PublisherSourceId", "schema": { "type": "string", "format": "uuid" } }, { "name": "options", "in": "query", "description": "The format options", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JObjectCollectionResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/QueryingData/FindDataByModelId/{modelId}/ReferencedBy/{fkName}/{fkId}": { "get": { "tags": [ "QueryingData" ], "summary": "Get a filtered collection of data referenced by foreign key from data-model using model id.", "parameters": [ { "name": "modelId", "in": "path", "description": "The model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fkName", "in": "path", "description": "The name of lookup property (i.e. FK name)", "required": true, "schema": { "type": "string" } }, { "name": "fkId", "in": "path", "description": "The value in lookup property (i.e. FK value)", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ScenarioId", "in": "query", "description": "The integration-scenario identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "FeatureId", "in": "query", "description": "The integration-feature identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "SelfSourceOnly", "in": "query", "description": "The flag to apply self-source filter, the bypass used for testing purposes (optional).\nNote: used for integration profiles", "schema": { "type": "boolean" } }, { "name": "PublisherSourceId", "in": "query", "description": "The publisher source identifier (optional).", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "description": "Flag to include deleted records. (default: false)", "schema": { "type": "boolean" } }, { "name": "MandantCode", "in": "query", "description": "The mandant code (optional).\nNote: if AllMandants flag is true, this is not allowed.", "schema": { "type": "string" } }, { "name": "AllMandants", "in": "query", "description": "Flag to include all mandants (default: false).\nNote: if true, MandantCode is not allowed.", "schema": { "type": "boolean" } }, { "name": "RecordId", "in": "query", "description": "The internal record identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "ExternalId", "in": "query", "description": "The external identifier (optional).", "schema": { "type": "string" } }, { "name": "ReferenceId", "in": "query", "description": "The reference identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "ModelId", "in": "query", "description": "The model identifier", "schema": { "type": "string" } }, { "name": "ModifiedFrom", "in": "query", "description": "The ModifiedOn greater than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "ModifiedTo", "in": "query", "description": "The ModifiedOn less than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "IncludeLookupProperties", "in": "query", "description": "The comma-separated list of navigation properties representing records included to query result.", "schema": { "type": "string" } }, { "name": "selfSourceId", "in": "query", "description": "OBSOLETE", "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "OBSOLETE PublisherSourceId", "schema": { "type": "string", "format": "uuid" } }, { "name": "options", "in": "query", "description": "The format options", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JObjectCollectionResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/QueryingData/FindDataByModelId/{modelId}/FilteredBy/{akName}/{akValue}": { "get": { "tags": [ "QueryingData" ], "summary": "Get a filtered collection of data filtered by alternate key from data-model using model id.", "parameters": [ { "name": "modelId", "in": "path", "description": "The model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "akName", "in": "path", "description": "The name of scalar property (i.e. AK name)", "required": true, "schema": { "type": "string" } }, { "name": "akValue", "in": "path", "description": "The value in scalar property (i.e. AK value)", "required": true, "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ScenarioId", "in": "query", "description": "The integration-scenario identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "FeatureId", "in": "query", "description": "The integration-feature identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "SelfSourceOnly", "in": "query", "description": "The flag to apply self-source filter, the bypass used for testing purposes (optional).\nNote: used for integration profiles", "schema": { "type": "boolean" } }, { "name": "PublisherSourceId", "in": "query", "description": "The publisher source identifier (optional).", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "description": "Flag to include deleted records. (default: false)", "schema": { "type": "boolean" } }, { "name": "MandantCode", "in": "query", "description": "The mandant code (optional).\nNote: if AllMandants flag is true, this is not allowed.", "schema": { "type": "string" } }, { "name": "AllMandants", "in": "query", "description": "Flag to include all mandants (default: false).\nNote: if true, MandantCode is not allowed.", "schema": { "type": "boolean" } }, { "name": "RecordId", "in": "query", "description": "The internal record identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "ExternalId", "in": "query", "description": "The external identifier (optional).", "schema": { "type": "string" } }, { "name": "ReferenceId", "in": "query", "description": "The reference identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "ModelId", "in": "query", "description": "The model identifier", "schema": { "type": "string" } }, { "name": "ModifiedFrom", "in": "query", "description": "The ModifiedOn greater than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "ModifiedTo", "in": "query", "description": "The ModifiedOn less than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "IncludeLookupProperties", "in": "query", "description": "The comma-separated list of navigation properties representing records included to query result.", "schema": { "type": "string" } }, { "name": "selfSourceId", "in": "query", "description": "OBSOLETE", "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "OBSOLETE PublisherSourceId", "schema": { "type": "string", "format": "uuid" } }, { "name": "options", "in": "query", "description": "The format options", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JObjectCollectionResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/QueryingData/FindDataByModelName/{modelCode}": { "get": { "tags": [ "QueryingData" ], "summary": "Get a filtered collection of data from data-model using model name.", "parameters": [ { "name": "modelCode", "in": "path", "description": "The model code", "required": true, "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ScenarioId", "in": "query", "description": "The integration-scenario identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "FeatureId", "in": "query", "description": "The integration-feature identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "SelfSourceOnly", "in": "query", "description": "The flag to apply self-source filter, the bypass used for testing purposes (optional).\nNote: used for integration profiles", "schema": { "type": "boolean" } }, { "name": "PublisherSourceId", "in": "query", "description": "The publisher source identifier (optional).", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "description": "Flag to include deleted records. (default: false)", "schema": { "type": "boolean" } }, { "name": "MandantCode", "in": "query", "description": "The mandant code (optional).\nNote: if AllMandants flag is true, this is not allowed.", "schema": { "type": "string" } }, { "name": "AllMandants", "in": "query", "description": "Flag to include all mandants (default: false).\nNote: if true, MandantCode is not allowed.", "schema": { "type": "boolean" } }, { "name": "RecordId", "in": "query", "description": "The internal record identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "ExternalId", "in": "query", "description": "The external identifier (optional).", "schema": { "type": "string" } }, { "name": "ReferenceId", "in": "query", "description": "The reference identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "ModelId", "in": "query", "description": "The model identifier", "schema": { "type": "string" } }, { "name": "ModifiedFrom", "in": "query", "description": "The ModifiedOn greater than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "ModifiedTo", "in": "query", "description": "The ModifiedOn less than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "IncludeLookupProperties", "in": "query", "description": "The comma-separated list of navigation properties representing records included to query result.", "schema": { "type": "string" } }, { "name": "selfSourceId", "in": "query", "description": "OBSOLETE", "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "OBSOLETE PublisherSourceId", "schema": { "type": "string", "format": "uuid" } }, { "name": "options", "in": "query", "description": "The format options", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JObjectCollectionResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/QueryingData/FindDataByModelName/{modelCode}/ReferencedBy/{fkName}/{fkId}": { "get": { "tags": [ "QueryingData" ], "summary": "Get a filtered collection of data referenced by foreign key from data-model using model name.", "parameters": [ { "name": "modelCode", "in": "path", "description": "The model code", "required": true, "schema": { "type": "string" } }, { "name": "fkName", "in": "path", "description": "The name of lookup property (i.e. FK name)", "required": true, "schema": { "type": "string" } }, { "name": "fkId", "in": "path", "description": "The value in lookup property (i.e. FK value)", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ScenarioId", "in": "query", "description": "The integration-scenario identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "FeatureId", "in": "query", "description": "The integration-feature identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "SelfSourceOnly", "in": "query", "description": "The flag to apply self-source filter, the bypass used for testing purposes (optional).\nNote: used for integration profiles", "schema": { "type": "boolean" } }, { "name": "PublisherSourceId", "in": "query", "description": "The publisher source identifier (optional).", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "description": "Flag to include deleted records. (default: false)", "schema": { "type": "boolean" } }, { "name": "MandantCode", "in": "query", "description": "The mandant code (optional).\nNote: if AllMandants flag is true, this is not allowed.", "schema": { "type": "string" } }, { "name": "AllMandants", "in": "query", "description": "Flag to include all mandants (default: false).\nNote: if true, MandantCode is not allowed.", "schema": { "type": "boolean" } }, { "name": "RecordId", "in": "query", "description": "The internal record identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "ExternalId", "in": "query", "description": "The external identifier (optional).", "schema": { "type": "string" } }, { "name": "ReferenceId", "in": "query", "description": "The reference identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "ModelId", "in": "query", "description": "The model identifier", "schema": { "type": "string" } }, { "name": "ModifiedFrom", "in": "query", "description": "The ModifiedOn greater than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "ModifiedTo", "in": "query", "description": "The ModifiedOn less than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "IncludeLookupProperties", "in": "query", "description": "The comma-separated list of navigation properties representing records included to query result.", "schema": { "type": "string" } }, { "name": "selfSourceId", "in": "query", "description": "OBSOLETE", "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "OBSOLETE PublisherSourceId", "schema": { "type": "string", "format": "uuid" } }, { "name": "options", "in": "query", "description": "The format options", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JObjectCollectionResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/QueryingData/FindDataByModelName/{modelCode}/FilteredBy/{akName}/{akValue}": { "get": { "tags": [ "QueryingData" ], "summary": "Get a filtered collection of data filtered by alternate key from data-model using model name.", "parameters": [ { "name": "modelCode", "in": "path", "description": "The model code", "required": true, "schema": { "type": "string" } }, { "name": "akName", "in": "path", "description": "The name of scalar property (i.e. AK name)", "required": true, "schema": { "type": "string" } }, { "name": "akValue", "in": "path", "description": "The value in scalar property (i.e. AK value)", "required": true, "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ScenarioId", "in": "query", "description": "The integration-scenario identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "FeatureId", "in": "query", "description": "The integration-feature identifier (optional).\nNote: used for integration profiles", "schema": { "type": "string" } }, { "name": "SelfSourceOnly", "in": "query", "description": "The flag to apply self-source filter, the bypass used for testing purposes (optional).\nNote: used for integration profiles", "schema": { "type": "boolean" } }, { "name": "PublisherSourceId", "in": "query", "description": "The publisher source identifier (optional).", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "description": "Flag to include deleted records. (default: false)", "schema": { "type": "boolean" } }, { "name": "MandantCode", "in": "query", "description": "The mandant code (optional).\nNote: if AllMandants flag is true, this is not allowed.", "schema": { "type": "string" } }, { "name": "AllMandants", "in": "query", "description": "Flag to include all mandants (default: false).\nNote: if true, MandantCode is not allowed.", "schema": { "type": "boolean" } }, { "name": "RecordId", "in": "query", "description": "The internal record identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "ExternalId", "in": "query", "description": "The external identifier (optional).", "schema": { "type": "string" } }, { "name": "ReferenceId", "in": "query", "description": "The reference identifier (optional).", "schema": { "type": "string", "format": "uuid" } }, { "name": "ModelId", "in": "query", "description": "The model identifier", "schema": { "type": "string" } }, { "name": "ModifiedFrom", "in": "query", "description": "The ModifiedOn greater than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "ModifiedTo", "in": "query", "description": "The ModifiedOn less than UTC datetime (optional).", "schema": { "type": "string", "format": "date-time" } }, { "name": "IncludeLookupProperties", "in": "query", "description": "The comma-separated list of navigation properties representing records included to query result.", "schema": { "type": "string" } }, { "name": "selfSourceId", "in": "query", "description": "OBSOLETE", "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceId", "in": "query", "description": "OBSOLETE PublisherSourceId", "schema": { "type": "string", "format": "uuid" } }, { "name": "options", "in": "query", "description": "The format options", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JObjectCollectionResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/QueryingData/GetDataByModelId/{modelId}/{recordId}": { "get": { "tags": [ "QueryingData" ], "summary": "Get a data record from data-model using model id.", "parameters": [ { "name": "modelId", "in": "path", "description": "The model identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "recordId", "in": "path", "description": "The record identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "selfSourceId", "in": "query", "description": "The consumer source identifier", "schema": { "type": "string", "format": "uuid" } }, { "name": "includeLookupProperties", "in": "query", "description": "The comma-separated list of properties included to query result.", "schema": { "type": "string" } }, { "name": "options", "in": "query", "description": "The format options", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/QueryingData/GetDataByModelName/{modelName}/{recordId}": { "get": { "tags": [ "QueryingData" ], "summary": "Get a data record from data-model using model name.", "parameters": [ { "name": "modelName", "in": "path", "description": "The model name", "required": true, "schema": { "type": "string" } }, { "name": "recordId", "in": "path", "description": "The record identifier", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "selfSourceId", "in": "query", "description": "The consumer source identifier", "schema": { "type": "string", "format": "uuid" } }, { "name": "includeLookupProperties", "in": "query", "description": "The comma-separated list of properties included to query result.", "schema": { "type": "string" } }, { "name": "options", "in": "query", "description": "The format options", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SmartChecks/Results": { "get": { "tags": [ "SmartChecks" ], "parameters": [ { "name": "accessLevel", "in": "query", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } }, { "name": "Levels", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "GroupCode", "in": "query", "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Released", "in": "query", "schema": { "type": "boolean" } }, { "name": "Unreleased", "in": "query", "schema": { "type": "boolean" } }, { "name": "Deleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Undeleted", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartCheckResultModelCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SmartChecks/Results/{id}": { "get": { "tags": [ "SmartChecks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accessLevel", "in": "query", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } }, { "name": "Levels", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "GroupCode", "in": "query", "schema": { "type": "string" } }, { "name": "Released", "in": "query", "schema": { "type": "boolean" } }, { "name": "Unreleased", "in": "query", "schema": { "type": "boolean" } }, { "name": "Deleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "Undeleted", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartCheckResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SmartChecks": { "post": { "tags": [ "SmartChecks" ], "parameters": [ { "name": "accessLevel", "in": "query", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SmartChecks/Results/{id}/adhocReport": { "get": { "tags": [ "SmartChecks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accessLevel", "in": "query", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } }, { "name": "groupCode", "in": "query", "schema": { "type": "string" } }, { "name": "templateCode", "in": "query", "schema": { "type": "string" } }, { "name": "preferInline", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SmartChecks/Results/{id}/saveReport": { "post": { "tags": [ "SmartChecks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accessLevel", "in": "query", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } }, { "name": "templateCode", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SmartChecks/Results/cleanup": { "post": { "tags": [ "SmartChecks" ], "parameters": [ { "name": "accessLevel", "in": "query", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } }, { "name": "keepDays", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SmartChecks/Settings/alert": { "get": { "tags": [ "SmartChecks" ], "parameters": [ { "name": "accessLevel", "in": "query", "schema": { "$ref": "#/components/schemas/DataAccessLevel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartCheckAlertSettings" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SourcingData/EnqueueDataBySourceId/{sourceId}": { "get": { "tags": [ "SourcingData" ], "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnqueueDataStatusSummaryCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "post": { "tags": [ "SourcingData" ], "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "operationId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeDataRecordEdgeDataCollection" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SourcingData/EnqueueDataBySourceId/{sourceId}/start": { "post": { "tags": [ "SourcingData" ], "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "operationId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeDataRecordEdgeDataCollection" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnqueueDataStatusModel" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnqueueDataStatusModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SourcingData/EnqueueDataBySourceId/{sourceId}/append/{queueItemId}": { "post": { "tags": [ "SourcingData" ], "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "queueItemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeDataRecordEdgeDataCollection" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnqueueDataStatusModel" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnqueueDataStatusModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SourcingData/EnqueueDataBySourceId/{sourceId}/status/{queueItemId}": { "get": { "tags": [ "SourcingData" ], "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "queueItemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnqueueDataStatusModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SourcingData/EnqueueDataBySourceId/{sourceId}/cancel/{queueItemId}": { "delete": { "tags": [ "SourcingData" ], "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "queueItemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SourcingData/EnqueueDataBySourceName/{sourceName}": { "post": { "tags": [ "SourcingData" ], "parameters": [ { "name": "sourceName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "operationId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeDataRecordEdgeDataCollection" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SourcingData/GetEdgeConfiguration/{sourceId}": { "get": { "tags": [ "SourcingData" ], "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceEdgeConfiguration" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] }, "head": { "tags": [ "SourcingData" ], "parameters": [ { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceEdgeConfiguration" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SourcingData/ConfigureEdgeAgent": { "post": { "tags": [ "SourcingData" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentEdgeRegistration" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentEdgeConfiguration" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SourcingData/SetAgentStatus/{agentCode}": { "post": { "tags": [ "SourcingData" ], "parameters": [ { "name": "agentCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceEdgeStatus" } } } }, "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/SourcingData/SetAgentStatus": { "post": { "tags": [ "SourcingData" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAgentEdgeStatus" } } } }, "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/UsageStatistics/GetTenantsUsingApplication": { "get": { "tags": [ "UsageStatistics" ], "summary": "Get tenants and owner organizations containing registered data-agent(s) of specified application.", "parameters": [ { "name": "applicationCode", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantApplicationUsageCollectionResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Utilities/ConvertGuidToBinaryType3": { "get": { "tags": [ "Utilities" ], "parameters": [ { "name": "guidId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Utilities/ConvertGuidToBinaryType4": { "get": { "tags": [ "Utilities" ], "parameters": [ { "name": "guidId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Utilities/ConvertBinaryType3ToGuid": { "get": { "tags": [ "Utilities" ], "parameters": [ { "name": "binaryId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Utilities/ConvertBinaryType4ToGuid": { "get": { "tags": [ "Utilities" ], "parameters": [ { "name": "binaryId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/Widgets/GetDataModelStatistics": { "get": { "tags": [ "Widgets" ], "summary": "Get count of transformed data in data-models.", "parameters": [ { "name": "SkipEmpty", "in": "query", "schema": { "type": "boolean" } }, { "name": "AggregateRoots", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int64DataValueDataCollection" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Widgets/GetDataSourceStatistics": { "get": { "tags": [ "Widgets" ], "summary": "Get count of incoming data-chunks obtained from data-sources.", "parameters": [ { "name": "SkipEmpty", "in": "query", "schema": { "type": "boolean" } }, { "name": "AggregateRoots", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int64DataValueDataCollection" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } }, "/api/v1/Widgets/GetIntegrationStats": { "get": { "tags": [ "Widgets" ], "summary": "Get count of incoming data-chunks obtained from data-sources.", "parameters": [ { "name": "SkipEmpty", "in": "query", "schema": { "type": "boolean" } }, { "name": "DecisiveDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStatsCollection" } } } } }, "security": [ { "oauth2": [ "apiim" ] } ] } } }, "components": { "schemas": { "ApplicationSettings": { "type": "object", "properties": { "dataSourceId": { "type": "string", "description": "The data-source identifier representing instance of integrated application.", "nullable": true }, "appCodeOrId": { "type": "string", "description": "The application code or id (mandatory).", "nullable": true }, "scenarioCodeOrId": { "type": "string", "description": "The scenario code or id (mandatory).", "nullable": true } }, "additionalProperties": false }, "BackgroundWorkItemStatus": { "enum": [ "Queued", "Running", "Done", "Error", "Skipped" ], "type": "string" }, "ConsumerDurationModel": { "type": "object", "properties": { "applicationCode": { "type": "string", "description": "The consumer application code", "nullable": true }, "sourceId": { "type": "string", "description": "The source ID", "nullable": true }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumerOperationModel" }, "description": "The list of operations with their durations", "nullable": true } }, "additionalProperties": false, "description": "The model representing the duration of operations performed by a consumer application." }, "ConsumerOperationModel": { "type": "object", "properties": { "order": { "type": "integer", "description": "the order of the n-tuple", "format": "int32" }, "hasAckMilestone": { "type": "boolean", "description": "Flag indicating whether the consumer application has a milestone for the acknowledgment" }, "hasConsumerMilestone": { "type": "boolean", "description": "Flag indicating whether the consumer application has a milestone for the operation" }, "applicationDuration": { "type": "number", "description": "The duration of consumer application internal processing", "format": "double" }, "queryingDuration": { "type": "number", "description": "The duration of the querying process in the consumer application.", "format": "double" }, "notificationDelayDuration": { "type": "number", "description": "The duration of the delay from the moment the notification is published to its delivery to the consumer application.", "format": "double" } }, "additionalProperties": false, "description": "The model representing the duration of operations performed by a consumer application." }, "CurrentStatus": { "type": "object", "properties": { "pending": { "type": "array", "items": { "$ref": "#/components/schemas/QueryStoreStatus" }, "description": "Get a query-store status of data-sources in pending state.", "nullable": true }, "idle": { "type": "array", "items": { "$ref": "#/components/schemas/QueryStoreStatus" }, "description": "Get a query-store status of data-sources in idle state.", "nullable": true } }, "additionalProperties": false, "description": "Represents a current status of data-service." }, "DataAccessLevel": { "enum": [ "Auto", "Private", "Public" ], "type": "string" }, "DataAgentDefinition": { "type": "object", "properties": { "notes": { "type": "string", "nullable": true }, "utcCreatedOn": { "type": "string", "format": "date-time" }, "utcModifiedOn": { "type": "string", "format": "date-time" }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-source.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "code": { "type": "string", "nullable": true }, "customCode": { "type": "string", "nullable": true }, "providerCodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "description": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" }, "accessLevel": { "$ref": "#/components/schemas/DataAccessLevel" } }, "additionalProperties": false, "description": "Represents a data-agent definition contract." }, "DataAgentDefinitionCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DataAgentDefinition" }, "nullable": true } }, "additionalProperties": false }, "DataAgentDefinitionCreate": { "required": [ "code" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string" }, "providerCodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "customCode": { "type": "string", "description": "The identifier of application instance", "nullable": true }, "description": { "type": "string", "description": "The description", "nullable": true }, "notes": { "type": "string", "description": "The notes or comments about the data-agent definition.", "nullable": true }, "enabled": { "type": "boolean", "description": "The flag indicating whether data agent is enabled or not" }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-source.", "nullable": true } }, "additionalProperties": false, "description": "Represents a data-agent definition contract for create." }, "DataAgentDefinitionImport": { "required": [ "code", "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "minLength": 1, "type": "string" }, "providerCodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "customCode": { "type": "string", "description": "The identifier of application instance", "nullable": true }, "description": { "type": "string", "description": "The description", "nullable": true }, "notes": { "type": "string", "description": "The notes or comments about the data-agent definition.", "nullable": true }, "enabled": { "type": "boolean", "description": "The flag indicating whether data agent is enabled or not" }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-source.", "nullable": true } }, "additionalProperties": false, "description": "Represents a data-agent definition contract for import." }, "DataAgentDefinitionUpdate": { "type": "object", "properties": { "customCode": { "type": "string", "description": "The identifier of application instance", "nullable": true }, "description": { "type": "string", "description": "The description", "nullable": true }, "notes": { "type": "string", "description": "The notes or comments about the data-agent definition.", "nullable": true }, "enabled": { "type": "boolean", "description": "The flag indicating whether data agent is enabled or not" }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-source.", "nullable": true } }, "additionalProperties": false, "description": "Represents a data-agent definition contract for update." }, "DataAgentEdgeConfiguration": { "required": [ "agentCode", "sourceIds" ], "type": "object", "properties": { "agentCode": { "minLength": 1, "type": "string", "description": "Unique data-agent code." }, "sourceIds": { "type": "array", "items": { "type": "string" }, "description": "The list of data-source identifiers provided by data-agent." }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of edge data-agent.", "nullable": true } }, "additionalProperties": false, "description": "Represents a configuration of edge data-agent." }, "DataAgentEdgeRegistration": { "required": [ "agentCode" ], "type": "object", "properties": { "agentCode": { "minLength": 1, "type": "string", "description": "Unique data-agent code." }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of edge data-agent.", "nullable": true } }, "additionalProperties": false, "description": "Represents a registration of edge data-agent." }, "DataAgentEdgeStatus": { "required": [ "agentCode" ], "type": "object", "properties": { "agentCode": { "minLength": 1, "type": "string", "description": "Unique data-agent code." }, "isLive": { "type": "boolean", "description": "DataAgent is healthy and communicating with ASOL Platform." }, "isReady": { "type": "boolean", "description": "DataAgent is healthy and ready to communicate with data-source.\nNote: Available only when 'CheckConnection' is requested.", "nullable": true }, "verboseStatus": { "type": "array", "items": { "type": "string" }, "description": "The verbose status of data-source in data-agent.", "nullable": true }, "utcTimestamp": { "type": "string", "description": "The timestamp of data-source status in data-agent.", "format": "date-time" } }, "additionalProperties": false, "description": "Represents a status of edge data-agent." }, "DataAgentStatusModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "agentId": { "type": "string", "format": "uuid" }, "sourceId": { "type": "string", "format": "uuid", "nullable": true }, "operationId": { "type": "string", "format": "uuid", "nullable": true }, "version": { "type": "string", "description": "Gets the version of data-agent.", "nullable": true }, "isLive": { "type": "boolean", "description": "DataAgent is healthy and communicating with ASOL Platform." }, "isReady": { "type": "boolean", "description": "DataAgent is healthy and ready to communicate with data-source.\nNote: Available only when 'CheckConnection' is requested.", "nullable": true }, "verboseStatus": { "type": "array", "items": { "type": "string" }, "description": "The verbose status of data-source in data-agent.", "nullable": true }, "utcTimestamp": { "type": "string", "description": "The status timestamp from data-agent.", "format": "date-time" }, "createdOn": { "type": "string", "description": "Created on (UTC)", "format": "date-time" } }, "additionalProperties": false, "description": "Represents a data-agent status contract." }, "DataAgentStatusModelCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DataAgentStatusModel" }, "nullable": true } }, "additionalProperties": false }, "DataAgentSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string", "nullable": true }, "customCode": { "type": "string", "nullable": true }, "providerCodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "description": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" }, "accessLevel": { "$ref": "#/components/schemas/DataAccessLevel" } }, "additionalProperties": false, "description": "Represents a data-agent summary contract." }, "DataModelDefinition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "isAggregateRoot": { "type": "boolean" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/DataModelFieldDefinition" }, "nullable": true }, "utcCreatedOn": { "type": "string", "format": "date-time" }, "utcModifiedOn": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Represents a data-model definition contract." }, "DataModelDefinitionBase": { "type": "object", "properties": { "id": { "type": "string", "description": "The data-model identifier.", "nullable": true }, "code": { "type": "string", "description": "The data-model code.", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" } }, "additionalProperties": false, "description": "Represents a data-model definition base contract." }, "DataModelDefinitionCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DataModelDefinition" }, "nullable": true } }, "additionalProperties": false }, "DataModelDefinitionImport": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "isAggregateRoot": { "type": "boolean" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/DataModelFieldDefinition" }, "nullable": true } }, "additionalProperties": false, "description": "Represents a data-model definition contract for import." }, "DataModelDefinitionImportV2": { "required": [ "code", "id", "isAggregateRoot", "name", "properties" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "isAggregateRoot": { "type": "boolean" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/DataModelPropertyDefinition" }, "nullable": true } }, "additionalProperties": false, "description": "Represents a data-model definition contract for import." }, "DataModelFieldDefinition": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isPublishedForLookup": { "type": "boolean" }, "isCollection": { "type": "boolean" }, "isLocalized": { "type": "boolean" }, "isNullable": { "type": "boolean" }, "fieldType": { "$ref": "#/components/schemas/DataModelFieldType" }, "referencedEntityTypeIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "expression": { "$ref": "#/components/schemas/DataModelFieldExpressionDefinition" }, "fieldValidations": { "type": "array", "items": { "$ref": "#/components/schemas/DataModelFieldDefinitionValidation" }, "nullable": true } }, "additionalProperties": false, "description": "Represents a data-model field definition contract." }, "DataModelFieldDefinitionValidation": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RequiredDataModelFieldDefinitionValidation" }, { "$ref": "#/components/schemas/MinValueDataModelFieldDefinitionValidation" }, { "$ref": "#/components/schemas/MaxValueDataModelFieldDefinitionValidation" }, { "$ref": "#/components/schemas/RangeDataModelFieldDefinitionValidation" }, { "$ref": "#/components/schemas/StringLengthDataModelFieldDefinitionValidation" }, { "$ref": "#/components/schemas/StringMinLengthDataModelFieldDefinitionValidation" }, { "$ref": "#/components/schemas/StringMaxLengthDataModelFieldDefinitionValidation" }, { "$ref": "#/components/schemas/StringRangeLengthDataModelFieldDefinitionValidation" }, { "$ref": "#/components/schemas/RegexDataModelFieldDefinitionValidation" }, { "$ref": "#/components/schemas/DecimalPrecisionDefinitionValidation" } ], "properties": { "validation": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "validation" } }, "DataModelFieldExpressionDefinition": { "type": "object", "properties": { "value": { "type": "string", "description": "Expression syntax.", "nullable": true }, "order": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Represents a data-model field expression definition contract." }, "DataModelFieldType": { "enum": [ "Text", "MultilineText", "TwoOptions", "WholeNumber", "DecimalNumber", "UniqueIdentifier", "UtcDateTime", "LookupEntity", "NestedEntity", "Date", "FileReference", "CurrencyNumber", "SingleSelectOptionSet", "MultiSelectOptionSet" ], "type": "string", "description": "Represents the data-model field-type enumeration." }, "DataModelMigrationRequest": { "type": "object", "properties": { "readOnlyMode": { "type": "boolean", "description": "Use read-only mode (=true) / read-write mode (=false)." }, "fields": { "type": "array", "items": { "type": "string" }, "description": "The list of field names to migrate.", "nullable": true }, "sourceId": { "type": "string", "description": "The data-source identifier. (optional)", "nullable": true } }, "additionalProperties": false }, "DataModelPropertyDefinition": { "required": [ "code", "fieldType", "isCollection", "isLocalized", "isNullable", "isPublishedForLookup", "name" ], "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "isPublishedForLookup": { "type": "boolean" }, "isCollection": { "type": "boolean" }, "isLocalized": { "type": "boolean" }, "isNullable": { "type": "boolean" }, "fieldType": { "$ref": "#/components/schemas/DataModelFieldType" }, "referencedEntityTypeIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "expression": { "$ref": "#/components/schemas/DataModelFieldExpressionDefinition" }, "fieldValidations": { "type": "array", "items": { "$ref": "#/components/schemas/DataModelFieldDefinitionValidation" }, "nullable": true } }, "additionalProperties": false, "description": "Represents a data-model property definition contract." }, "DataModelValidationErrorModel": { "type": "object", "properties": { "dataModelId": { "type": "string", "format": "uuid" }, "validation": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true }, "validationRules": { "type": "string", "nullable": true }, "validValueProposal": { "nullable": true } }, "additionalProperties": false }, "DataModelValidationResultModel": { "type": "object", "properties": { "dataObjectRecordId": { "type": "string", "format": "uuid" }, "status": { "$ref": "#/components/schemas/DataModelValidationResultStatusModel" }, "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/DataModelValidationErrorModel" }, "nullable": true } }, "additionalProperties": false }, "DataModelValidationResultModelCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DataModelValidationResultModel" }, "nullable": true } }, "additionalProperties": false }, "DataModelValidationResultStatusModel": { "enum": [ "Success", "Error" ], "type": "string" }, "DataProcessingResultItemModel": { "required": [ "changeType", "externalId", "id", "modelId", "recordId", "resultId" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "resultId": { "type": "string", "description": "The data-processing result identifier.", "nullable": true }, "changeType": { "$ref": "#/components/schemas/ResultItemChangeType" }, "modelId": { "type": "string", "description": "The data-model identifier (i.e. the official identifier of data-model in VDM).", "nullable": true }, "recordId": { "type": "string", "description": "The data-record identifier (i.e. the internal identifier of data-record on AVA platform).", "nullable": true }, "externalId": { "type": "string", "description": "The fully-qualified data-record identifier (i.e. the navigation path for data-record combined from the source recordId and the source entityId).", "nullable": true }, "referenceId": { "type": "string", "description": "The reference identifier (i.e. the shared data-record identifier across multiple integration agents).", "nullable": true }, "mandantCode": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Represents a contract of data-processing result item." }, "DataProcessingResultItemModelCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DataProcessingResultItemModel" }, "nullable": true } }, "additionalProperties": false }, "DataProcessingResultModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "released": { "type": "boolean" }, "createdOn": { "type": "string", "description": "Created on (UTC)", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on (UTC)", "format": "date-time" }, "releasedOn": { "type": "string", "description": "Released on (UTC)", "format": "date-time", "nullable": true, "readOnly": true }, "sourceId": { "type": "string", "description": "The data-source identifier of publisher.", "nullable": true }, "operationId": { "type": "string", "description": "The operating-log identifier when the data-processing result has been created.", "nullable": true }, "profileId": { "type": "string", "description": "Gets the integration-profile identifier (i.e. current-profile when processed).", "nullable": true }, "scenarioId": { "type": "string", "description": "The integration-scenario identifier (used in the scope of integration-profile).", "nullable": true }, "featureId": { "type": "string", "description": "The integration-feature identifier (used in the scope of integration-profile).", "nullable": true }, "itemsCount": { "type": "integer", "description": "The number of appended items to the result.", "format": "int32" }, "modelIds": { "type": "array", "items": { "type": "string" }, "description": "The collection of model identifiers associated with data-processing result.", "nullable": true }, "mandantModels": { "type": "array", "items": { "$ref": "#/components/schemas/MandantModelGroup" }, "description": "The collection of structures representing aggregated model identifiers per mandant code.", "nullable": true } }, "additionalProperties": false, "description": "Represents a contract of data-processing result." }, "DataProcessingResultModelCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DataProcessingResultModel" }, "nullable": true } }, "additionalProperties": false }, "DataSourceDefinition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "agentId": { "type": "string", "format": "uuid" }, "agent": { "$ref": "#/components/schemas/DataAgentSummary" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceEntityMapping" }, "nullable": true }, "consumerSettings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceConsumedModelSettings" }, "nullable": true }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" }, "utcCreatedOn": { "type": "string", "format": "date-time" }, "utcModifiedOn": { "type": "string", "format": "date-time" }, "accessLevel": { "$ref": "#/components/schemas/DataAccessLevel" }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-source.", "nullable": true }, "dataLimit": { "type": "integer", "format": "int32", "nullable": true }, "isRegistered": { "type": "boolean", "description": "Flag if data-source is registered in current tenant or not (null means that status not resolved).", "nullable": true }, "suspendedOn": { "type": "string", "description": "UTC datetime when processing of the input-queue is suspended on.", "format": "date-time", "nullable": true }, "applicationCode": { "type": "string", "description": "The application code assigned to data-source.", "nullable": true }, "applicationId": { "type": "string", "description": "The application id assigned to data-source.", "nullable": true }, "clientId": { "type": "string", "description": "The clientId assigned to data-source.", "nullable": true }, "consumerCode": { "type": "string", "description": "The consumerCode of MessageGateway assigned to data-source.", "nullable": true }, "consumerType": { "type": "string", "description": "The consumerType (gRPC, webhook) of MessageGateway assigned to data-source.", "nullable": true }, "consumerWebhookUrl": { "type": "string", "description": "The web-hook URL assigned to data-source.", "nullable": true }, "useIntegrationProfile": { "type": "boolean", "description": "The flag if integration profile is used or not (false = legacy behavior)." }, "useConsumerSettings": { "type": "boolean", "description": "The flag if legacy consumer settings is used when integration profile isn't used." } }, "additionalProperties": false, "description": "Represents a data-source definition contract." }, "DataSourceDefinitionCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceDefinition" }, "nullable": true } }, "additionalProperties": false }, "DataSourceDefinitionCreate": { "required": [ "agentId", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "agentId": { "type": "string", "format": "uuid" }, "description": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceEntityMapping" }, "nullable": true }, "consumerSettings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceConsumedModelSettings" }, "nullable": true }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-source.", "nullable": true }, "dataLimit": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Represents a data-source definition contract for create." }, "DataSourceDefinitionImport": { "required": [ "agentId", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "minLength": 1, "type": "string" }, "agentId": { "type": "string", "format": "uuid" }, "description": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceEntityMapping" }, "nullable": true }, "consumerSettings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceConsumedModelSettings" }, "nullable": true }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-source.", "nullable": true }, "dataLimit": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Represents a data-source definition contract for import." }, "DataSourceDefinitionUpdate": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceEntityMapping" }, "nullable": true }, "consumerSettings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceConsumedModelSettings" }, "nullable": true }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-source.", "nullable": true }, "dataLimit": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Represents a data-source definition contract for update." }, "DataSourceEdgeConfiguration": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Unique data-source identifier, i.e. artificial identifier." }, "name": { "minLength": 1, "type": "string", "description": "Unique data-source name, i.e. natural identifier." }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceEdgeEntityMapping" }, "description": "The entity mappings of edge data-source.", "nullable": true }, "dataLimit": { "type": "integer", "description": "The data limit for sending to data-service.", "format": "int32", "nullable": true }, "consumerSettings": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceEdgeConsumedModelSettings" }, "description": "The consumer settings of edge data-source.", "nullable": true }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of edge data-source.", "nullable": true } }, "additionalProperties": false, "description": "Represents a configuration of edge data-source." }, "DataSourceEdgeConsumedModelSettings": { "required": [ "modelId", "modelName" ], "type": "object", "properties": { "modelId": { "minLength": 1, "type": "string", "description": "Unique identifier of consumed data-model in data-service, i.e. artificial identifier." }, "modelName": { "minLength": 1, "type": "string", "description": "Unique name of consumed data-model in data-service, i.e. natural identifier." }, "includedSourceIds": { "type": "array", "items": { "type": "string" }, "description": "List of data-sources included to consumed data events (i.e. event filter).", "nullable": true }, "excludedSourceIds": { "type": "array", "items": { "type": "string" }, "description": "List of data-sources excluded from consumed data events (i.e. event filter).", "nullable": true }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of edge data-source consumed model settings.", "nullable": true } }, "additionalProperties": false, "description": "Represents the edge data-source consumer settings of a consumed data-model in data-service." }, "DataSourceEdgeEntityMapping": { "required": [ "sourceEntityId", "targetModelId", "targetModelName" ], "type": "object", "properties": { "sourceEntityId": { "minLength": 1, "type": "string", "description": "Edge data-source entity identifier (must be unique in SourceId scope)." }, "targetModelId": { "minLength": 1, "type": "string", "description": "Unique identifier of target data-model in data-service, i.e. artificial identifier." }, "targetModelName": { "minLength": 1, "type": "string", "description": "Unique code/symbolic name of target data-model in data-service, i.e. natural identifier." }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of edge data-source entity mapping.", "nullable": true } }, "additionalProperties": false, "description": "Represents the edge data-source entity mapping to a target data-model in data-service." }, "DataSourceEdgeStatus": { "required": [ "sourceId" ], "type": "object", "properties": { "sourceId": { "minLength": 1, "type": "string", "description": "Unique data-source identifier." }, "operationId": { "type": "string", "description": "Operation identifier (optional).", "nullable": true }, "isLive": { "type": "boolean", "description": "DataAgent is healthy and communicating with ASOL Platform." }, "isReady": { "type": "boolean", "description": "DataAgent is healthy and ready to communicate with data-source.\nNote: Available only when 'CheckConnection' is requested.", "nullable": true }, "verboseStatus": { "type": "array", "items": { "type": "string" }, "description": "The verbose status of data-source in data-agent.", "nullable": true }, "utcTimestamp": { "type": "string", "description": "The timestamp of data-source status in data-agent.", "format": "date-time" } }, "additionalProperties": false, "description": "Represents a status of edge data-source." }, "DataTransformationDefinition": { "type": "object", "properties": { "id": { "type": "string", "description": "The data-transformation identifier (GUID).", "format": "uuid" }, "sourceId": { "type": "string", "description": "The data-source identifier (GUID).", "format": "uuid" }, "customCode": { "type": "string", "description": "The invariant code of data-transformation (i.e. custom identifier).\nThe code is unique per data-source.", "nullable": true }, "notes": { "type": "string", "description": "The data-transformation notes.", "nullable": true }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceEntityMapping" }, "description": "Collection of the model-mappings defined in the data-transformation.", "nullable": true }, "mappingsHash": { "type": "string", "description": "Hash of the model-mappings collection using ICollection contract.", "nullable": true }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" }, "utcCreatedOn": { "type": "string", "format": "date-time" }, "utcModifiedOn": { "type": "string", "format": "date-time" }, "accessLevel": { "$ref": "#/components/schemas/DataAccessLevel" } }, "additionalProperties": false, "description": "Represents a data-transformation definition contract." }, "DataTransformationDefinitionCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DataTransformationDefinition" }, "nullable": true } }, "additionalProperties": false }, "DataTransformationDefinitionCreate": { "type": "object", "properties": { "sourceId": { "type": "string", "description": "The data-source identifier (GUID).", "format": "uuid" }, "sourceCode": { "type": "string", "nullable": true }, "customCode": { "type": "string", "description": "The invariant code of data-transformation (i.e. custom identifier).\nThe code is unique per data-source.", "nullable": true }, "notes": { "type": "string", "description": "The data-transformation notes.", "nullable": true }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceEntityMapping" }, "description": "Collection of the model-mappings defined in the data-transformation.", "nullable": true }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-transformation.", "nullable": true } }, "additionalProperties": false, "description": "Represents a data-transformation definition contract for create." }, "DataTransformationDefinitionImport": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The data-transformation identifier (GUID).", "format": "uuid" }, "sourceId": { "type": "string", "description": "The data-source identifier (GUID).", "format": "uuid" }, "sourceCode": { "type": "string", "nullable": true }, "customCode": { "type": "string", "description": "The invariant code of data-transformation (i.e. custom identifier).\nThe code is unique per data-source.", "nullable": true }, "notes": { "type": "string", "description": "The data-transformation notes.", "nullable": true }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceEntityMapping" }, "description": "Collection of the model-mappings defined in the data-transformation.", "nullable": true }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-transformation.", "nullable": true } }, "additionalProperties": false, "description": "Represents a data-transformation definition contract for import." }, "DataTransformationDefinitionUpdate": { "type": "object", "properties": { "notes": { "type": "string", "description": "The data-transformation notes.", "nullable": true }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceEntityMapping" }, "description": "Collection of the model-mappings defined in the data-transformation.", "nullable": true }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-transformation.", "nullable": true } }, "additionalProperties": false, "description": "Represents a data-transformation definition contract for update." }, "DecimalPrecisionDefinitionValidation": { "required": [ "maxPrecision" ], "type": "object", "properties": { "validation": { "type": "string", "description": "Discriminator: \"DecimalPrecision\"", "nullable": true, "example": "DecimalPrecision" }, "maxPrecision": { "type": "integer", "description": "MaxPrecision: Specifies the maximum precision allowed for a decimal input.", "format": "int32", "example": 2 } }, "additionalProperties": false, "description": "Represents a validation that ensures a decimal field value has precision not longer than a specified maximum.\nThis validation is suitable for fields with decimal-based data types.\n \nSupported data model field types:\n- DecimalNumber\n- CurrencyNumber" }, "EdgeDataMappingDirective": { "type": "object", "properties": { "preserveEntityMapping": { "type": "boolean", "description": "Gets or sets a value indicating whether to preserve and extend entity mapping instead of replace and override. Default is false (i.e. replace)." }, "modelId": { "type": "string", "description": "Gets the unique identifier for the data-model.", "format": "uuid" }, "priority": { "type": "integer", "description": "Gets or sets the priority of the mapping directive. Default is 0.", "format": "int32", "nullable": true }, "transformationType": { "$ref": "#/components/schemas/EdgeExternalIdTransformationType" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "Gets or sets the collection of options as key-value pairs.", "nullable": true }, "replaceCommonFields": { "type": "boolean", "description": "Gets or sets a value indicating whether existing common fields will be updated or replaced. Default is false (i.e. updated).", "nullable": true }, "replaceCustomFields": { "type": "boolean", "description": "Gets or sets a value indicating whether existing custom fields will be updated or replaced. Default is false (i.e. updated).", "nullable": true }, "mandantCodeIsRequired": { "type": "boolean", "description": "Gets or sets a value indicating whether the MandantCode is required. Default is false.", "nullable": true } }, "additionalProperties": false, "description": "Represents a mapping directive of the edge data-source collection/record." }, "EdgeDataRecord": { "required": [ "entityId" ], "type": "object", "properties": { "mappingDirectives": { "type": "array", "items": { "$ref": "#/components/schemas/EdgeDataMappingDirective" }, "description": "Gets or sets the collection of mapping directives for the edge data-source record.\n\n Important: These directives are applied to this item instead of directives defined at collection level.", "nullable": true }, "entityMappingId": { "type": "string", "description": "Edge data-source entity-mapping identifier (optional, must be unique in SourceId scope).\nWhen defined it is used to choose appropriate data-transformation(s).", "nullable": true }, "entityId": { "minLength": 1, "type": "string", "description": "Edge data-source entity identifier (mandatory, must be unique in SourceId scope).\nIt is also used to choose appropriate data-transformation(s) when ASOL.DataService.Edge.Contracts.EdgeDataRecord.EntityMappingId isn't defined." }, "recordId": { "type": "string", "description": "Edge data-source record identifier (must be unique in EntityId scope).\nCan be null when CustomRecordIdLookup transformation is applied.", "nullable": true }, "referenceId": { "type": "string", "description": "Global reference identifier of record (determines original record in multi-sided updates).\nCan be null when ReferenceId is assigned in transformation.", "format": "uuid", "nullable": true }, "mandantCode": { "type": "string", "description": "Represents a mandant identifier. (optional)", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "Collection of key-value pairs (i.e. incoming data-fields) for common properties and their values, i.e. edge-record content.\nNote: can be null when edge-record is flagged as ASOL.DataService.Edge.Contracts.EdgeDataRecord.IsDeleted.\n\nOBSOLETE: Use the property instead.", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "Collection of key-value pairs (i.e. incoming data-fields) for custom properties and their values, i.e. edge-record content.\nNote: can be null when edge-record is flagged as ASOL.DataService.Edge.Contracts.EdgeDataRecord.IsDeleted.\n\nOBSOLETE: Use the property instead.", "nullable": true }, "data": { "description": "Incoming data-object for common properties and their values, i.e. edge-record content.\nNote: can be null when edge-record is flagged as ASOL.DataService.Edge.Contracts.EdgeDataRecord.IsDeleted.\n\nOBSOLETE: Use the property instead.", "nullable": true }, "commonData": { "description": "Incoming data-object for common properties and their values, i.e. edge-record content.\nNote: can be null when edge-record is flagged as ASOL.DataService.Edge.Contracts.EdgeDataRecord.IsDeleted.", "nullable": true }, "customData": { "description": "Incoming data-object for custom properties and their values, i.e. edge-record content.\nNote: can be null when edge-record is flagged as ASOL.DataService.Edge.Contracts.EdgeDataRecord.IsDeleted.", "nullable": true }, "isDeleted": { "type": "boolean", "description": "Edge data-source record flag if record is deleted (default: false)." }, "utcTimestamp": { "type": "string", "description": "Edge data-source record timestamp in UTC to track data-changes.", "format": "date-time", "nullable": true }, "version": { "type": "string", "description": "Edge data-source record version to ensure data-contract compatibility.", "nullable": true }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-agents.", "nullable": true } }, "additionalProperties": false, "description": "Represents the edge data-source record received by data-service." }, "EdgeDataRecordEdgeDataCollection": { "type": "object", "properties": { "mappingDirectives": { "type": "array", "items": { "$ref": "#/components/schemas/EdgeDataMappingDirective" }, "description": "Gets or sets the collection of mapping directives for the edge data-source collection.\n\n Important: These directives are applied to all items in this collection unless defined at item level.", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/EdgeDataRecord" }, "nullable": true }, "incompleteData": { "type": "boolean", "description": "Represents flag that this collection is incomplete and will continue." }, "snapshotId": { "type": "string", "description": "Represents a snapshot identifier.", "nullable": true, "deprecated": true }, "scenarioId": { "type": "string", "description": "The integration-scenario identifier.\nNote: used for integration scenarios", "nullable": true }, "featureId": { "type": "string", "description": "The integration-feature identifier.\nNote: used for integration scenarios", "nullable": true } }, "additionalProperties": false, "description": "Represents the edge data-source collection of data received by data-service." }, "EdgeExternalIdTransformationType": { "enum": [ "Default", "Custom" ], "type": "string", "description": "Represents the source entity mapping transformation type enumeration." }, "EnqueueDataStatus": { "enum": [ "Started", "Pending", "Completed", "Canceled", "Running", "Success", "Failed" ], "type": "string", "description": "Represents the status enumeration for enqueuing data." }, "EnqueueDataStatusModel": { "type": "object", "properties": { "sourceId": { "type": "string", "description": "The data-source identifier.", "nullable": true }, "wasSuccess": { "type": "boolean", "nullable": true, "readOnly": true }, "wasFailure": { "type": "boolean", "nullable": true, "readOnly": true }, "errorMessage": { "type": "string", "description": "Gets error message or null.", "nullable": true }, "queueItemId": { "type": "string", "description": "The queue-item identifier.", "nullable": true }, "operationId": { "type": "string", "description": "The operation identifier.", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "finishedOn": { "type": "string", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/EnqueueDataStatus" }, "itemsCount": { "type": "integer", "description": "The count of data-objects in the incoming queue-item.", "format": "int32" } }, "additionalProperties": false }, "EnqueueDataStatusSummary": { "type": "object", "properties": { "queueItemId": { "type": "string", "description": "The queue-item identifier.", "nullable": true }, "operationId": { "type": "string", "description": "The operation identifier.", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "finishedOn": { "type": "string", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/EnqueueDataStatus" }, "itemsCount": { "type": "integer", "description": "The count of data-objects in the incoming queue-item.", "format": "int32" } }, "additionalProperties": false }, "EnqueueDataStatusSummaryCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/EnqueueDataStatusSummary" }, "nullable": true } }, "additionalProperties": false }, "HealthStatus": { "enum": [ "Unhealthy", "Degraded", "Healthy" ], "type": "string" }, "IComparable": { "type": "object", "additionalProperties": false }, "IncludedDataModel": { "type": "object", "properties": { "readOnly": { "type": "boolean", "description": "The data-access mode: read-write = false, read-only = true" }, "modelId": { "type": "string", "description": "The data-model identifier.", "nullable": true }, "model": { "$ref": "#/components/schemas/DataModelDefinitionBase" } }, "additionalProperties": false }, "IncludedFeature": { "type": "object", "properties": { "codeOrId": { "type": "string", "description": "The integration-feature code or identifier.", "nullable": true }, "consumeOnly": { "type": "boolean", "description": "The feature-usage mode: inherited = false, consume-only = true" } }, "additionalProperties": false }, "IncludedFeatureModel": { "type": "object", "properties": { "consumeOnly": { "type": "boolean", "description": "The feature-usage mode: inherited = false, consume-only = true" }, "featureId": { "type": "string", "description": "The integration-feature identifier.", "nullable": true }, "feature": { "$ref": "#/components/schemas/IntegrationFeatureBase" } }, "additionalProperties": false }, "IncludedModel": { "type": "object", "properties": { "codeOrId": { "type": "string", "description": "The data-model code or identifier.", "nullable": true }, "readOnly": { "type": "boolean", "description": "The data-access mode: read-write = false, read-only = true" } }, "additionalProperties": false }, "IncludedScenarioModel": { "type": "object", "properties": { "scenarioId": { "type": "string", "description": "The integration-scenario identifier.", "nullable": true }, "scenario": { "$ref": "#/components/schemas/IntegrationScenarioBase" } }, "additionalProperties": false }, "Int64DataValue": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "description": "Represents a data value contract." }, "Int64DataValueDataCollection": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Int64DataValue" }, "nullable": true }, "itemCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "description": "Represents a data collection contract." }, "IntegratedApplicationDefinition": { "type": "object", "properties": { "id": { "type": "string", "description": "The application identifier (optional).", "nullable": true }, "code": { "type": "string", "description": "The application code (invariant).", "nullable": true }, "importHash": { "type": "string", "description": "Hash computed for the import definition of integrated-application.", "nullable": true }, "isNative": { "type": "boolean", "description": "The flag if application is native or external (i.e. cloud service or on-premise service)." }, "isOnPremise": { "type": "boolean", "description": "The flag if application is on-premise installation or cloud service." }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "supportedFeatures": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedFeature" }, "description": "The supported features.", "nullable": true } }, "additionalProperties": false, "description": "Represents an integrated-application definition." }, "IntegratedApplicationModel": { "type": "object", "properties": { "supportedFeatures": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedFeatureModel" }, "description": "The supported features.", "nullable": true }, "id": { "type": "string", "description": "The application identifier.", "nullable": true }, "code": { "type": "string", "description": "The application code.", "nullable": true }, "importHash": { "type": "string", "description": "Hash computed for the import definition of integrated-application.", "nullable": true }, "isNative": { "type": "boolean", "description": "The flag if application is native or external (i.e. cloud service or on-premise service)." }, "isOnPremise": { "type": "boolean", "description": "The flag if application is on-premise installation or cloud service." }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents an integrated-application details contract." }, "IntegratedApplicationReference": { "type": "object", "properties": { "id": { "type": "string", "description": "The application identifier.", "nullable": true }, "code": { "type": "string", "description": "The application code.", "nullable": true }, "name": { "type": "string", "description": "The localized name.", "nullable": true }, "isNative": { "type": "boolean", "description": "The flag if application is native or external (i.e. cloud service or on-premise service)." }, "isOnPremise": { "type": "boolean", "description": "The flag if application is on-premise installation or cloud service." }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents an integrated-application reference contract." }, "IntegratedApplicationSummary": { "type": "object", "properties": { "id": { "type": "string", "description": "The application identifier.", "nullable": true }, "code": { "type": "string", "description": "The application code.", "nullable": true }, "importHash": { "type": "string", "description": "Hash computed for the import definition of integrated-application.", "nullable": true }, "isNative": { "type": "boolean", "description": "The flag if application is native or external (i.e. cloud service or on-premise service)." }, "isOnPremise": { "type": "boolean", "description": "The flag if application is on-premise installation or cloud service." }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents an integrated-application summary contract." }, "IntegratedApplicationSummaryCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IntegratedApplicationSummary" }, "nullable": true } }, "additionalProperties": false }, "IntegrationFeatureAppUsage": { "enum": [ "Input", "Output", "InputOutput" ], "type": "string", "description": "Represents the usage of integration-feature by integrated-application." }, "IntegrationFeatureBase": { "type": "object", "properties": { "id": { "type": "string", "description": "The feature identifier.", "nullable": true }, "code": { "type": "string", "description": "The feature code.", "nullable": true }, "importHash": { "type": "string", "description": "Hash computed for the import definition of integration-feature.", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents an integration-feature base contract." }, "IntegrationFeatureDefinition": { "type": "object", "properties": { "id": { "type": "string", "description": "The feature identifier (optional).", "nullable": true }, "code": { "type": "string", "description": "The feature code (invariant).", "nullable": true }, "importHash": { "type": "string", "description": "Hash computed for the import definition of integration-feature.", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "includedFeatures": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedFeature" }, "description": "The included integration-features.", "nullable": true }, "includedModels": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedModel" }, "description": "The included data-models.", "nullable": true }, "validationRules": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationRuleDefinitionModel" }, "description": "Represents the collection of validation rules associated with the integration feature.", "nullable": true }, "projectedProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectedPropertyDefinitionModel" }, "description": "Represents a collection of projection options for specific data model fields", "nullable": true } }, "additionalProperties": false, "description": "Represents an integration-feature definition." }, "IntegrationFeatureFilter": { "type": "object", "additionalProperties": false, "description": "Represents a filter of integration-features." }, "IntegrationFeatureModel": { "type": "object", "properties": { "includedFeatures": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedFeatureModel" }, "description": "The included integration-features.", "nullable": true }, "includedModels": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedDataModel" }, "description": "The included data-models.", "nullable": true }, "validationRules": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationRuleModel" }, "description": "Represents the collection of validation rules associated with the integration feature.", "nullable": true }, "projectedProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectedPropertyModel" }, "description": "Represents a collection of projection options for specific data model fields", "nullable": true }, "id": { "type": "string", "description": "The feature identifier.", "nullable": true }, "code": { "type": "string", "description": "The feature code.", "nullable": true }, "importHash": { "type": "string", "description": "Hash computed for the import definition of integration-feature.", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents an integration-feature details contract." }, "IntegrationFeatureReference": { "type": "object", "properties": { "id": { "type": "string", "description": "The feature identifier.", "nullable": true }, "code": { "type": "string", "description": "The feature code.", "nullable": true }, "name": { "type": "string", "description": "The localized name.", "nullable": true }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents an integration-feature reference contract." }, "IntegrationFeatureRulesValidationErrorModel": { "type": "object", "properties": { "dataModelId": { "type": "string", "format": "uuid" }, "propertyValidator": { "type": "string", "nullable": true }, "propertyCode": { "type": "string", "nullable": true }, "expressionValidator": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationFeatureRulesValidationResultModel": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/IntegrationFeatureRulesValidationResultStatusModel" }, "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationFeatureRulesValidationErrorModel" }, "description": "Collection of validation errors encountered during the validation\nprocess of integration feature rules.\nProvides detailed information about each error for further inspection\nand troubleshooting.", "nullable": true } }, "additionalProperties": false, "description": "Represents the validation result of integration feature rules,\nincluding the overall status and detailed validation errors if present." }, "IntegrationFeatureRulesValidationResultStatusModel": { "enum": [ "Success", "ValidationError", "EmptyFeatureId", "FeatureDoesNotExist", "EmptyValidationRules", "DataModelNotFound", "ValidatorNotFound", "ValidatorNotConfigured" ], "type": "string" }, "IntegrationFeatureSummary": { "type": "object", "properties": { "id": { "type": "string", "description": "The feature identifier.", "nullable": true }, "code": { "type": "string", "description": "The feature code.", "nullable": true }, "importHash": { "type": "string", "description": "Hash computed for the import definition of integration-feature.", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents an integration-feature summary contract." }, "IntegrationFeatureSummaryCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationFeatureSummary" }, "nullable": true } }, "additionalProperties": false }, "IntegrationMapAppFeatureUsage": { "type": "object", "properties": { "id": { "type": "string", "description": "The integration-feature identifier.", "nullable": true }, "code": { "type": "string", "description": "The integration-feature code.", "nullable": true }, "usage": { "$ref": "#/components/schemas/IntegrationFeatureAppUsage" }, "inputModelIds": { "type": "array", "items": { "type": "string" }, "description": "The data-model identifiers consumed by integration-feature for Input/InputOutput usage.", "nullable": true }, "outputModelIds": { "type": "array", "items": { "type": "string" }, "description": "The data-model identifiers published by integration-feature for Output/InputOutput usage.", "nullable": true } }, "additionalProperties": false, "description": "Represents a feature usage contract of integration-map." }, "IntegrationMapAppFeatureUsageCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationMapAppFeatureUsage" }, "nullable": true } }, "additionalProperties": false }, "IntegrationMapAppModelUsage": { "type": "object", "properties": { "id": { "type": "string", "description": "The data-model identifier.", "nullable": true }, "code": { "type": "string", "description": "The data-model code.", "nullable": true }, "usage": { "$ref": "#/components/schemas/IntegrationFeatureAppUsage" } }, "additionalProperties": false, "description": "Represents a data-model usage contract of integration-map." }, "IntegrationMapAppModelUsageCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationMapAppModelUsage" }, "nullable": true } }, "additionalProperties": false }, "IntegrationMapModel": { "type": "object", "properties": { "areaCode": { "type": "string", "description": "The identifier of definition area.", "nullable": true }, "activationKeys": { "type": "array", "items": { "type": "string" }, "description": "The list of activation keys to annotate definitions.", "nullable": true }, "scenarioId": { "type": "string", "description": "The integration-scenario identifier.", "nullable": true }, "scenario": { "$ref": "#/components/schemas/IntegrationScenarioModel" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/IntegratedApplicationReference" }, "description": "The available integrated applications.", "nullable": true }, "id": { "type": "string", "nullable": true }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents an integration-map details contract." }, "IntegrationRequestApplication": { "type": "object", "properties": { "appCodeOrId": { "type": "string", "description": "The application code or id.", "nullable": true }, "dataSourceId": { "type": "string", "description": "The data-source identifier representing instance of integrated application.", "nullable": true }, "keys": { "type": "array", "items": { "type": "string" }, "description": "The keys to activate the integration profile.", "nullable": true } }, "additionalProperties": false, "description": "Represents an application contract of integration-scenario request." }, "IntegrationRequestCreate": { "type": "object", "properties": { "appSettings": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationSettings" }, "nullable": true } }, "additionalProperties": false, "description": "Represents a create contract of integration-profile request." }, "IntegrationRequestItemBase": { "type": "object", "properties": { "_type": { "type": "string" } }, "additionalProperties": false }, "IntegrationRequestModel": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Null or error message from ASOL.DataService.Contracts.IntegrationRequestModel.Error.", "nullable": true }, "error": { "type": "string", "description": "Null or complete information about the error that occurred during migration processing.", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationRequestItemBase" }, "description": "The request items (payload data).", "nullable": true }, "targetProfileId": { "type": "string", "description": "The target profile (contextual data).", "nullable": true }, "sourceProfileId": { "type": "string", "description": "The source profile (contextual data).", "nullable": true }, "affectedAppIds": { "type": "array", "items": { "type": "string" }, "description": "The affected applications (contextual data).", "nullable": true }, "affectedSourceIds": { "type": "array", "items": { "type": "string" }, "description": "The affected data-sources (contextual data).", "nullable": true }, "id": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "description": "Created on (UTC)", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on (UTC)", "format": "date-time" }, "status": { "$ref": "#/components/schemas/IntegrationRequestStatus" }, "finishedOn": { "type": "string", "description": "Finished on (UTC)", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Represents a details contract of integration-scenario request." }, "IntegrationRequestStatus": { "enum": [ "Pending", "Waiting", "Running", "Canceled", "Success", "Failed" ], "type": "string", "description": "Represents a status of the integration-scenario request." }, "IntegrationRequestSummary": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Null or error message.", "nullable": true }, "targetProfileId": { "type": "string", "description": "The target profile (contextual data).", "nullable": true }, "sourceProfileId": { "type": "string", "description": "The source profile (contextual data).", "nullable": true }, "id": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "description": "Created on (UTC)", "format": "date-time" }, "modifiedOn": { "type": "string", "description": "Modified on (UTC)", "format": "date-time" }, "status": { "$ref": "#/components/schemas/IntegrationRequestStatus" }, "finishedOn": { "type": "string", "description": "Finished on (UTC)", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Represents a summary contract of integration-scenario request." }, "IntegrationRequestSummaryCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationRequestSummary" }, "nullable": true } }, "additionalProperties": false }, "IntegrationScenarioBase": { "type": "object", "properties": { "id": { "type": "string", "description": "The scenario identifier.", "nullable": true }, "code": { "type": "string", "description": "The scenario code.", "nullable": true }, "importHash": { "type": "string", "description": "Hash computed for the import definition of integration-scenario.", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents an integration-scenario base contract." }, "IntegrationScenarioDefinition": { "type": "object", "properties": { "id": { "type": "string", "description": "The scenario identifier (optional).", "nullable": true }, "code": { "type": "string", "description": "The scenario code (invariant).", "nullable": true }, "importHash": { "type": "string", "description": "Hash computed for the import definition of integration-scenario.", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "inputFeatureCodeOrId": { "type": "string", "description": "The input feature code or identifier.", "nullable": true }, "outputFeatureCodeOrId": { "type": "string", "description": "The output feature code or identifier.", "nullable": true } }, "additionalProperties": false, "description": "Represents an integration-scenario definition." }, "IntegrationScenarioFilter": { "type": "object", "additionalProperties": false, "description": "Represents a filter of integration-scenarios." }, "IntegrationScenarioModel": { "type": "object", "properties": { "inputFeatureId": { "type": "string", "description": "The input integration-feature identifier.", "nullable": true }, "inputFeature": { "$ref": "#/components/schemas/IntegrationFeatureReference" }, "outputFeatureId": { "type": "string", "description": "The output integration-feature identifier.", "nullable": true }, "outputFeature": { "$ref": "#/components/schemas/IntegrationFeatureReference" }, "includedScenarios": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedScenarioModel" }, "description": "The included integration-scenarios.", "nullable": true }, "id": { "type": "string", "description": "The scenario identifier.", "nullable": true }, "code": { "type": "string", "description": "The scenario code.", "nullable": true }, "importHash": { "type": "string", "description": "Hash computed for the import definition of integration-scenario.", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents an integration-scenario details contract." }, "IntegrationScenarioSummary": { "type": "object", "properties": { "inputFeatureId": { "type": "string", "description": "The input integration-feature identifier.", "nullable": true }, "outputFeatureId": { "type": "string", "description": "The output integration-feature identifier.", "nullable": true }, "id": { "type": "string", "description": "The scenario identifier.", "nullable": true }, "code": { "type": "string", "description": "The scenario code.", "nullable": true }, "importHash": { "type": "string", "description": "Hash computed for the import definition of integration-scenario.", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" } }, "additionalProperties": false, "description": "Represents an integration-scenario summary contract." }, "IntegrationScenarioSummaryCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationScenarioSummary" }, "nullable": true } }, "additionalProperties": false }, "IntegrationStatsCollection": { "type": "object", "properties": { "decisiveDate": { "type": "string", "format": "date-time" }, "name": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationStatsValueDataValue" }, "nullable": true }, "itemCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "description": "Represents an integration-statistics widget collection." }, "IntegrationStatsValue": { "type": "object", "properties": { "in": { "type": "integer", "format": "int64" }, "out": { "type": "integer", "format": "int64" }, "used": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "description": "Represents an integration-statistics widget value." }, "IntegrationStatsValueDataValue": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "$ref": "#/components/schemas/IntegrationStatsValue" } }, "additionalProperties": false, "description": "Represents a data value contract." }, "JObjectCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { }, "nullable": true } }, "additionalProperties": false }, "MandantModelGroup": { "type": "object", "properties": { "mandantCode": { "type": "string", "description": "The mandant identifier", "nullable": true }, "modelIds": { "type": "array", "items": { "type": "string" }, "description": "A collection of aggregated model Ids per mandant.", "nullable": true } }, "additionalProperties": false, "description": "A contract representing structure for grouping model Ids by mandant." }, "MaxValueDataModelFieldDefinitionValidation": { "required": [ "maximum" ], "type": "object", "properties": { "validation": { "type": "string", "description": "Discriminator: \"MaxValue\"", "nullable": true, "example": "MaxValue" }, "maximum": { "$ref": "#/components/schemas/IComparable" }, "maximumIsExclusive": { "type": "boolean", "description": "MaximumIsExclusive: If true, the value must be strictly less than the maximum.\nIf false, the maximum value itself is allowed.", "example": false } }, "additionalProperties": false, "description": "Represents a validation that ensures a data model field value is not greater than a specified maximum.\nThis validation is suitable for fields with numeric or date-based data types.\n \nSupported data model field types:\n- WholeNumber\n- DecimalNumber\n- UtcDateTime\n- Date" }, "MergeDataObjectsCollectionRequestModel": { "type": "object", "properties": { "runForAllTenants": { "type": "boolean", "description": "Determines whether the operation should be executed for all tenants in the system.\nWhen set to `true`, the request will be processed for all available tenants.\nOtherwise, the operation will only target the tenants specified in the `TenantIds` property." }, "tenantIds": { "type": "array", "items": { "type": "string" }, "description": "Specifies the collection of tenant identifiers for which the operation should be executed.\nThis property is utilized when `RunForAllTenants` is set to `false`.\nIf `RunForAllTenants` is `true`, this property will be ignored, and the operation\nwill be carried out for all available tenants.", "nullable": true }, "dropSeparateCollectionByModelAfterMerging": { "type": "boolean", "description": "When set to `true`, the individual collections for each merged model will\nbe removed from the system.\nIf set to `false`, the separate collections will be retained." } }, "additionalProperties": false }, "MergeDataObjectsCollectionResult": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "processes": { "type": "array", "items": { "$ref": "#/components/schemas/MergeDataObjectsTenantResult" }, "nullable": true } }, "additionalProperties": false }, "MergeDataObjectsTenantResult": { "type": "object", "properties": { "tenantId": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/BackgroundWorkItemStatus" }, "processedDocuments": { "type": "integer", "format": "int32" }, "exception": { "nullable": true }, "modelId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "MessageGatewayClientType": { "enum": [ "None", "Grpc", "Webhook" ], "type": "string", "description": "Represents the client type for message gateway." }, "MetadataVersionModel": { "type": "object", "properties": { "code": { "type": "string", "description": "The Date and time when the version - change in data becomes valid", "nullable": true }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" }, "modifiedBy": { "type": "string", "nullable": true }, "modifiedOn": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "The MetadataVersion contracts" }, "MetadataVersionModelCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataVersionModel" }, "nullable": true } }, "additionalProperties": false }, "MinValueDataModelFieldDefinitionValidation": { "required": [ "minimum" ], "type": "object", "properties": { "validation": { "type": "string", "description": "Discriminator: \"MinValue\"", "nullable": true, "example": "MinValue" }, "minimum": { "$ref": "#/components/schemas/IComparable" }, "minimumIsExclusive": { "type": "boolean", "description": "MinimumIsExclusive: If true, the value must be strictly greater than the minimum.\nIf false, the minimum value itself is allowed.", "example": false } }, "additionalProperties": false, "description": "Represents a validation that ensures a data model field value is not less than a specified minimum.\nThis validation is suitable for fields with numeric or date-based data types.\n \nSupported data model field types:\n- WholeNumber\n- DecimalNumber\n- UtcDateTime\n- Date" }, "OperatingLogModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "operationId": { "type": "string", "format": "uuid" }, "operationType": { "$ref": "#/components/schemas/OperationType" }, "activityType": { "type": "string", "description": "Type of operation activity (prefer use ASOL.DataService.Contracts.Primitives.OperationActivityType for well-known activities)", "nullable": true }, "createdOn": { "type": "string", "description": "Created on (UTC)", "format": "date-time" }, "severity": { "$ref": "#/components/schemas/StatusSeverity" }, "systemLevel": { "type": "boolean", "description": "System level = true, user level = false." }, "category": { "type": "string", "description": "Category of user message", "nullable": true }, "message": { "type": "string", "description": "User message (human readable)", "nullable": true }, "details": { "type": "array", "items": { "type": "string" }, "description": "Technical details", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "Custom fields", "nullable": true }, "source": { "type": "string", "description": "Source (represents log-item owner)", "nullable": true }, "agentId": { "type": "string", "description": "AgentId (represents log-item owner)", "format": "uuid", "nullable": true }, "sourceId": { "type": "string", "description": "SourceId (represents log-item owner)", "format": "uuid", "nullable": true }, "publisherSourceId": { "type": "string", "description": "PublisherSourceId when ConsumeData operation type is used", "format": "uuid", "nullable": true }, "utcTimestamp": { "type": "string", "description": "The timestamp in UTC when issue occured in source", "format": "date-time", "nullable": true }, "scopeId": { "type": "string", "description": "The ID of the scope in which the logs are created", "nullable": true } }, "additionalProperties": false, "description": "Represents an operating log contract." }, "OperatingLogModelCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OperatingLogModel" }, "nullable": true } }, "additionalProperties": false }, "OperatingLogModelCreate": { "type": "object", "properties": { "operationId": { "type": "string", "description": "Operation Identifier", "format": "uuid" }, "operationType": { "$ref": "#/components/schemas/OperationType" }, "activityType": { "type": "string", "description": "Type of operation activity (optional, prefer use ASOL.DataService.Contracts.Primitives.OperationActivityType for well-known activities)", "nullable": true }, "severity": { "$ref": "#/components/schemas/StatusSeverity" }, "systemLevel": { "type": "boolean", "description": "System level = true, user level = false." }, "customCategory": { "type": "string", "description": "Custom subcategory of user message", "nullable": true }, "message": { "type": "string", "description": "User message (human readable)", "nullable": true }, "details": { "type": "array", "items": { "type": "string" }, "description": "Technical details", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "Custom fields", "nullable": true }, "source": { "type": "string", "description": "Source (represents log-item owner).", "nullable": true }, "agentId": { "type": "string", "description": "AgentId (represents log-item owner).", "format": "uuid", "nullable": true }, "sourceId": { "type": "string", "description": "SourceId (represents log-item owner).", "format": "uuid", "nullable": true }, "publisherSourceId": { "type": "string", "description": "PublisherSourceId when ConsumeData operation type is used.", "format": "uuid", "nullable": true }, "utcTimestamp": { "type": "string", "description": "The timestamp in UTC when issue occured in source.", "format": "date-time", "nullable": true }, "scopeId": { "type": "string", "description": "The ID of the scope in which the logs are created", "nullable": true } }, "additionalProperties": false, "description": "Represents an operating log contract for create." }, "OperationScope": { "enum": [ "PublishData", "PublishDataWithConsumerFeedback", "ConsumerFeedbackOnly", "ConsumeData", "AgentStatus", "Coordination" ], "type": "string", "description": "Represents the operation scope enumeration to filter operating log items." }, "OperationType": { "enum": [ "InputData", "Transform", "ConsumeData", "AgentStatus", "Coordination" ], "type": "string", "description": "Represents the operation type enumeration." }, "PerformanceStatisticsAggregatedModel": { "type": "object", "properties": { "publisher": { "$ref": "#/components/schemas/PerformanceStatisticsPublisherModel" }, "platform": { "$ref": "#/components/schemas/StatisticModel" }, "platformWaiting": { "$ref": "#/components/schemas/StatisticModel" }, "consumers": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceStatisticsConsumerModel" }, "description": "The statistics calculated per consumer", "nullable": true }, "dateFrom": { "type": "string", "description": "The date from which the statistics were calculated", "format": "date-time" }, "dateTo": { "type": "string", "description": "The date to which the statistics were calculated", "format": "date-time" } }, "additionalProperties": false, "description": "The performance statistics model" }, "PerformanceStatisticsAggregatedModelCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PerformanceStatisticsAggregatedModel" }, "nullable": true } }, "additionalProperties": false }, "PerformanceStatisticsConsumerModel": { "type": "object", "properties": { "applicationCode": { "type": "string", "description": "The consumer application code", "nullable": true }, "sourceId": { "type": "string", "description": "The source ID", "nullable": true }, "hasApplicationMilestone": { "type": "boolean", "description": "Flag indicating if the application milestone is present" }, "hasAckMilestone": { "type": "boolean", "description": "Flag indicating if the ack milestone is present" }, "applicationStatistics": { "$ref": "#/components/schemas/StatisticModel" }, "queryingStatistics": { "$ref": "#/components/schemas/StatisticModel" }, "notificationDelay": { "$ref": "#/components/schemas/StatisticModel" } }, "additionalProperties": false, "description": "The performance statistics consumer model" }, "PerformanceStatisticsNonAggregatedModel": { "type": "object", "properties": { "dateFrom": { "type": "string", "description": "The date from which the statistics are being reported.", "format": "date-time", "nullable": true }, "publisherDuration": { "$ref": "#/components/schemas/PublisherDurationModel" }, "platformDuration": { "type": "number", "description": "The duration of the platform processing, which includes the time taken by the platform to process the operation.", "format": "double" }, "platformWaitingDuration": { "type": "number", "description": "The duration of the platform waiting, which includes the time the platform spent waiting for resources or other operations to complete.", "format": "double" }, "consumersDurations": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumerDurationModel" }, "description": "The duration of the consumer processes", "nullable": true }, "operationId": { "type": "string", "description": "The identifier of the operation for which the statistics are being reported.", "nullable": true } }, "additionalProperties": false, "description": "The model representing the non-aggregated performance statistics for a given operation." }, "PerformanceStatisticsPublisherModel": { "type": "object", "properties": { "applicationCode": { "type": "string", "description": "The source application", "nullable": true }, "sourceId": { "type": "string", "description": "The data source ID", "nullable": true }, "hasApplicationMilestone": { "type": "boolean", "description": "Flag indicating if the application milestone is present" }, "applicationStatistics": { "$ref": "#/components/schemas/StatisticModel" }, "sendingStatistics": { "$ref": "#/components/schemas/StatisticModel" } }, "additionalProperties": false, "description": "The performance statistics publisher model" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProjectedPropertyDefinitionModel": { "type": "object", "properties": { "modelCodeOrId": { "type": "string", "nullable": true }, "included": { "type": "array", "items": { "type": "string" }, "nullable": true }, "excluded": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ProjectedPropertyModel": { "type": "object", "properties": { "modelCodeOrId": { "type": "string", "nullable": true }, "included": { "type": "array", "items": { "type": "string" }, "nullable": true }, "excluded": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PublisherDurationModel": { "type": "object", "properties": { "applicationCode": { "type": "string", "description": "The source application", "nullable": true }, "sourceId": { "type": "string", "description": "The data source ID", "nullable": true }, "hasApplicationMilestone": { "type": "boolean", "description": "Flag indicating whether the application milestone is present" }, "applicationDuration": { "type": "number", "description": "The duration of the application processing", "format": "double" }, "sendingDuration": { "type": "number", "description": "The duration of the sending process", "format": "double" } }, "additionalProperties": false, "description": "The model representing the duration of application processing and sending process for a publisher." }, "QueryStoreStatus": { "type": "object", "properties": { "lockId": { "type": "string", "format": "uuid", "nullable": true }, "sourceId": { "type": "string", "format": "uuid" }, "modelIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "processingQueueItemId": { "type": "string", "format": "uuid", "nullable": true }, "pendingStatusDelay": { "type": "number", "format": "double" }, "utcStatusModifiedOn": { "type": "string", "format": "date-time", "nullable": true }, "waitingSourceData": { "type": "integer", "format": "int64" }, "waitingSourceDataDelay": { "type": "number", "format": "double" }, "utcSourceDataLoadedOn": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Represents a query-store status contract." }, "RangeDataModelFieldDefinitionValidation": { "required": [ "maximum", "minimum" ], "type": "object", "properties": { "validation": { "type": "string", "description": "Discriminator: \"Range\"", "nullable": true, "example": "Range" }, "minimum": { "$ref": "#/components/schemas/IComparable" }, "minimumIsExclusive": { "type": "boolean", "description": "MinimumIsExclusive: If true, values must be strictly greater than the minimum.\nIf false, the minimum value itself is allowed.", "example": false }, "maximum": { "$ref": "#/components/schemas/IComparable" }, "maximumIsExclusive": { "type": "boolean", "description": "MaximumIsExclusive: If true, values must be strictly less than the maximum.\nIf false, the maximum value itself is allowed.", "example": false } }, "additionalProperties": false, "description": "Represents a validation that ensures data model field values fall within a specified range.\nThis validation is suitable for fields with numeric or date-based data types.\n \nSupported data model field types:\n- WholeNumber\n- DecimalNumber\n- UtcDateTime\n- Date" }, "RefreshProfileRequestSettings": { "type": "object", "properties": { "dataSourceId": { "type": "string", "description": "The data-source identifier representing application instance for partial refresh (optional).", "nullable": true }, "applicationCodeOrId": { "type": "string", "description": "The integrated-application identifier for partial refresh (optional).", "nullable": true } }, "additionalProperties": false, "description": "Represents a settings of refresh integration-profile request." }, "RegexDataModelFieldDefinitionValidation": { "required": [ "pattern" ], "type": "object", "properties": { "validation": { "type": "string", "description": "Discriminator: \"Regex\"", "nullable": true, "example": "Regex" }, "pattern": { "type": "string", "description": "Pattern: The regular expression pattern that input must match.", "nullable": true, "example": "^[A-Z]{2}\\d{4}$" } }, "additionalProperties": false, "description": "Represents a validation that ensures a text field value matches a specified regular expression pattern.\nThis validation is suitable for fields with text-based data types.\n \nSupported data model field types:\n- Text" }, "RequiredDataModelFieldDefinitionValidation": { "type": "object", "properties": { "validation": { "type": "string", "description": "Discriminator: \"Required\"", "nullable": true, "example": "Required" }, "allowEmptyStrings": { "type": "boolean", "description": "AllowEmptyStrings: If true, empty strings are considered valid for text fields when required.\nIf false, empty strings are treated as missing values.", "example": false } }, "additionalProperties": false, "description": "Represents a validation that ensures a data model field contains a value.\nThis validation applies broadly across most data types, including text, numbers, identifiers, dates, lookups, files, and option sets.\n \nSupported data model field types:\n- Text\n- MultilineText\n- TwoOptions\n- WholeNumber\n- DecimalNumber\n- UniqueIdentifier\n- UtcDateTime\n- LookupEntity\n- NestedEntity\n- Date\n- FileReference\n- CurrencyNumber\n- SingleSelectOptionSet\n- MultiSelectOptionSet" }, "ResultItemChangeType": { "enum": [ "Created", "Updated", "Deleted" ], "type": "string", "description": "Represents the change-type of data-processing result item." }, "SeedDataObject": { "required": [ "externalId", "modelId" ], "type": "object", "properties": { "modelId": { "type": "string", "format": "uuid" }, "recordId": { "type": "string", "format": "uuid" }, "released": { "type": "boolean", "nullable": true }, "deleted": { "type": "boolean", "nullable": true }, "externalId": { "minLength": 1, "type": "string" }, "referenceId": { "type": "string", "description": "Global reference identifier of record (invariant, determines original record in multi-sided updates).", "format": "uuid", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "nullable": true } }, "additionalProperties": false, "description": "Represents a seeding data-object contract." }, "SmartCheckAlertSettings": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "minStatus": { "$ref": "#/components/schemas/HealthStatus" }, "saveReport": { "type": "boolean" }, "emailRecipients": { "type": "array", "items": { "type": "string" }, "nullable": true }, "messageTemplateCode": { "type": "string", "nullable": true }, "groupSettings": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SmartCheckAlertSettings" }, "nullable": true } }, "additionalProperties": false }, "SmartCheckDefinitionType": { "enum": [ "Root", "Group", "Check" ], "type": "string" }, "SmartCheckFileIdentifier": { "required": [ "fileId", "filePath", "folderId", "sharingType" ], "type": "object", "properties": { "accessLevel": { "$ref": "#/components/schemas/DataAccessLevel" }, "folderId": { "type": "string", "nullable": true }, "fileId": { "type": "string", "nullable": true }, "filePath": { "type": "string", "nullable": true }, "sharingType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SmartCheckResult": { "type": "object", "properties": { "runThreadId": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "applicationCode": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "type": { "$ref": "#/components/schemas/SmartCheckDefinitionType" }, "status": { "$ref": "#/components/schemas/HealthStatus" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/SmartCheckResultDetail" }, "nullable": true, "readOnly": true }, "reportPermanentLink": { "type": "string", "nullable": true }, "reportFileId": { "$ref": "#/components/schemas/SmartCheckFileIdentifier" }, "errorMessage": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true }, "childResults": { "type": "array", "items": { "$ref": "#/components/schemas/SmartCheckResult" }, "nullable": true }, "released": { "type": "boolean", "readOnly": true }, "deleted": { "type": "boolean", "readOnly": true }, "modifiedBy": { "type": "string", "nullable": true, "readOnly": true }, "modifiedOn": { "type": "string", "format": "date-time", "readOnly": true }, "createdBy": { "type": "string", "nullable": true, "readOnly": true }, "createdOn": { "type": "string", "format": "date-time", "readOnly": true }, "id": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "SmartCheckResultDetail": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "message": { "$ref": "#/components/schemas/StringLocalizedValue" }, "status": { "$ref": "#/components/schemas/HealthStatus" } }, "additionalProperties": false }, "SmartCheckResultDetailModel": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "message": { "$ref": "#/components/schemas/StringLocalizedValue" }, "status": { "$ref": "#/components/schemas/HealthStatus" } }, "additionalProperties": false }, "SmartCheckResultModel": { "required": [ "code", "id", "name", "runThreadId" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "runThreadId": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "name": { "$ref": "#/components/schemas/StringLocalizedValue" }, "description": { "$ref": "#/components/schemas/StringLocalizedValue" }, "type": { "$ref": "#/components/schemas/SmartCheckDefinitionType" }, "status": { "$ref": "#/components/schemas/HealthStatus" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/SmartCheckResultDetailModel" }, "nullable": true }, "reportPermanentLink": { "type": "string", "nullable": true }, "reportFileId": { "$ref": "#/components/schemas/SmartCheckFileIdentifier" }, "errorMessage": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true }, "released": { "type": "boolean" }, "deleted": { "type": "boolean" }, "createdBy": { "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time" }, "childResults": { "type": "array", "items": { "$ref": "#/components/schemas/SmartCheckResultModel" }, "nullable": true } }, "additionalProperties": false }, "SmartCheckResultModelCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SmartCheckResultModel" }, "nullable": true } }, "additionalProperties": false }, "SourceAggregateFunction": { "enum": [ "None", "Count", "Min", "Max", "Sum", "Avg", "First", "Last" ], "type": "string", "description": "Represents the source field mapping aggregate function enumeration." }, "SourceConsumedModelSettings": { "required": [ "modelId" ], "type": "object", "properties": { "modelId": { "type": "string", "description": "Unique identifier of the consumed data-model.", "format": "uuid" }, "includedSourceIds": { "type": "array", "items": { "type": "string" }, "description": "List of data-sources included to consumed data events (i.e. event filter).", "nullable": true }, "excludedSourceIds": { "type": "array", "items": { "type": "string" }, "description": "List of data-sources excluded from consumed data events (i.e. event filter).", "nullable": true }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-source consumed model settings.", "nullable": true } }, "additionalProperties": false, "description": "Represents a source consumed model settings contract." }, "SourceConsumerMessagesSettings": { "type": "object", "properties": { "rateLimit": { "type": "integer", "description": "Gets or sets the consumer rate limit. (null = no change)", "format": "int32", "nullable": true }, "rateLimitInterval": { "type": "string", "description": "Gets or sets the consumer rate limit interval (e.g. `Second`, `Minute`, `Hour`, `Day`). (null = no change, empty string = remove limit)", "nullable": true } }, "additionalProperties": false, "description": "Represents the source consumer messages settings contract." }, "SourceConsumerSettings": { "type": "object", "properties": { "settings": { "$ref": "#/components/schemas/SourceConsumerMessagesSettings" }, "enqueueDataStatus": { "type": "boolean", "description": "The flag to enable/disable 'ASOL.DataService.EnqueueDataStatusChanged' message type (null = no change).", "nullable": true }, "dataModelCustomPropertyStatus": { "type": "boolean", "description": "The flag to enable/disable 'ASOL.DataService.DataModelCustomPropertyChanged' message type (null = no change).", "nullable": true }, "integrationDataChanges": { "type": "boolean", "description": "The flag to enable/disable 'ASOL.DataService.IntegrationDataChanged' message type with multi-tenant filter (null = no change).", "nullable": true }, "integrationProfileStatus": { "type": "boolean", "description": "The flag to enable/disable 'ASOL.DataService.IntegrationProfileChangeStarted' and 'ASOL.DataService.IntegrationProfileChangeCompleted' message types (null = no change).", "nullable": true }, "dataRecordChanges": { "type": "boolean", "description": "The flag to enable/disable 'ASOL.DataService.RecordCreated', 'ASOL.DataService.RecordUpdated' and 'ASOL.DataService.RecordDeleted' message types with multi-tenant filter (null = no change).\nOBSOLETE - use IntegrationDataChanges instead.", "nullable": true, "deprecated": true }, "refreshSourceConfig": { "type": "boolean", "description": "The flag to enable/disable 'ASOL.DataService.RefreshSourceConfig' message type (null = no change).", "nullable": true }, "refreshSourceStatus": { "type": "boolean", "description": "The flag to enable/disable 'ASOL.DataService.RefreshSourceStatus' message type (null = no change).", "nullable": true }, "resetTenants": { "type": "boolean", "description": "The flag to replace(=true) all existing tenant filters or add/remove(=false) current tenant filter for message types with multi-tenant filter." } }, "additionalProperties": false, "description": "Represents a source consumer settings contract." }, "SourceEntityMapping": { "type": "object", "properties": { "entityMappingId": { "type": "string", "description": "Gets or sets the entity-mapping identifier.", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "priority": { "type": "integer", "description": "Gets or sets the model mapping priority (ascending order, default = 0).", "format": "int32" }, "entityOwnership": { "$ref": "#/components/schemas/SourceEntityOwnership" }, "modelId": { "type": "string", "format": "uuid", "nullable": true }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "nullable": true }, "transformationType": { "$ref": "#/components/schemas/SourceExternalIdTransformationType" }, "autoMapCommonFields": { "type": "boolean", "description": "Flag to define implicit field-mappings for common properties (for data-types supporting this feature)." }, "autoMapCustomFields": { "type": "boolean", "description": "Flag to define implicit field-mappings for custom properties (for data-types supporting this feature)." }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceFieldMapping" }, "description": "Explicit common field-mappings defined on the data-source model-mapping level.", "nullable": true }, "customMappings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceFieldMapping" }, "description": "Explicit custom field-mappings defined on the data-source model-mapping level.", "nullable": true }, "expressions": { "type": "array", "items": { "$ref": "#/components/schemas/SourceEntityMappingExpression" }, "description": "Expression fields defined on the data-source model mapping level.", "nullable": true }, "predicate": { "$ref": "#/components/schemas/SourceMappingPredicate" }, "isSupplementary": { "type": "boolean", "description": "Flag to determine if entity-model mapping is supplementary or primary. (default = false)", "deprecated": true }, "customProperties": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "description": "The additional custom properties of data-source entity mapping.", "nullable": true } }, "additionalProperties": false, "description": "Represents a source entity mapping contract." }, "SourceEntityMappingExpression": { "required": [ "fieldName" ], "type": "object", "properties": { "fieldName": { "minLength": 1, "type": "string", "description": "Field name." }, "value": { "type": "string", "description": "Expression syntax.", "nullable": true }, "predicate": { "type": "string", "description": "Predicate syntax.", "nullable": true }, "post": { "type": "boolean", "description": "Flag if expression is evaluated during pre-processing or post-processing of input row. (default: false)" } }, "additionalProperties": false, "description": "Represents a source entity mapping expression contract." }, "SourceEntityOwnership": { "type": "object", "properties": { "tenantIdColumnName": { "type": "string", "description": "Gets or sets the column-name of input-data representing TenantId.", "nullable": true }, "tenantIdIsRequired": { "type": "boolean", "description": "Gets or sets the flag if TenantId is required or optional (default)." }, "mandantCodeColumnName": { "type": "string", "description": "Gets or sets the column-name of input-data representing MandantCode.", "nullable": true }, "mandantCodeIsRequired": { "type": "boolean", "description": "Gets or sets the flag if MandantCode is required or optional (default)." } }, "additionalProperties": false, "description": "Represents a source entity tenant/mandant ownership contract." }, "SourceExternalIdTransformationType": { "enum": [ "Default", "Custom" ], "type": "string", "description": "Represents the source entity mapping transformation type enumeration." }, "SourceFieldMapping": { "required": [ "sourceFieldName", "targetFieldName" ], "type": "object", "properties": { "sourceFieldName": { "type": "string" }, "targetFieldName": { "minLength": 1, "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/StringObjectKeyValuePair" }, "nullable": true }, "transformationType": { "$ref": "#/components/schemas/SourceFieldTransformationType" }, "expression": { "$ref": "#/components/schemas/SourceFieldMappingExpression" }, "predicate": { "$ref": "#/components/schemas/SourceMappingPredicate" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/SourceEntityMapping" }, "description": "Get a collection of nested model mappings.", "nullable": true }, "aggregateFunction": { "$ref": "#/components/schemas/SourceAggregateFunction" } }, "additionalProperties": false, "description": "Represents a source field mapping contract." }, "SourceFieldMappingExpression": { "type": "object", "properties": { "value": { "type": "string", "description": "Expression syntax.", "nullable": true } }, "additionalProperties": false, "description": "Represents a source field mapping expression contract." }, "SourceFieldTransformationType": { "enum": [ "Default", "NestedMapping", "Expression", "NestedObjectMapping" ], "type": "string", "description": "Represents the source field mapping transformation type enumeration." }, "SourceIntegrationSettings": { "type": "object", "properties": { "applicationCode": { "type": "string", "description": "The code of integrated-application (empty = clear, null = skip).", "nullable": true }, "clientId": { "type": "string", "description": "The client identifier (empty = clear, null = skip).", "nullable": true }, "consumerCode": { "type": "string", "description": "The consumerCode of MessageGateway assigned to data-source (empty = clear, null = skip).", "nullable": true }, "consumerType": { "$ref": "#/components/schemas/MessageGatewayClientType" }, "consumerWebhookUrl": { "type": "string", "description": "The web-hook URL assigned to data-source (empty = clear, null = skip).", "nullable": true }, "useIntegrationProfile": { "type": "boolean", "description": "The flag if integration profile is used or not (false = legacy behavior).", "nullable": true }, "useConsumerSettings": { "type": "boolean", "description": "The flag if legacy consumer settings is used when integration profile isn't used.", "nullable": true } }, "additionalProperties": false, "description": "Represents a source integration settings contract." }, "SourceMappingPredicate": { "type": "object", "properties": { "value": { "type": "string", "description": "Predicate syntax.", "nullable": true } }, "additionalProperties": false, "description": "Represents a source mapping predicate contract." }, "StatisticModel": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "mean": { "type": "number", "format": "double" }, "variance": { "type": "number", "format": "double" }, "stdDev": { "type": "number", "format": "double" }, "min": { "type": "number", "format": "double" }, "max": { "type": "number", "format": "double" }, "median": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "The statistics model" }, "StatusSeverity": { "enum": [ "Info", "Warning", "Error" ], "type": "string", "description": "Represents the status severity enumeration." }, "StringLengthDataModelFieldDefinitionValidation": { "required": [ "length" ], "type": "object", "properties": { "validation": { "type": "string", "description": "Discriminator: \"StringLength\"", "nullable": true, "example": "StringLength" }, "length": { "type": "integer", "description": "Length: Specifies the exact required number of characters for the text input.", "format": "int32", "example": 5 } }, "additionalProperties": false, "description": "Represents a validation that ensures a string field value has an exact length.\nThis validation is suitable for fields with text-based data types.\n \nSupported data model field types:\n- Text\n- MultilineText" }, "StringLocalizedValue": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/StringLocalizedValueItem" }, "nullable": true } }, "additionalProperties": false }, "StringLocalizedValueItem": { "type": "object", "properties": { "locale": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringMaxLengthDataModelFieldDefinitionValidation": { "required": [ "maxLength" ], "type": "object", "properties": { "validation": { "type": "string", "description": "Discriminator: \"StringMaxLength\"", "nullable": true, "example": "StringMaxLength" }, "maxLength": { "type": "integer", "description": "MaxLength: Specifies the maximum number of characters allowed for a text input.", "format": "int32", "example": 10 } }, "additionalProperties": false, "description": "Represents a validation that ensures a string field value is not longer than a specified maximum length.\nThis validation is suitable for fields with text-based data types.\n \nSupported data model field types:\n- Text\n- MultilineText" }, "StringMinLengthDataModelFieldDefinitionValidation": { "required": [ "minLength" ], "type": "object", "properties": { "validation": { "type": "string", "description": "Discriminator: \"StringMinLength\"", "nullable": true, "example": "StringMinLength" }, "minLength": { "type": "integer", "description": "MinLength: Specifies the minimum number of characters required for a text input.", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Represents a validation that ensures a string field value is not shorter than a specified minimum length.\nThis validation is suitable for fields with text-based data types.\n \nSupported data model field types:\n- Text\n- MultilineText" }, "StringObjectKeyValuePair": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "StringRangeLengthDataModelFieldDefinitionValidation": { "required": [ "maxLength", "minLength" ], "type": "object", "properties": { "validation": { "type": "string", "description": "Discriminator: \"StringRangeLength\"", "nullable": true, "example": "StringRangeLength" }, "minLength": { "type": "integer", "description": "MinLength: Specifies the minimum allowed length for a text input.", "format": "int32", "example": 1 }, "maxLength": { "type": "integer", "description": "MaxLength: Specifies the maximum length allowed for a text input.", "format": "int32", "example": 10 } }, "additionalProperties": false, "description": "Represents a validation that ensures a string field value length falls within a specified range.\nThis validation is suitable for fields with text-based data types.\n \nSupported data model field types:\n- Text\n- MultilineText" }, "SupportedFeature": { "type": "object", "properties": { "codeOrId": { "type": "string", "description": "The integration-feature code or identifier.", "nullable": true }, "applicationUsage": { "$ref": "#/components/schemas/IntegrationFeatureAppUsage" } }, "additionalProperties": false }, "SupportedFeatureModel": { "type": "object", "properties": { "applicationUsage": { "$ref": "#/components/schemas/IntegrationFeatureAppUsage" }, "featureUsage": { "$ref": "#/components/schemas/IntegrationFeatureAppUsage" }, "featureId": { "type": "string", "description": "The integration-feature identifier.", "nullable": true }, "feature": { "$ref": "#/components/schemas/IntegrationFeatureReference" } }, "additionalProperties": false }, "TenantApplicationUsage": { "type": "object", "properties": { "tenantId": { "type": "string", "description": "The tenant identifier", "nullable": true }, "tenantName": { "type": "string", "description": "The tenant name", "nullable": true }, "ownerOrgId": { "type": "string", "description": "The id of tenant owner organization", "nullable": true }, "ownerOrgCode": { "type": "string", "description": "The code of tenant owner organization", "nullable": true }, "ownerOrgName": { "type": "string", "description": "The name of tenant owner organization", "nullable": true } }, "additionalProperties": false }, "TenantApplicationUsageCollectionResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TenantApplicationUsage" }, "nullable": true } }, "additionalProperties": false }, "ValidationRuleDefinitionModel": { "type": "object", "properties": { "modelCodeOrId": { "type": "string", "description": "Represents the model code or identifier associated with the validation rule.", "nullable": true }, "propertyCode": { "type": "string", "description": "Represents the code or identifier of the property being validated.", "nullable": true }, "propertyValidator": { "type": "string", "description": "Specifies the property validator for a property defined by PropertyCode.", "nullable": true }, "expressionValidator": { "type": "string", "description": "Specifies the expression validation for model.", "nullable": true } }, "additionalProperties": false }, "ValidationRuleModel": { "type": "object", "properties": { "modelCodeOrId": { "type": "string", "description": "Represents the model code or identifier associated with the validation rule.", "nullable": true }, "propertyCode": { "type": "string", "description": "Represents the code or identifier of the property being validated.", "nullable": true }, "propertyValidator": { "type": "string", "description": "Specifies the property validator for a property defined by PropertyCode.", "nullable": true }, "expressionValidator": { "type": "string", "description": "Specifies the expression validation for model.", "nullable": true } }, "additionalProperties": false }, "VerifiedDataObjectModel": { "type": "object", "properties": { "validationResult": { "$ref": "#/components/schemas/IntegrationFeatureRulesValidationResultModel" }, "result": { "description": "Represents a data object record model used to store key-value pairs representing the fields of a data object, along with its unique identifier.", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "password": { "authorizationUrl": "https://demo.avaplace.com/api/asol/idp/connect/authorize", "tokenUrl": "https://demo.avaplace.com/api/asol/idp/connect/token", "refreshUrl": "https://demo.avaplace.com/api/asol/idp/connect/token", "scopes": { "apiim": "" } } } } } } }