{ "openapi": "3.0.4", "info": { "title": "buzzle Digital Commerce Services Layer — Work", "description": "OpenAPI surface for module `Work` within the buzzle Digital Commerce Services Layer.", "contact": { "name": "bambit ag", "url": "https://bambit.ch", "email": "hello@bambit.ch" }, "version": "1.0" }, "servers": [ { "url": "/work" } ], "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/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/Task": { "get": { "tags": [ "Task" ], "description": "Executes the Task get-all-paged action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/Task::GET EntityStructure TaskModel (/api/Task)", "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" } } } } } } }, "/api/Task/{id}": { "get": { "tags": [ "Task" ], "description": "Executes the Task get action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/Task/{id}::GET EntityStructure TaskModel (/api/Task/{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": [ "Task" ], "description": "Executes the Task update action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/Task/{id}::PUT EntityStructure TaskModel (/api/Task/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Work.TaskModel" } } }, "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": [ "Task" ], "description": "Executes the Task delete action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/Task/{id}::DELETE EntityStructure TaskModel (/api/Task/{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/Task/{id}/apply": { "post": { "tags": [ "TaskDataSource" ], "description": "Executes action ApplyTemplate in the DataSource TaskDataSource with the given parameters.", "operationId": "/api/Task/{id}/apply::Apply a task template", "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.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/Task/{id}/assignments": { "get": { "tags": [ "Task" ], "description": "Executes the Task get-assignments action on DataSource EntityAssignmentsDataSource.", "operationId": "/api/Task/{id}/assignments::GET EntityStructure TaskModel (/api/Task/{id}/assignments)", "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" } } } } } }, "post": { "tags": [ "Task" ], "description": "Executes the Task add-assignment action on DataSource EntityAssignmentsDataSource.", "operationId": "/api/Task/{id}/assignments::POST EntityStructure TaskModel (/api/Task/{id}/assignments)", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.Assignments.CreateAssignmentModel" } } }, "required": true }, "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/Task/{id}/assignments/{personId}": { "delete": { "tags": [ "Task" ], "description": "Executes the Task remove-assignment action on DataSource EntityAssignmentsDataSource.", "operationId": "/api/Task/{id}/assignments/{personId}::DELETE EntityStructure TaskModel (/api/Task/{id}/assignments/{personId})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "personId", "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.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/Task/{id}/cancel": { "post": { "tags": [ "TaskDataSource" ], "description": "Executes action Cancel in the DataSource TaskDataSource with the given parameters.", "operationId": "/api/Task/{id}/cancel::Cancel a task", "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.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/Task/{id}/delete": { "post": { "tags": [ "TaskDataSource" ], "description": "Executes action Delete in the DataSource TaskDataSource with the given parameters.", "operationId": "/api/Task/{id}/delete::Delete a task", "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.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/Task/{id}/labels": { "post": { "tags": [ "TaskDataSource" ], "description": "Executes action SetLabel in the DataSource TaskDataSource with the given parameters.", "operationId": "/api/Task/{id}/labels::Set a label of a task", "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.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/Task/{id}/order": { "post": { "tags": [ "TaskDataSource" ], "description": "Executes action Reorder in the DataSource TaskDataSource with the given parameters.", "operationId": "/api/Task/{id}/order::Reorder a task", "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.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/Task/{id}/state": { "post": { "tags": [ "TaskDataSource" ], "description": "Executes action SetState in the DataSource TaskDataSource with the given parameters.", "operationId": "/api/Task/{id}/state::Set the state of a task", "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.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/Task/configurations-for-entity/{ownerEntityName}": { "get": { "tags": [ "TaskDataSource" ], "description": "Executes action GetConfigurationsForEntity in the DataSource TaskDataSource with the given parameters.", "operationId": "/api/Task/configurations-for-entity/{ownerEntityName}::Get task types of an entity", "parameters": [ { "name": "ownerEntityName", "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" } } } } } } }, "/api/Task/definition": { "get": { "tags": [ "Task" ], "description": "Executes the Task definition action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/Task/definition::GET EntityStructure TaskModel (/api/Task/definition)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } } } } }, "/api/Task/for-entity/{ownerEntityName}/{ownerValueId}": { "get": { "tags": [ "TaskDataSource" ], "description": "Executes action GetForOwner in the DataSource TaskDataSource with the given parameters.", "operationId": "/api/Task/for-entity/{ownerEntityName}/{ownerValueId}::Get tasks of a record", "parameters": [ { "name": "ownerEntityName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ownerValueId", "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/Task/fromtask/{parentTaskId}/all": { "get": { "tags": [ "Task" ], "description": "Executes the Task get-all-related action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/Task/fromtask/{parentTaskId}/all::GET EntityStructure TaskModel (/api/Task/fromtask/{parentTaskId}/all)", "parameters": [ { "name": "parentTaskId", "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/Task/fromtaskconfiguration/{taskConfigurationId}/all": { "get": { "tags": [ "Task" ], "description": "Executes the Task get-all-related action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/Task/fromtaskconfiguration/{taskConfigurationId}/all::GET EntityStructure TaskModel (/api/Task/fromtaskconfiguration/{taskConfigurationId}/all)", "parameters": [ { "name": "taskConfigurationId", "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/Task/fromtaskgroup/{workflowStateId}/all": { "get": { "tags": [ "Task" ], "description": "Executes the Task get-all-related action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/Task/fromtaskgroup/{workflowStateId}/all::GET EntityStructure TaskModel (/api/Task/fromtaskgroup/{workflowStateId}/all)", "parameters": [ { "name": "workflowStateId", "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/Task/labels": { "post": { "tags": [ "Task" ], "description": "Resolves the display labels of the given Task records.", "operationId": "/api/Task/labels::POST EntityStructure TaskModel (/api/Task/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/Task/open": { "post": { "tags": [ "TaskDataSource" ], "description": "Executes action Open in the DataSource TaskDataSource with the given parameters.", "operationId": "/api/Task/open::Open a task", "requestBody": { "content": { "application/json": { "schema": { } } }, "required": true }, "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/Task/owner-entities": { "get": { "tags": [ "TaskDataSource" ], "description": "Executes action GetOwnerEntities in the DataSource TaskDataSource with the given parameters.", "operationId": "/api/Task/owner-entities::Get the entities that record work", "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/Task/SearchIndex/recreate": { "post": { "tags": [ "Task" ], "description": "Reindex the search-index for entity Task.", "operationId": "/api/Task/SearchIndex/recreate::Reindex Search-Index for entity Task", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/Task/templates": { "get": { "tags": [ "TaskDataSource" ], "description": "Executes action GetAllTemplates in the DataSource TaskDataSource with the given parameters.", "operationId": "/api/Task/templates::Get all task templates", "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/Task/templates-for-entity/{ownerEntityName}": { "get": { "tags": [ "TaskDataSource" ], "description": "Executes action GetTemplatesForEntity in the DataSource TaskDataSource with the given parameters.", "operationId": "/api/Task/templates-for-entity/{ownerEntityName}::Get task templates of an entity", "parameters": [ { "name": "ownerEntityName", "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" } } } } } } }, "/api/Task/validate": { "post": { "tags": [ "Task" ], "description": "Executes the Task validate action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/Task/validate::POST EntityStructure TaskModel (/api/Task/validate)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Work.TaskModel" } } }, "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/TaskConfiguration": { "get": { "tags": [ "TaskConfiguration" ], "description": "Executes the TaskConfiguration get-all-paged action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskConfiguration::GET EntityStructure TaskConfigurationModel (/api/TaskConfiguration)", "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": [ "TaskConfiguration" ], "description": "Executes the TaskConfiguration create action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskConfiguration::POST EntityStructure TaskConfigurationModel (/api/TaskConfiguration)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Work.TaskConfigurationModel" } } }, "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/TaskConfiguration/{id}": { "get": { "tags": [ "TaskConfiguration" ], "description": "Executes the TaskConfiguration get action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskConfiguration/{id}::GET EntityStructure TaskConfigurationModel (/api/TaskConfiguration/{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": [ "TaskConfiguration" ], "description": "Executes the TaskConfiguration update action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskConfiguration/{id}::PUT EntityStructure TaskConfigurationModel (/api/TaskConfiguration/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Work.TaskConfigurationModel" } } }, "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": [ "TaskConfiguration" ], "description": "Executes the TaskConfiguration delete action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskConfiguration/{id}::DELETE EntityStructure TaskConfigurationModel (/api/TaskConfiguration/{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/TaskConfiguration/definition": { "get": { "tags": [ "TaskConfiguration" ], "description": "Executes the TaskConfiguration definition action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskConfiguration/definition::GET EntityStructure TaskConfigurationModel (/api/TaskConfiguration/definition)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } } } } }, "/api/TaskConfiguration/fromtaskgroupingset/{workflowSetId}/all": { "get": { "tags": [ "TaskConfiguration" ], "description": "Executes the TaskConfiguration get-all-related action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskConfiguration/fromtaskgroupingset/{workflowSetId}/all::GET EntityStructure TaskConfigurationModel (/api/TaskConfiguration/fromtaskgroupingset/{workflowSetId}/all)", "parameters": [ { "name": "workflowSetId", "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/TaskConfiguration/labels": { "post": { "tags": [ "TaskConfiguration" ], "description": "Resolves the display labels of the given TaskConfiguration records.", "operationId": "/api/TaskConfiguration/labels::POST EntityStructure TaskConfigurationModel (/api/TaskConfiguration/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/TaskConfiguration/SearchIndex/recreate": { "post": { "tags": [ "TaskConfiguration" ], "description": "Reindex the search-index for entity TaskConfiguration.", "operationId": "/api/TaskConfiguration/SearchIndex/recreate::Reindex Search-Index for entity TaskConfiguration", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/TaskConfiguration/validate": { "post": { "tags": [ "TaskConfiguration" ], "description": "Executes the TaskConfiguration validate action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskConfiguration/validate::POST EntityStructure TaskConfigurationModel (/api/TaskConfiguration/validate)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Work.TaskConfigurationModel" } } }, "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/TaskGroup": { "post": { "tags": [ "TaskGroup" ], "description": "Executes the TaskGroup create action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskGroup::POST EntityStructure TaskGroupModel (/api/TaskGroup)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Work.TaskGroupModel" } } }, "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/TaskGroup/{id}": { "get": { "tags": [ "TaskGroup" ], "description": "Executes the TaskGroup get action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskGroup/{id}::GET EntityStructure TaskGroupModel (/api/TaskGroup/{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": [ "TaskGroup" ], "description": "Executes the TaskGroup update action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskGroup/{id}::PUT EntityStructure TaskGroupModel (/api/TaskGroup/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Work.TaskGroupModel" } } }, "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": [ "TaskGroup" ], "description": "Executes the TaskGroup delete action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskGroup/{id}::DELETE EntityStructure TaskGroupModel (/api/TaskGroup/{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/TaskGroup/definition": { "get": { "tags": [ "TaskGroup" ], "description": "Executes the TaskGroup definition action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskGroup/definition::GET EntityStructure TaskGroupModel (/api/TaskGroup/definition)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } } } } }, "/api/TaskGroup/fromtaskgroupingset/{taskGroupingSetId}/all": { "get": { "tags": [ "TaskGroup" ], "description": "Executes the TaskGroup get-all-related action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskGroup/fromtaskgroupingset/{taskGroupingSetId}/all::GET EntityStructure TaskGroupModel (/api/TaskGroup/fromtaskgroupingset/{taskGroupingSetId}/all)", "parameters": [ { "name": "taskGroupingSetId", "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/TaskGroup/labels": { "post": { "tags": [ "TaskGroup" ], "description": "Resolves the display labels of the given TaskGroup records.", "operationId": "/api/TaskGroup/labels::POST EntityStructure TaskGroupModel (/api/TaskGroup/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/TaskGroup/validate": { "post": { "tags": [ "TaskGroup" ], "description": "Executes the TaskGroup validate action on DataSource RelatedEntityStructureDataSource.", "operationId": "/api/TaskGroup/validate::POST EntityStructure TaskGroupModel (/api/TaskGroup/validate)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Work.TaskGroupModel" } } }, "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/TaskGroupingSet": { "get": { "tags": [ "TaskGroupingSet" ], "description": "Executes the TaskGroupingSet get-all-paged action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/TaskGroupingSet::GET EntityStructure TaskGroupingSetModel (/api/TaskGroupingSet)", "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": [ "TaskGroupingSet" ], "description": "Executes the TaskGroupingSet create action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/TaskGroupingSet::POST EntityStructure TaskGroupingSetModel (/api/TaskGroupingSet)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Work.TaskGroupingSetModel" } } }, "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/TaskGroupingSet/{id}": { "get": { "tags": [ "TaskGroupingSet" ], "description": "Executes the TaskGroupingSet get action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/TaskGroupingSet/{id}::GET EntityStructure TaskGroupingSetModel (/api/TaskGroupingSet/{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": [ "TaskGroupingSet" ], "description": "Executes the TaskGroupingSet update action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/TaskGroupingSet/{id}::PUT EntityStructure TaskGroupingSetModel (/api/TaskGroupingSet/{id})", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Work.TaskGroupingSetModel" } } }, "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": [ "TaskGroupingSet" ], "description": "Executes the TaskGroupingSet delete action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/TaskGroupingSet/{id}::DELETE EntityStructure TaskGroupingSetModel (/api/TaskGroupingSet/{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/TaskGroupingSet/all": { "get": { "tags": [ "TaskGroupingSet" ], "description": "Executes the TaskGroupingSet get-all action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/TaskGroupingSet/all::GET EntityStructure TaskGroupingSetModel (/api/TaskGroupingSet/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/TaskGroupingSet/definition": { "get": { "tags": [ "TaskGroupingSet" ], "description": "Executes the TaskGroupingSet definition action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/TaskGroupingSet/definition::GET EntityStructure TaskGroupingSetModel (/api/TaskGroupingSet/definition)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.SingleResultModel" } } } } } } }, "/api/TaskGroupingSet/labels": { "post": { "tags": [ "TaskGroupingSet" ], "description": "Resolves the display labels of the given TaskGroupingSet records.", "operationId": "/api/TaskGroupingSet/labels::POST EntityStructure TaskGroupingSetModel (/api/TaskGroupingSet/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/TaskGroupingSet/SearchIndex/recreate": { "post": { "tags": [ "TaskGroupingSet" ], "description": "Reindex the search-index for entity TaskGroupingSet.", "operationId": "/api/TaskGroupingSet/SearchIndex/recreate::Reindex Search-Index for entity TaskGroupingSet", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Buzzle.Shared.Models.PermissionDeniedResult" } } } } } } }, "/api/TaskGroupingSet/validate": { "post": { "tags": [ "TaskGroupingSet" ], "description": "Executes the TaskGroupingSet validate action on DataSource PrimaryEntityStructureDataSource.", "operationId": "/api/TaskGroupingSet/validate::POST EntityStructure TaskGroupingSetModel (/api/TaskGroupingSet/validate)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Work.TaskGroupingSetModel" } } }, "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/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": { "Buzzle.Module.Abstractions.Work.Models.BaseTaskConfigurationModel": { "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" } }, "workflowSetId": { "type": "string", "description": "The workflow whose states a task of this type is clicked through. Exactly one, so the question\n\"is this task finished\" has exactly one answer.", "format": "uuid", "nullable": true }, "labelSetIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The label sets whose values a task of this type may carry. Any number, including none.", "nullable": true }, "validEntityNames": { "type": "array", "items": { "type": "string" }, "description": "The entity structures this type is offered on, by name. Empty means every entity that records\nwork at all - which is the normal case and why it is not required.", "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": { }, "description": "The blueprint a task is created from: which workflow it is clicked through and which labels it may\ncarry." }, "Buzzle.Module.Abstractions.Work.Models.BaseTaskModel": { "type": "object", "properties": { "taskConfigurationId": { "type": "string", "description": "The blueprint this task follows: its workflow and the label sets it may draw from.", "format": "uuid", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "ownerEntityName": { "type": "string", "description": "Entity structure of the record this task belongs to, by name - `Person`, `Company`.", "nullable": true }, "ownerEntityNames": { "type": "array", "items": { "type": "string" }, "description": "Template only: the kinds of record the template applies to. Empty means all of them.", "nullable": true }, "ownerValueId": { "type": "string", "description": "The record itself. Null on a template, which names a kind rather than a record.", "format": "uuid", "nullable": true }, "ownerLabel": { "type": "string", "description": "What the record is called, kept beside the reference rather than resolved on reading.", "nullable": true }, "parentTaskId": { "type": "string", "description": "The task this one belongs to. One level only - a subtask has no subtasks of its own.", "format": "uuid", "nullable": true }, "workflowStateId": { "type": "string", "description": "Where the task currently stands, as one value of its type's workflow.", "format": "uuid", "nullable": true }, "labelIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The labels it carries, drawn from its type's label sets.", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "isTemplate": { "type": "boolean", "description": "Whether this is a blueprint rather than a piece of work." }, "relativeDueDays": { "type": "integer", "description": "Template only: how many days after the task is created it falls due.", "format": "int32", "nullable": true }, "autoCreateOnEntityCreated": { "type": "boolean", "description": "Template only: whether it fires by itself whenever a record of its entity type is created." }, "isCancelled": { "type": "boolean", "description": "Closed without being finished." }, "cancelledAt": { "type": "string", "format": "date-time", "nullable": true }, "cancellationReason": { "type": "string", "description": "Name of a Buzzle.Module.Abstractions.Work.Models.TaskCancellationReason value.", "nullable": true }, "cancellationNote": { "type": "string", "description": "What was said when the task was stopped. Free text, written by whoever stopped it.", "nullable": true }, "createdByPersonId": { "type": "string", "description": "Who opened the task. `Created` says when; nothing on the base model says who.", "format": "uuid", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" }, "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": { }, "description": "A piece of work recorded against a record - and, with Buzzle.Module.Abstractions.Work.Models.BaseTaskModel.IsTemplate set, the blueprint\nsuch a piece of work is created from." }, "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.Assignments.AssignmentModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "loginExternalId": { "type": "string", "description": "The subject the sign-in service issued for this person's login — what the profile picture is found\nby. Empty for a person who has never had one.", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "loginName": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "One person made responsible for one record, as the API returns it." }, "Buzzle.Shared.Models.Assignments.CreateAssignmentModel": { "type": "object", "properties": { "personId": { "type": "string", "format": "uuid" }, "loginExternalId": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "loginName": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Assigns one person to one record." }, "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", "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.EntityLabelModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "label": { "type": "string", "description": "The rendered label, e.g. `CEO`. Records the caller may not read, and records of a structure\nthat declares no label, are left out of the answer rather than carried with an empty one.", "nullable": true } }, "additionalProperties": false, "description": "What one record is called: its id and the label its entity structure renders for it." }, "Buzzle.Shared.Models.AttributeSystem.EntityStructureModel": { "type": "object", "properties": { "labelFormat": { "type": "string", "nullable": true }, "translations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { }, "nullable": true }, "description": "Display name per culture - \"Adresse\" rather than \"PersonAddress\".", "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" }, "description": "Foreign-key property names in declaration order. Related-entity queries and endpoints address relations by\nthese names rather than by position.", "nullable": true }, "relationsCount": { "type": "integer", "format": "int32", "readOnly": true }, "haveChangeRequests": { "type": "boolean" }, "configuration": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Per-feature configuration of this entity structure, keyed by feature - `{ \"assignments\": { \"enabled\": 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/ExampleOnline.Shared.Models.Work.TaskConfigurationModel" }, "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/ExampleOnline.Shared.Models.Work.TaskGroupModel" }, "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/ExampleOnline.Shared.Models.Work.TaskGroupingSetModel" }, "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/ExampleOnline.Shared.Models.Work.TaskModel" }, "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/Buzzle.Module.Abstractions.Work.Models.BaseTaskConfigurationModel" }, "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.Work.Models.BaseTaskModel" }, "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.Assignments.AssignmentModel" }, "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.ListResultModel": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/ExampleOnline.Shared.Models.Work.TaskConfigurationModel" }, "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/ExampleOnline.Shared.Models.Work.TaskGroupModel" }, "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/ExampleOnline.Shared.Models.Work.TaskGroupingSetModel" }, "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/ExampleOnline.Shared.Models.Work.TaskModel" }, "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": { "type": "string" }, "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 }, "ExampleOnline.Shared.Models.Work.TaskConfigurationModel": { "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" } }, "workflowSetId": { "type": "string", "description": "The workflow whose states a task of this type is clicked through. Exactly one, so the question\n\"is this task finished\" has exactly one answer.", "format": "uuid", "nullable": true }, "labelSetIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The label sets whose values a task of this type may carry. Any number, including none.", "nullable": true }, "validEntityNames": { "type": "array", "items": { "type": "string" }, "description": "The entity structures this type is offered on, by name. Empty means every entity that records\nwork at all - which is the normal case and why it is not required.", "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.Work.TaskGroupModel": { "type": "object", "properties": { "taskGroupingSetId": { "type": "string", "description": "The set this value belongs to.", "format": "uuid", "nullable": true }, "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" } }, "color": { "type": "string", "description": "Colour the value is shown in, as a CSS colour. Empty falls back to a neutral chip.", "nullable": true }, "sortOrder": { "type": "integer", "description": "Position within its set. In a workflow this is also the order the states are walked in.", "format": "int32" }, "isFinalState": { "type": "boolean", "description": "Whether a task in this state counts as finished. Only meaningful in a workflow." }, "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.Work.TaskGroupingSetModel": { "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" } }, "kind": { "type": "string", "description": "Name of a Buzzle.Module.Abstractions.Work.Models.TaskGroupingSetKind value.", "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.Work.TaskModel": { "type": "object", "properties": { "taskConfigurationId": { "type": "string", "description": "The blueprint this task follows: its workflow and the label sets it may draw from.", "format": "uuid", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "ownerEntityName": { "type": "string", "description": "Entity structure of the record this task belongs to, by name - `Person`, `Company`.", "nullable": true }, "ownerEntityNames": { "type": "array", "items": { "type": "string" }, "description": "Template only: the kinds of record the template applies to. Empty means all of them.", "nullable": true }, "ownerValueId": { "type": "string", "description": "The record itself. Null on a template, which names a kind rather than a record.", "format": "uuid", "nullable": true }, "ownerLabel": { "type": "string", "description": "What the record is called, kept beside the reference rather than resolved on reading.", "nullable": true }, "parentTaskId": { "type": "string", "description": "The task this one belongs to. One level only - a subtask has no subtasks of its own.", "format": "uuid", "nullable": true }, "workflowStateId": { "type": "string", "description": "Where the task currently stands, as one value of its type's workflow.", "format": "uuid", "nullable": true }, "labelIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The labels it carries, drawn from its type's label sets.", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "isTemplate": { "type": "boolean", "description": "Whether this is a blueprint rather than a piece of work." }, "relativeDueDays": { "type": "integer", "description": "Template only: how many days after the task is created it falls due.", "format": "int32", "nullable": true }, "autoCreateOnEntityCreated": { "type": "boolean", "description": "Template only: whether it fires by itself whenever a record of its entity type is created." }, "isCancelled": { "type": "boolean", "description": "Closed without being finished." }, "cancelledAt": { "type": "string", "format": "date-time", "nullable": true }, "cancellationReason": { "type": "string", "description": "Name of a Buzzle.Module.Abstractions.Work.Models.TaskCancellationReason value.", "nullable": true }, "cancellationNote": { "type": "string", "description": "What was said when the task was stopped. Free text, written by whoever stopped it.", "nullable": true }, "createdByPersonId": { "type": "string", "description": "Who opened the task. `Created` says when; nothing on the base model says who.", "format": "uuid", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" }, "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": { } } }, "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": "PermissionSecurity", "description": "Endpoints exposed for data source PermissionSecurity from provider PermissionSecurity." }, { "name": "Task", "description": "Endpoints exposed for data source Task from provider EntityStructure." }, { "name": "TaskDataSource", "description": "Endpoints exposed for data source TaskDataSource from provider TaskDataSourceProvider." }, { "name": "Task", "description": "Endpoints exposed for data source Task from provider SearchIndexing." }, { "name": "TaskConfiguration", "description": "Endpoints exposed for data source TaskConfiguration from provider EntityStructure." }, { "name": "TaskConfiguration", "description": "Endpoints exposed for data source TaskConfiguration from provider SearchIndexing." }, { "name": "TaskGroup", "description": "Endpoints exposed for data source TaskGroup from provider EntityStructure." }, { "name": "TaskGroupingSet", "description": "Endpoints exposed for data source TaskGroupingSet from provider EntityStructure." }, { "name": "TaskGroupingSet", "description": "Endpoints exposed for data source TaskGroupingSet from provider SearchIndexing." }, { "name": "Validators", "description": "Endpoints exposed for data source Validators from provider Validators." }, { "name": "Task", "description": "Endpoints exposed for data source Task from provider EntityStructure." } ] }