{ "openapi": "3.0.4", "info": { "title": "buzzle Digital Commerce Services Layer — DataBridge", "description": "OpenAPI surface for module `DataBridge` within the buzzle Digital Commerce Services Layer.", "contact": { "name": "bambit ag", "url": "https://bambit.ch", "email": "hello@bambit.ch" }, "version": "1.0" }, "servers": [ { "url": "/databridge" } ], "paths": { "/api/DataQueue": { "get": { "tags": [ "DataQueueAdminDataSource" ], "description": "Executes action ListQueues in the DataSource DataQueueAdminDataSource with the given parameters.", "operationId": "/api/DataQueue::List data queues", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/DataQueue/{queueName}": { "get": { "tags": [ "DataQueueAdminDataSource" ], "description": "Executes action ListItems in the DataSource DataQueueAdminDataSource with the given parameters.", "operationId": "/api/DataQueue/{queueName}::List data queue items", "parameters": [ { "name": "queueName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PagedResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/DataQueue/{queueName}/{itemId}": { "get": { "tags": [ "DataQueueAdminDataSource" ], "description": "Executes action GetItem in the DataSource DataQueueAdminDataSource with the given parameters.", "operationId": "/api/DataQueue/{queueName}/{itemId}::Get data queue item", "parameters": [ { "name": "queueName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } }, "delete": { "tags": [ "DataQueueAdminDataSource" ], "description": "Executes action DeleteItem in the DataSource DataQueueAdminDataSource with the given parameters.", "operationId": "/api/DataQueue/{queueName}/{itemId}::Delete data queue item", "parameters": [ { "name": "queueName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/DataQueue/{queueName}/{itemId}/requeue": { "post": { "tags": [ "DataQueueAdminDataSource" ], "description": "Executes action RequeueItem in the DataSource DataQueueAdminDataSource with the given parameters.", "operationId": "/api/DataQueue/{queueName}/{itemId}/requeue::Requeue data queue item", "parameters": [ { "name": "queueName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/DataQueue/{queueName}/clear": { "post": { "tags": [ "DataQueueAdminDataSource" ], "description": "Executes action ClearQueue in the DataSource DataQueueAdminDataSource with the given parameters.", "operationId": "/api/DataQueue/{queueName}/clear::Clear data queue", "parameters": [ { "name": "queueName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/DataQueue/{queueName}/requeue-failed": { "post": { "tags": [ "DataQueueAdminDataSource" ], "description": "Executes action RequeueAllFailed in the DataSource DataQueueAdminDataSource with the given parameters.", "operationId": "/api/DataQueue/{queueName}/requeue-failed::Requeue all failed data queue items", "parameters": [ { "name": "queueName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/DataSources": { "get": { "tags": [ "DataSources" ], "description": "Get all data sources.", "operationId": "/api/DataSources::GetDataSources", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/Entities": { "get": { "tags": [ "Entities" ], "description": "Get all entity structures of this module with their names and label formats.", "operationId": "/api/Entities::Entities", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/RegistryOfCommerce/zefix/{uid}": { "get": { "tags": [ "RegistryOfCommerceDataSource" ], "description": "Executes action GetByUid in the DataSource RegistryOfCommerceDataSource with the given parameters.", "operationId": "/api/RegistryOfCommerce/zefix/{uid}::Get Zefix company by UID", "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel>" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/RegistryOfCommerce/zefix/query": { "get": { "tags": [ "RegistryOfCommerceDataSource" ], "description": "Executes action Query in the DataSource RegistryOfCommerceDataSource with the given parameters.", "operationId": "/api/RegistryOfCommerce/zefix/query::Query Zefix by name", "parameters": [ { "name": "searchByNameQuery", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includeInactive", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/Validators": { "get": { "tags": [ "Validators" ], "description": "Get all available validators.", "operationId": "/api/Validators::Validators", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } } } } }, "/api/workflows/definitions": { "get": { "tags": [ "WorkflowMonitoringDataSource" ], "description": "Executes action ListDefinitions in the DataSource WorkflowMonitoringDataSource with the given parameters.", "operationId": "/api/workflows/definitions::List workflow definitions", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/workflows/definitions/{definitionId}": { "get": { "tags": [ "WorkflowMonitoringDataSource" ], "description": "Executes action GetDefinition in the DataSource WorkflowMonitoringDataSource with the given parameters.", "operationId": "/api/workflows/definitions/{definitionId}::Get workflow definition", "parameters": [ { "name": "definitionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/workflows/definitions/{definitionId}/graph": { "get": { "tags": [ "WorkflowMonitoringDataSource" ], "description": "Executes action GetDefinitionGraph in the DataSource WorkflowMonitoringDataSource with the given parameters.", "operationId": "/api/workflows/definitions/{definitionId}/graph::Get workflow definition graph", "parameters": [ { "name": "definitionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/workflows/definitions/{definitionId}/logging/{enabled}": { "put": { "tags": [ "WorkflowMonitoringDataSource" ], "description": "Executes action SetDefinitionLogging in the DataSource WorkflowMonitoringDataSource with the given parameters.", "operationId": "/api/workflows/definitions/{definitionId}/logging/{enabled}::Set workflow definition logging", "parameters": [ { "name": "definitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enabled", "in": "path", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/workflows/logging": { "get": { "tags": [ "WorkflowMonitoringDataSource" ], "description": "Executes action GetLoggingState in the DataSource WorkflowMonitoringDataSource with the given parameters.", "operationId": "/api/workflows/logging::Get workflow logging state", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/workflows/logging/{enabled}": { "put": { "tags": [ "WorkflowMonitoringDataSource" ], "description": "Executes action SetGlobalLogging in the DataSource WorkflowMonitoringDataSource with the given parameters.", "operationId": "/api/workflows/logging/{enabled}::Set global workflow logging", "parameters": [ { "name": "enabled", "in": "path", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/workflows/runs": { "get": { "tags": [ "WorkflowMonitoringDataSource" ], "description": "Executes action ListRuns in the DataSource WorkflowMonitoringDataSource with the given parameters.", "operationId": "/api/workflows/runs::List workflow runs", "parameters": [ { "name": "definitionId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/workflows/runs/{instanceId}": { "get": { "tags": [ "WorkflowMonitoringDataSource" ], "description": "Executes action GetRun in the DataSource WorkflowMonitoringDataSource with the given parameters.", "operationId": "/api/workflows/runs/{instanceId}::Get workflow run", "parameters": [ { "name": "instanceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/workflows/runs/{instanceId}/journal": { "get": { "tags": [ "WorkflowMonitoringDataSource" ], "description": "Executes action GetRunJournal in the DataSource WorkflowMonitoringDataSource with the given parameters.", "operationId": "/api/workflows/runs/{instanceId}/journal::Get workflow run journal", "parameters": [ { "name": "instanceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ApiResultModel" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.NotFoundApiResultModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/import/catalog/products": { "post": { "tags": [ "Workflow Endpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Catalog.CatalogProductImportModel" } } }, "required": true }, "responses": { } } } }, "components": { "schemas": { "Buzzle.Module.Abstractions.Business.Enums.LegalForm": { "enum": [ "Ag", "Gmbh", "SoleProprietorship", "GeneralPartnership", "LimitedPartnership", "Cooperative", "Association", "Foundation", "Other" ], "type": "string" }, "Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceAddressModel": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "houseNumber": { "type": "string", "nullable": true }, "addon": { "type": "string", "nullable": true }, "poBox": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceAuditorModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "seat": { "type": "string", "nullable": true }, "deletionDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceCompanyDetailModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "uid": { "type": "string", "nullable": true }, "commercialRegisterNumber": { "type": "string", "nullable": true }, "ehraId": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceCompanyStatus" }, "legalFormShortName": { "type": "object", "additionalProperties": { "type": "string", "example": "Localized Text" }, "nullable": true, "example": { "de-CH": "Beispieltext", "fr-CH": "Exemple de texte", "it-CH": "Esempio di testo", "en-US": "Example text" } }, "legalFormFullName": { "type": "object", "additionalProperties": { "type": "string", "example": "Localized Text" }, "nullable": true, "example": { "de-CH": "Beispieltext", "fr-CH": "Exemple de texte", "it-CH": "Esempio di testo", "en-US": "Example text" } }, "legalSeat": { "type": "string", "nullable": true }, "canton": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceAddressModel" }, "purpose": { "type": "string", "nullable": true }, "capitalNominal": { "type": "number", "format": "double", "nullable": true }, "capitalCurrency": { "type": "string", "nullable": true }, "auditor": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceAuditorModel" }, "links": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceLinksModel" }, "fetchedAt": { "type": "string", "description": "When this live snapshot was fetched from the registry.", "format": "date-time" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceHistoryEntryModel" }, "nullable": true } }, "additionalProperties": false, "description": "Registry-agnostic \"current state\" of a company's commercial-register entry, as shown on the company detail\npage's \"Aktuell in Zefix\"-style tab. Each registry provider (e.g. Zefix) converts its own raw response into this\nstable shape via its own detail converter (see !:Buzzle.ServicePlatform.Module.DataBridge.Features.RegistryOfCommerce.Managers.ZefixRegistryOfCommerceModelsConverter), so the\ndetail page renders identically regardless of which registry supplied the data." }, "Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceCompanyResultModel": { "type": "object", "properties": { "companyModel": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Business.CompanyModel" }, "originalRegistryCompany": { "nullable": true }, "detailModel": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceCompanyDetailModel" } }, "additionalProperties": false, "description": "Payload of !:Managers.IRegistryOfCommerceProvider.GetByUid, carrying the converted\n next to the original, unconverted response returned by the registry\n(e.g. a `ZefixCompanyFull`), so callers can access registry-specific data that isn't mapped onto\n, plus the registry-agnostic Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceCompanyDetailModel used\nby the company detail page." }, "Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceCompanyStatus": { "enum": [ "Unknown", "Active", "Deleted", "InLiquidation" ], "type": "string" }, "Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceHistoryEntryModel": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "nullable": true }, "mutationTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceMutationType" }, "nullable": true }, "message": { "type": "string", "nullable": true }, "reference": { "type": "string", "description": "Human-readable publication reference, e.g. \"SHAB 1006351095\".", "nullable": true }, "referenceUrl": { "type": "string", "description": "Link to the publication, if the registry supplies one. Null when no such URL is known.", "nullable": true } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceLinksModel": { "type": "object", "properties": { "registryDetailUrl": { "type": "object", "additionalProperties": { "type": "string", "example": "Localized Text" }, "description": "Direct link to the company's page on the registry's own site (e.g. Zefix). Null if not supplied by the registry.", "nullable": true, "example": { "de-CH": "Beispieltext", "fr-CH": "Exemple de texte", "it-CH": "Esempio di testo", "en-US": "Example text" } }, "cantonalExcerptUrl": { "type": "string", "description": "Direct link to the cantonal commercial-register excerpt. Null if not supplied by the registry.", "nullable": true } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceMutationType": { "enum": [ "Unknown", "OrgansChanged", "AddressChanged", "PurposeChanged", "StatusChanged", "NewlyRegistered", "Dissolved", "LiquidationRegistered", "Deleted", "BankruptcyDissolution", "LiquidationRevoked", "NameChanged", "CapitalChanged", "ShareDenominationChanged", "PaidUpCapitalChanged", "NominalCapitalChanged", "LegalFormChanged", "CapitalBandChanged", "AssetTransfer", "Demerger", "Merger" ], "type": "string", "description": "The fixed, known set of commercial-register mutation types the detail page can display. Registry-specific raw\ncodes (e.g. Zefix's \"kapitalaenderung\") are mapped onto this enum by each registry's detail converter\n(e.g. !:Buzzle.ServicePlatform.Module.DataBridge.Features.RegistryOfCommerce.Managers.ZefixRegistryOfCommerceModelsConverter) so the frontend never has to interpret a raw,\nregistry-specific vocabulary directly - unrecognized codes collapse to Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceMutationType.Unknown." }, "Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceQueryResultModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "legalSeat": { "type": "string", "nullable": true }, "detailUrl": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceCompanyStatus" } }, "additionalProperties": false }, "Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Enums.WorkflowRunStatus": { "enum": [ "Running", "Finished" ], "type": "string", "description": "Stable contract mirror of Elsa's workflow status, decoupled from the Elsa types so the\nabstraction package carries no workflow-engine dependency." }, "Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Enums.WorkflowRunSubStatus": { "enum": [ "Pending", "Executing", "Suspended", "Finished", "Cancelled", "Faulted" ], "type": "string", "description": "Stable contract mirror of Elsa's workflow sub-status, decoupled from the Elsa types." }, "Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowActivitySettingModel": { "type": "object", "properties": { "name": { "type": "string", "description": "The input's display name (falls back to its technical name).", "nullable": true }, "value": { "type": "string", "description": "The configured literal value, trimmed and truncated for display.", "nullable": true } }, "additionalProperties": false, "description": "A single configured (literal) input of an activity in the workflow definition — its display name and\na short, human-readable value. Only literals are surfaced; expression- or delegate-bound inputs are\nomitted (they carry no display value)." }, "Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowDefinitionDetailModel": { "type": "object", "properties": { "definitionVersionId": { "type": "string", "description": "The specific published definition-version id.", "nullable": true }, "isLatest": { "type": "boolean", "description": "Whether this is the latest version." }, "createdAt": { "type": "string", "description": "When the definition version was created.", "format": "date-time" }, "providerName": { "type": "string", "description": "The provider that supplied the definition (e.g. the code-based workflow provider).", "nullable": true }, "triggerKind": { "type": "string", "description": "How the workflow is triggered: \"HttpEndpoint\", \"Cron\", \"Timer\" or \"None\".", "nullable": true }, "triggerDetail": { "type": "string", "description": "Trigger detail: for HTTP endpoints the \"METHOD /path\", for cron the expression, otherwise null.", "nullable": true }, "variableNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the workflow variables.", "nullable": true }, "inputNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the workflow inputs.", "nullable": true }, "outputNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the workflow outputs.", "nullable": true }, "definitionId": { "type": "string", "description": "The stable definition id (shared across all versions of the workflow).", "nullable": true }, "name": { "type": "string", "description": "Human readable workflow name.", "nullable": true }, "version": { "type": "integer", "description": "Published version number.", "format": "int32" }, "isPublished": { "type": "boolean", "description": "Whether a published version exists." }, "description": { "type": "string", "description": "Optional workflow description.", "nullable": true }, "totalRuns": { "type": "integer", "description": "Total number of recorded runs (instances) for this definition.", "format": "int32" }, "faultedRuns": { "type": "integer", "description": "Number of runs that ended faulted.", "format": "int32" }, "runningRuns": { "type": "integer", "description": "Number of runs currently running.", "format": "int32" }, "finishedRuns": { "type": "integer", "description": "Number of runs that finished successfully.", "format": "int32" }, "lastRunAt": { "type": "string", "description": "Timestamp of the most recent run, if any.", "format": "date-time", "nullable": true }, "lastRunSubStatus": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Enums.WorkflowRunSubStatus" }, "loggingEnabled": { "type": "boolean", "description": "Whether verbose execution-log persistence is currently enabled for this definition." } }, "additionalProperties": false, "description": "Detailed view of a single registered workflow definition — everything extractable from the Elsa\nmanagement store for the workflow — on top of the aggregated run statistics." }, "Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowDefinitionSummaryModel": { "type": "object", "properties": { "definitionId": { "type": "string", "description": "The stable definition id (shared across all versions of the workflow).", "nullable": true }, "name": { "type": "string", "description": "Human readable workflow name.", "nullable": true }, "version": { "type": "integer", "description": "Published version number.", "format": "int32" }, "isPublished": { "type": "boolean", "description": "Whether a published version exists." }, "description": { "type": "string", "description": "Optional workflow description.", "nullable": true }, "totalRuns": { "type": "integer", "description": "Total number of recorded runs (instances) for this definition.", "format": "int32" }, "faultedRuns": { "type": "integer", "description": "Number of runs that ended faulted.", "format": "int32" }, "runningRuns": { "type": "integer", "description": "Number of runs currently running.", "format": "int32" }, "finishedRuns": { "type": "integer", "description": "Number of runs that finished successfully.", "format": "int32" }, "lastRunAt": { "type": "string", "description": "Timestamp of the most recent run, if any.", "format": "date-time", "nullable": true }, "lastRunSubStatus": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Enums.WorkflowRunSubStatus" }, "loggingEnabled": { "type": "boolean", "description": "Whether verbose execution-log persistence is currently enabled for this definition." } }, "additionalProperties": false, "description": "Overview of a registered (published) Elsa workflow definition together with aggregated run statistics." }, "Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowGraphModel": { "type": "object", "properties": { "definitionId": { "type": "string", "description": "The definition this graph belongs to.", "nullable": true }, "version": { "type": "integer", "description": "The published definition version the graph was built from.", "format": "int32" }, "root": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowGraphNodeModel" } }, "additionalProperties": false, "description": "The activity graph of a single published workflow definition: its root activity node and the tree of\nembedded activities below it. Read-only; used to render the workflow definition graphically." }, "Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowGraphNodeModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The activity id within the definition.", "nullable": true }, "name": { "type": "string", "description": "The activity's explicit name, when one was set in the definition; otherwise null.", "nullable": true }, "type": { "type": "string", "description": "The fully-qualified Elsa activity type (for example \"Elsa.Sequence\").", "nullable": true }, "label": { "type": "string", "description": "A human-friendly label: the explicit name when set, otherwise the short type name (the segment\nafter the last dot of Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowGraphNodeModel.Type).", "nullable": true }, "port": { "type": "string", "description": "The port this node hangs off its parent (for example \"Then\"/\"Else\" on an If, or \"Body\" on a\nWhile). Null for the plain ordered children of a container such as a Sequence.", "nullable": true }, "isTrigger": { "type": "boolean", "description": "Whether this activity can start the workflow (a trigger). Highlighted in the graph." }, "category": { "type": "string", "description": "The activity's category from its descriptor (e.g. \"Control Flow\", \"Primitives\"), if any.", "nullable": true }, "description": { "type": "string", "description": "The activity's descriptor description, shown as a tooltip. Null when none.", "nullable": true }, "reads": { "type": "array", "items": { "type": "string" }, "description": "Names of the workflow variables this activity reads (inputs bound directly to a variable).", "nullable": true }, "writes": { "type": "array", "items": { "type": "string" }, "description": "Names of the workflow variables this activity writes (outputs bound to a variable).", "nullable": true }, "settings": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowActivitySettingModel" }, "description": "The activity's configured literal inputs (name + short value), for display as badges.", "nullable": true }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowGraphNodeModel" }, "description": "The embedded child activities, in definition order.", "nullable": true } }, "additionalProperties": false, "description": "A node in the workflow-definition activity tree: a single activity together with the activities it\nembeds — the ordered steps of a container such as a Sequence, or the branches of a control-flow\nactivity such as an If. This is a read-only structural view used to render the workflow graphically;\nit carries no run-time state." }, "Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowJournalEntryModel": { "type": "object", "properties": { "sequence": { "type": "integer", "description": "Monotonic sequence used to order entries within the run.", "format": "int64" }, "timestamp": { "type": "string", "description": "When the entry was recorded.", "format": "date-time" }, "source": { "type": "string", "description": "Source of the entry: \"Activity\" or \"Log\".", "nullable": true }, "activityId": { "type": "string", "description": "Id of the related activity.", "nullable": true }, "activityName": { "type": "string", "description": "Name of the related activity.", "nullable": true }, "activityType": { "type": "string", "description": "Type of the related activity.", "nullable": true }, "eventName": { "type": "string", "description": "Event name (e.g. \"Started\", \"Completed\", \"Faulted\") for log entries.", "nullable": true }, "status": { "type": "string", "description": "Activity status for activity-sourced entries.", "nullable": true }, "message": { "type": "string", "description": "Free-text message.", "nullable": true }, "isError": { "type": "boolean", "description": "Whether this entry represents an error/fault." }, "exceptionType": { "type": "string", "description": "Captured exception type, if any.", "nullable": true }, "exceptionMessage": { "type": "string", "description": "Captured exception message, if any.", "nullable": true }, "stackTrace": { "type": "string", "description": "Captured stack trace, if any.", "nullable": true }, "inputs": { "type": "string", "description": "Activity input values as formatted JSON (only populated for activity entries when verbose logging\nis enabled for the workflow; otherwise null).", "nullable": true }, "outputs": { "type": "string", "description": "Activity output values as formatted JSON (only populated for activity entries when verbose logging\nis enabled for the workflow; otherwise null).", "nullable": true } }, "additionalProperties": false, "description": "A single chronological entry in a workflow run's journal. Entries originate either from the\nalways-persisted activity-execution records (\"Activity\") or from the verbose execution log\n(\"Log\"), which is only present when logging is enabled for the workflow." }, "Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowLoggingStateModel": { "type": "object", "properties": { "globalEnabled": { "type": "boolean", "description": "When true, verbose execution logs are persisted for every workflow." }, "enabledDefinitionIds": { "type": "array", "items": { "type": "string" }, "description": "Definition ids for which verbose execution logs are persisted (in addition to global).", "nullable": true } }, "additionalProperties": false, "description": "Current state of the runtime verbose execution-log persistence switch. The state is held in\nmemory and resets to its configured defaults when the service restarts." }, "Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowRunDetailModel": { "type": "object", "properties": { "incidents": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowRunIncidentModel" }, "description": "Faults/incidents recorded for the run.", "nullable": true }, "instanceId": { "type": "string", "description": "The workflow instance id.", "nullable": true }, "definitionId": { "type": "string", "description": "The definition id this run belongs to.", "nullable": true }, "definitionVersionId": { "type": "string", "description": "The specific definition version id this run executed.", "nullable": true }, "version": { "type": "integer", "description": "The definition version number this run executed.", "format": "int32" }, "name": { "type": "string", "description": "Optional instance name.", "nullable": true }, "correlationId": { "type": "string", "description": "Correlation id, if the run was correlated.", "nullable": true }, "status": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Enums.WorkflowRunStatus" }, "subStatus": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Enums.WorkflowRunSubStatus" }, "createdAt": { "type": "string", "description": "When the run was created.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "When the run was last updated.", "format": "date-time" }, "finishedAt": { "type": "string", "description": "When the run finished, if it has.", "format": "date-time", "nullable": true }, "incidentCount": { "type": "integer", "description": "Number of incidents (faults) recorded during the run.", "format": "int32" }, "hasFault": { "type": "boolean", "description": "Whether the run ended (or is) faulted." }, "verboseLogged": { "type": "boolean", "description": "Whether this run captured verbose/detailed logging (i.e. it persisted execution-log records,\nwhich the verbose sink only writes when logging was enabled for its definition at run time).\nReflects what was actually captured for this historical run, not the current toggle state." } }, "additionalProperties": false, "description": "Detailed view of a single workflow run, including the incidents recorded for it." }, "Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowRunIncidentModel": { "type": "object", "properties": { "activityId": { "type": "string", "description": "Id of the activity that faulted.", "nullable": true }, "activityType": { "type": "string", "description": "Type of the activity that faulted.", "nullable": true }, "message": { "type": "string", "description": "Incident message.", "nullable": true }, "exceptionType": { "type": "string", "description": "The exception type name, if captured.", "nullable": true }, "exceptionMessage": { "type": "string", "description": "The exception message, if captured.", "nullable": true }, "stackTrace": { "type": "string", "description": "The exception stack trace, if captured.", "nullable": true }, "timestamp": { "type": "string", "description": "When the incident occurred, if known.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A fault/incident that occurred while executing a workflow run." }, "Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowRunSummaryModel": { "type": "object", "properties": { "instanceId": { "type": "string", "description": "The workflow instance id.", "nullable": true }, "definitionId": { "type": "string", "description": "The definition id this run belongs to.", "nullable": true }, "definitionVersionId": { "type": "string", "description": "The specific definition version id this run executed.", "nullable": true }, "version": { "type": "integer", "description": "The definition version number this run executed.", "format": "int32" }, "name": { "type": "string", "description": "Optional instance name.", "nullable": true }, "correlationId": { "type": "string", "description": "Correlation id, if the run was correlated.", "nullable": true }, "status": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Enums.WorkflowRunStatus" }, "subStatus": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Enums.WorkflowRunSubStatus" }, "createdAt": { "type": "string", "description": "When the run was created.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "When the run was last updated.", "format": "date-time" }, "finishedAt": { "type": "string", "description": "When the run finished, if it has.", "format": "date-time", "nullable": true }, "incidentCount": { "type": "integer", "description": "Number of incidents (faults) recorded during the run.", "format": "int32" }, "hasFault": { "type": "boolean", "description": "Whether the run ended (or is) faulted." }, "verboseLogged": { "type": "boolean", "description": "Whether this run captured verbose/detailed logging (i.e. it persisted execution-log records,\nwhich the verbose sink only writes when logging was enabled for its definition at run time).\nReflects what was actually captured for this historical run, not the current toggle state." } }, "additionalProperties": false, "description": "Summary of a single workflow run (Elsa workflow instance)." }, "Buzzle.ServicePlatform.Infrastructure.Features.AttributeSystem.Validation.Models.ValidatorDefinitionModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "typeDiscriminator": { "type": "string", "nullable": true }, "settings": { "type": "object", "additionalProperties": { }, "nullable": true }, "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.ServicePlatform.Infrastructure.Features.DataSource.Models.DataSourceDefinitionModel": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "providerName": { "type": "object", "additionalProperties": { "type": "string", "example": "Localized Text" }, "nullable": true, "example": { "de-CH": "Beispieltext", "fr-CH": "Exemple de texte", "it-CH": "Esempio di testo", "en-US": "Example text" } }, "dataSourceName": { "type": "object", "additionalProperties": { "type": "string", "example": "Localized Text" }, "nullable": true, "example": { "de-CH": "Beispieltext", "fr-CH": "Exemple de texte", "it-CH": "Esempio di testo", "en-US": "Example text" } }, "actionName": { "type": "object", "additionalProperties": { "type": "string", "example": "Localized Text" }, "nullable": true, "example": { "de-CH": "Beispieltext", "fr-CH": "Exemple de texte", "it-CH": "Esempio di testo", "en-US": "Example text" } }, "providerTypeDiscriminator": { "type": "string", "nullable": true }, "dataSourceTypeDiscriminator": { "type": "string", "nullable": true }, "actionDiscriminator": { "type": "string", "nullable": true }, "configuration": { "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ApiResultModel": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.EntityDescriptionModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "The technical name, e.g. `PersonAddress`.", "nullable": true }, "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { }, "nullable": true }, "description": "Display name per culture — \"Adresse\" rather than \"PersonAddress\".", "nullable": true }, "labelFormat": { "type": "string", "description": "How a record of this structure is labelled, e.g. `{Street} {HouseNumber}, {ZipCode} {City}`.", "nullable": true }, "businessDomainName": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "What an entity structure is called and how a record of it is labelled." }, "Buzzle.Shared.Models.AttributeSystem.ValueStatus": { "enum": [ "New", "Ok", "HaveOpenChangeRequests", "HavePendingChangeRequests" ], "type": "string" }, "Buzzle.Shared.Models.DataQueue.QueueItemDetailModel": { "type": "object", "properties": { "data": { "type": "string", "description": "The item payload as a JSON string. The client is responsible for pretty-printing it for display.", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.DataQueue.QueueItemErrorModel" }, "description": "The logged failures of this item, oldest first.", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "externalId": { "type": "string", "nullable": true }, "typeDiscriminator": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "retryCount": { "type": "integer", "format": "int32" }, "failed": { "type": "boolean" }, "errorCount": { "type": "integer", "description": "Number of logged failures for this item.", "format": "int32" }, "lastErrorReason": { "type": "string", "description": "Reason of the most recent logged failure (`null` when the item has never failed).", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Administrative detail of a single data-queue item, including its raw JSON payload `Data` and the\nfull history of logged failures." }, "Buzzle.Shared.Models.DataQueue.QueueItemErrorModel": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "reason": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "description": "The stack trace of the failure (`null` when it did not originate from an exception).", "nullable": true } }, "additionalProperties": false, "description": "A single logged failure of a data-queue item: when it occurred and why." }, "Buzzle.Shared.Models.DataQueue.QueueItemSummaryModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "externalId": { "type": "string", "nullable": true }, "typeDiscriminator": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "retryCount": { "type": "integer", "format": "int32" }, "failed": { "type": "boolean" }, "errorCount": { "type": "integer", "description": "Number of logged failures for this item.", "format": "int32" }, "lastErrorReason": { "type": "string", "description": "Reason of the most recent logged failure (`null` when the item has never failed).", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Administrative summary of a single data-queue item (without its payload `Data`)." }, "Buzzle.Shared.Models.DataQueue.QueueSummaryModel": { "type": "object", "properties": { "queueName": { "type": "string", "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "failedCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Administrative summary of a single data queue: its name and item counts." }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceQueryResultModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowDefinitionSummaryModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowJournalEntryModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowRunSummaryModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.ServicePlatform.Infrastructure.Features.AttributeSystem.Validation.Models.ValidatorDefinitionModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.ServicePlatform.Infrastructure.Features.DataSource.Models.DataSourceDefinitionModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.EntityDescriptionModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.DataQueue.QueueSummaryModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.NotFoundApiResultModel": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid", "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.PagedResultModel": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalItems": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.DataQueue.QueueItemSummaryModel" }, "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.PermissionDeniedResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.SingleResultModel>": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.RegistryOfCommerce.Models.RegistryOfCommerceCompanyResultModel" }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.SingleResultModel": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowDefinitionDetailModel" }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.SingleResultModel": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowGraphModel" }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.SingleResultModel": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowLoggingStateModel" }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.SingleResultModel": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.DataBridge.WorkflowMonitoring.Models.WorkflowRunDetailModel" }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.SingleResultModel": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Buzzle.Shared.Models.DataQueue.QueueItemDetailModel" }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "validationMessages": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "nullable": true }, "validationCodes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "ExampleOnline.Shared.Models.Business.CompanyModel": { "type": "object", "properties": { "companyNumber": { "type": "string", "nullable": true }, "legalName": { "type": "string", "nullable": true }, "legalForm": { "$ref": "#/components/schemas/Buzzle.Module.Abstractions.Business.Enums.LegalForm" }, "uid": { "type": "string", "nullable": true }, "ehraId": { "type": "string", "nullable": true }, "chId": { "type": "string", "nullable": true }, "vatNumber": { "type": "string", "nullable": true }, "hasVat": { "type": "boolean" }, "commercialRegisterNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "addition": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid", "nullable": true }, "status": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ValueStatus" }, "relatedEntitiesWithRequiredActions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "created": { "type": "string", "format": "date-time", "nullable": true }, "updated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": { } }, "ExampleOnline.Shared.Models.Catalog.CatalogProductImportModel": { "type": "object", "properties": { "products": { "nullable": true }, "searchIndexDocuments": { "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Bearer Authentication token (using 'bearer ').", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "Workflow Endpoints", "description": "A collection of HTTP endpoints exposed by workflows" }, { "name": "DataQueueAdminDataSource", "description": "Endpoints exposed for data source DataQueueAdminDataSource from provider DataQueueAdminDataSourceProvider." }, { "name": "DataSources", "description": "Endpoints exposed for data source DataSources from provider DataSources." }, { "name": "Entities", "description": "Endpoints exposed for data source Entities from provider Entities." }, { "name": "RegistryOfCommerceDataSource", "description": "Endpoints exposed for data source RegistryOfCommerceDataSource from provider RegistryOfCommerceDataSourceProvider_CompanyModel." }, { "name": "Validators", "description": "Endpoints exposed for data source Validators from provider Validators." }, { "name": "WorkflowMonitoringDataSource", "description": "Endpoints exposed for data source WorkflowMonitoringDataSource from provider WorkflowMonitoringDataSourceProvider." } ] }