{ "openapi": "3.0.4", "info": { "title": "buzzle Digital Commerce Services Layer — Sales", "description": "OpenAPI surface for module `Sales` within the buzzle Digital Commerce Services Layer.", "contact": { "name": "bambit ag", "url": "https://bambit.ch", "email": "hello@bambit.ch" }, "version": "1.0" }, "servers": [ { "url": "/sales" } ], "paths": { "/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/Opportunity": { "get": { "tags": [ "Opportunity" ], "description": "Executes the Opportunity get-all-paged action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/Opportunity::GET EntityStructure OpportunityModel (/api/Opportunity)", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "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" } } } } } }, "post": { "tags": [ "Opportunity" ], "description": "Executes the Opportunity create action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/Opportunity::POST EntityStructure OpportunityModel (/api/Opportunity)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityModel" } } }, "required": true }, "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/Opportunity/{id}": { "get": { "tags": [ "Opportunity" ], "description": "Executes the Opportunity get action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/Opportunity/{id}::GET EntityStructure OpportunityModel (/api/Opportunity/{id})", "parameters": [ { "name": "id", "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" } } } } } }, "put": { "tags": [ "Opportunity" ], "description": "Executes the Opportunity update action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/Opportunity/{id}::PUT EntityStructure OpportunityModel (/api/Opportunity/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityModel" } } }, "required": true }, "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": [ "Opportunity" ], "description": "Executes the Opportunity delete action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/Opportunity/{id}::DELETE EntityStructure OpportunityModel (/api/Opportunity/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { } } }, "required": true }, "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/Opportunity/{id}/isdeletable": { "get": { "tags": [ "Opportunity" ], "description": "Executes the Opportunity is-deletable action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/Opportunity/{id}/isdeletable::GET EntityStructure OpportunityModel (/api/Opportunity/{id}/isdeletable)", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "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/Opportunity/all": { "get": { "tags": [ "Opportunity" ], "description": "Executes the Opportunity get-all action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/Opportunity/all::GET EntityStructure OpportunityModel (/api/Opportunity/all)", "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/Opportunity/definition": { "get": { "tags": [ "Opportunity" ], "description": "Executes the Opportunity definition action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/Opportunity/definition::GET EntityStructure OpportunityModel (/api/Opportunity/definition)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } } } } }, "/api/Opportunity/labels": { "post": { "tags": [ "Opportunity" ], "description": "Resolves the display labels of the given Opportunity records.", "operationId": "/api/Opportunity/labels::POST EntityStructure OpportunityModel (/api/Opportunity/labels)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.GetManyRequestModel" } } }, "required": true }, "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/Opportunity/many": { "post": { "tags": [ "Opportunity" ], "description": "Executes the Opportunity get-many action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/Opportunity/many::POST EntityStructure OpportunityModel (/api/Opportunity/many)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.GetManyRequestModel" } } }, "required": true }, "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/Opportunity/SearchIndex/recreate": { "post": { "tags": [ "Opportunity" ], "description": "Reindex the search-index for entity Opportunity.", "operationId": "/api/Opportunity/SearchIndex/recreate::Reindex Search-Index for entity Opportunity", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/Opportunity/validate": { "post": { "tags": [ "Opportunity" ], "description": "Executes the Opportunity validate action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/Opportunity/validate::POST EntityStructure OpportunityModel (/api/Opportunity/validate)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityModel" } } }, "required": true }, "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/OpportunityCompany": { "post": { "tags": [ "OpportunityCompany" ], "description": "Executes the OpportunityCompany create action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/OpportunityCompany::POST EntityStructure OpportunityCompanyModel (/api/OpportunityCompany)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityCompanyModel" } } }, "required": true }, "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/OpportunityCompany/{id}": { "delete": { "tags": [ "OpportunityCompany" ], "description": "Executes the OpportunityCompany delete action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/OpportunityCompany/{id}::DELETE EntityStructure OpportunityCompanyModel (/api/OpportunityCompany/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { } } }, "required": true }, "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/OpportunityCompany/definition": { "get": { "tags": [ "OpportunityCompany" ], "description": "Executes the OpportunityCompany definition action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/OpportunityCompany/definition::GET EntityStructure OpportunityCompanyModel (/api/OpportunityCompany/definition)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } } } } }, "/api/OpportunityCompany/fromopportunity/{opportunityId}/all": { "get": { "tags": [ "OpportunityCompany" ], "description": "Executes the OpportunityCompany get-all-related action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/OpportunityCompany/fromopportunity/{opportunityId}/all::GET EntityStructure OpportunityCompanyModel (/api/OpportunityCompany/fromopportunity/{opportunityId}/all)", "parameters": [ { "name": "opportunityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "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/OpportunityPerson": { "post": { "tags": [ "OpportunityPerson" ], "description": "Executes the OpportunityPerson create action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/OpportunityPerson::POST EntityStructure OpportunityPersonModel (/api/OpportunityPerson)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityPersonModel" } } }, "required": true }, "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/OpportunityPerson/{id}": { "put": { "tags": [ "OpportunityPerson" ], "description": "Executes the OpportunityPerson update action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/OpportunityPerson/{id}::PUT EntityStructure OpportunityPersonModel (/api/OpportunityPerson/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityPersonModel" } } }, "required": true }, "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": [ "OpportunityPerson" ], "description": "Executes the OpportunityPerson delete action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/OpportunityPerson/{id}::DELETE EntityStructure OpportunityPersonModel (/api/OpportunityPerson/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { } } }, "required": true }, "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/OpportunityPerson/definition": { "get": { "tags": [ "OpportunityPerson" ], "description": "Executes the OpportunityPerson definition action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/OpportunityPerson/definition::GET EntityStructure OpportunityPersonModel (/api/OpportunityPerson/definition)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } } } } }, "/api/OpportunityPerson/fromopportunity/{opportunityId}/all": { "get": { "tags": [ "OpportunityPerson" ], "description": "Executes the OpportunityPerson get-all-related action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/OpportunityPerson/fromopportunity/{opportunityId}/all::GET EntityStructure OpportunityPersonModel (/api/OpportunityPerson/fromopportunity/{opportunityId}/all)", "parameters": [ { "name": "opportunityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "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/OpportunityPerson/fromopportunitypersonfunction/{opportunityPersonFunctionId}/all": { "get": { "tags": [ "OpportunityPerson" ], "description": "Executes the OpportunityPerson get-all-related action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/OpportunityPerson/fromopportunitypersonfunction/{opportunityPersonFunctionId}/all::GET EntityStructure OpportunityPersonModel (/api/OpportunityPerson/fromopportunitypersonfunction/{opportunityPersonFunctionId}/all)", "parameters": [ { "name": "opportunityPersonFunctionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "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/OpportunityPersonFunction": { "get": { "tags": [ "OpportunityPersonFunction" ], "description": "Executes the OpportunityPersonFunction get-all-paged action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/OpportunityPersonFunction::GET EntityStructure OpportunityPersonFunctionModel (/api/OpportunityPersonFunction)", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "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" } } } } } }, "post": { "tags": [ "OpportunityPersonFunction" ], "description": "Executes the OpportunityPersonFunction create action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/OpportunityPersonFunction::POST EntityStructure OpportunityPersonFunctionModel (/api/OpportunityPersonFunction)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityPersonFunctionModel" } } }, "required": true }, "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/OpportunityPersonFunction/{id}": { "get": { "tags": [ "OpportunityPersonFunction" ], "description": "Executes the OpportunityPersonFunction get action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/OpportunityPersonFunction/{id}::GET EntityStructure OpportunityPersonFunctionModel (/api/OpportunityPersonFunction/{id})", "parameters": [ { "name": "id", "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" } } } } } }, "put": { "tags": [ "OpportunityPersonFunction" ], "description": "Executes the OpportunityPersonFunction update action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/OpportunityPersonFunction/{id}::PUT EntityStructure OpportunityPersonFunctionModel (/api/OpportunityPersonFunction/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityPersonFunctionModel" } } }, "required": true }, "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": [ "OpportunityPersonFunction" ], "description": "Executes the OpportunityPersonFunction delete action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/OpportunityPersonFunction/{id}::DELETE EntityStructure OpportunityPersonFunctionModel (/api/OpportunityPersonFunction/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { } } }, "required": true }, "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/OpportunityPersonFunction/{id}/isdeletable": { "get": { "tags": [ "OpportunityPersonFunction" ], "description": "Executes the OpportunityPersonFunction is-deletable action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/OpportunityPersonFunction/{id}/isdeletable::GET EntityStructure OpportunityPersonFunctionModel (/api/OpportunityPersonFunction/{id}/isdeletable)", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "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/OpportunityPersonFunction/all": { "get": { "tags": [ "OpportunityPersonFunction" ], "description": "Executes the OpportunityPersonFunction get-all action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/OpportunityPersonFunction/all::GET EntityStructure OpportunityPersonFunctionModel (/api/OpportunityPersonFunction/all)", "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/OpportunityPersonFunction/definition": { "get": { "tags": [ "OpportunityPersonFunction" ], "description": "Executes the OpportunityPersonFunction definition action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/OpportunityPersonFunction/definition::GET EntityStructure OpportunityPersonFunctionModel (/api/OpportunityPersonFunction/definition)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } } } } }, "/api/OpportunityPersonFunction/labels": { "post": { "tags": [ "OpportunityPersonFunction" ], "description": "Resolves the display labels of the given OpportunityPersonFunction records.", "operationId": "/api/OpportunityPersonFunction/labels::POST EntityStructure OpportunityPersonFunctionModel (/api/OpportunityPersonFunction/labels)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.GetManyRequestModel" } } }, "required": true }, "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/OpportunityPersonFunction/many": { "post": { "tags": [ "OpportunityPersonFunction" ], "description": "Executes the OpportunityPersonFunction get-many action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/OpportunityPersonFunction/many::POST EntityStructure OpportunityPersonFunctionModel (/api/OpportunityPersonFunction/many)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.GetManyRequestModel" } } }, "required": true }, "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/OpportunityPersonFunction/SearchIndex/recreate": { "post": { "tags": [ "OpportunityPersonFunction" ], "description": "Reindex the search-index for entity OpportunityPersonFunction.", "operationId": "/api/OpportunityPersonFunction/SearchIndex/recreate::Reindex Search-Index for entity OpportunityPersonFunction", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/OpportunityPersonFunction/validate": { "post": { "tags": [ "OpportunityPersonFunction" ], "description": "Executes the OpportunityPersonFunction validate action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/OpportunityPersonFunction/validate::POST EntityStructure OpportunityPersonFunctionModel (/api/OpportunityPersonFunction/validate)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityPersonFunctionModel" } } }, "required": true }, "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/PermissionSecurity/PermissionGroups": { "get": { "tags": [ "PermissionSecurity" ], "description": "Executes action get-all-permissiongroups in the DataSource PermissionSecurityDataSource with the given parameters.", "operationId": "/api/PermissionSecurity/PermissionGroups::Get all PermissionGroups", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.ListResultModel" } } } } } } }, "/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" } } } } } } } }, "components": { "schemas": { "BambitPlatform.Shared.Models.Sales.OpportunityCompanyModel": { "type": "object", "properties": { "opportunityId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "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": { } }, "BambitPlatform.Shared.Models.Sales.OpportunityModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "stage": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityStage" }, "source": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunitySource" }, "amount": { "type": "number", "format": "double", "nullable": true }, "expectedCloseDate": { "type": "string", "format": "date-time", "nullable": true }, "probability": { "type": "integer", "format": "int32", "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": { } }, "BambitPlatform.Shared.Models.Sales.OpportunityPersonFunctionModel": { "type": "object", "properties": { "name": { "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": { } }, "BambitPlatform.Shared.Models.Sales.OpportunityPersonModel": { "type": "object", "properties": { "opportunityId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "opportunityPersonFunctionId": { "type": "string", "format": "uuid", "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": { } }, "BambitPlatform.Shared.Models.Sales.OpportunitySource": { "enum": [ "Network", "Outbound", "Website", "Other", "Upselling" ], "type": "string" }, "BambitPlatform.Shared.Models.Sales.OpportunityStage": { "enum": [ "Unqualified", "Qualified", "QuoteRequestReceived", "QuoteSent", "Paused", "Irrelevant", "Lost", "Won" ], "type": "string" }, "Buzzle.ServicePlatform.Infrastructure.Features.AttributeSystem.Models.DeleteValidationResultModel": { "type": "object", "properties": { "isDeletable": { "type": "boolean", "readOnly": true }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "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.ServicePlatform.Shared.Models.PermissionSecurity.GroupPermissionModel": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "groupType": { "type": "string", "nullable": true }, "parameters": { "type": "array", "items": { "type": "string" }, "nullable": true }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "usedTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Buzzle.ServicePlatform.Shared.Models.PermissionSecurity.IPermissionGroupModel": { "type": "object", "properties": { "name": { "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" } }, "type": { "type": "string", "nullable": true }, "key": { "type": "string", "nullable": true }, "groupKey": { "type": "string", "nullable": true }, "permissions": { "$ref": "#/components/schemas/Buzzle.ServicePlatform.Shared.Models.PermissionSecurity.GroupPermissionModel" }, "configuration": { "type": "object", "additionalProperties": { }, "nullable": true }, "order": { "type": "integer", "format": "int32" }, "deactivatesGroupsWhenActive": { "type": "array", "items": { "type": "string" }, "nullable": true }, "deactivatesAllGroupsWhenActive": { "type": "boolean" } }, "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.ChangeRequestModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "userName": { "type": "string", "nullable": true }, "loginId": { "type": "string", "format": "uuid", "nullable": true }, "propertyName": { "type": "string", "nullable": true }, "originalValue": { "nullable": true }, "value": { "nullable": true }, "workflow": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestWorkflow" }, "status": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestStatus" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ChangeRequestSettings": { "type": "object", "properties": { "changeRequestsEnabled": { "type": "boolean", "nullable": true }, "workflow": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestWorkflow" } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ChangeRequestStatus": { "enum": [ "Open", "Approved", "Closed", "Declined", "Replaced" ], "type": "string" }, "Buzzle.Shared.Models.AttributeSystem.ChangeRequestWorkflow": { "enum": [ "Invalid", "RequestAcceptConfirm", "RequestAcceptOnly", "RequestEmailConfirmation" ], "type": "string" }, "Buzzle.Shared.Models.AttributeSystem.EntityDescriptionModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { }, "nullable": true }, "nullable": true }, "labelFormat": { "type": "string", "nullable": true }, "businessDomainName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.EntityLabelModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.EntityStructureModel": { "type": "object", "properties": { "labelFormat": { "type": "string", "nullable": true }, "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { }, "nullable": true }, "nullable": true }, "supportsChangeRequests": { "type": "boolean" }, "supportsNotes": { "type": "boolean" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.EntityStructurePropertyModel" }, "nullable": true }, "businessDomainName": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "haveRelations": { "type": "boolean" }, "foreignKeyPropertyNames": { "type": "array", "items": { "type": "string" }, "nullable": true }, "relationsCount": { "type": "integer", "format": "int32", "readOnly": true }, "haveChangeRequests": { "type": "boolean" }, "configuration": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.EntityStructurePropertyModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "attributeCode": { "type": "string", "nullable": true }, "attributeTypeDiscriminator": { "type": "string", "nullable": true }, "changeRequestSettings": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestSettings" }, "settings": { "type": "object", "additionalProperties": { }, "nullable": true }, "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { }, "nullable": true }, "nullable": true }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.GetManyRequestModel": { "type": "object", "properties": { "entityIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "errorWhenNotFound": { "type": "boolean" } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ValueModelWithChangeRequests": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityCompanyModel" }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestModel" }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ValueModelWithChangeRequests": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityModel" }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestModel" }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ValueModelWithChangeRequests": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityPersonFunctionModel" }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestModel" }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ValueModelWithChangeRequests": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityPersonModel" }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/Buzzle.Shared.Models.AttributeSystem.ChangeRequestModel" }, "nullable": true } }, "additionalProperties": false }, "Buzzle.Shared.Models.AttributeSystem.ValueStatus": { "enum": [ "New", "Ok", "HaveOpenChangeRequests", "HavePendingChangeRequests" ], "type": "string" }, "Buzzle.Shared.Models.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/BambitPlatform.Shared.Models.Sales.OpportunityCompanyModel" }, "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/BambitPlatform.Shared.Models.Sales.OpportunityModel" }, "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/BambitPlatform.Shared.Models.Sales.OpportunityPersonFunctionModel" }, "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/BambitPlatform.Shared.Models.Sales.OpportunityPersonModel" }, "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.Models.DeleteValidationResultModel" }, "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.ServicePlatform.Shared.Models.PermissionSecurity.IPermissionGroupModel" }, "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.AttributeSystem.EntityLabelModel" }, "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.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.Shared.Models.AttributeSystem.EntityStructureModel" }, "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.AttributeSystem.ValueModelWithChangeRequests" }, "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.AttributeSystem.ValueModelWithChangeRequests" }, "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.AttributeSystem.ValueModelWithChangeRequests" }, "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.AttributeSystem.ValueModelWithChangeRequests" }, "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 } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Bearer Authentication token (using 'bearer ').", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "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": "Opportunity", "description": "Endpoints exposed for data source Opportunity from provider EntityStructure." }, { "name": "Opportunity", "description": "Endpoints exposed for data source Opportunity from provider SearchIndexing." }, { "name": "OpportunityCompany", "description": "Endpoints exposed for data source OpportunityCompany from provider EntityStructure." }, { "name": "OpportunityPerson", "description": "Endpoints exposed for data source OpportunityPerson from provider EntityStructure." }, { "name": "OpportunityPersonFunction", "description": "Endpoints exposed for data source OpportunityPersonFunction from provider EntityStructure." }, { "name": "OpportunityPersonFunction", "description": "Endpoints exposed for data source OpportunityPersonFunction from provider SearchIndexing." }, { "name": "PermissionSecurity", "description": "Endpoints exposed for data source PermissionSecurity from provider PermissionSecurity." }, { "name": "Validators", "description": "Endpoints exposed for data source Validators from provider Validators." } ] }