{ "openapi": "3.0.1", "info": { "title": "Business Technology Document Service API", "description": "Through this WebAPI an authorized user will be able to store and retrieve documents", "version": "1.0" }, "paths": { "/api/v1/Document/{id}": { "get": { "tags": [ "Document" ], "operationId": "GetDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/v1/Document/documentURL/{id}": { "get": { "tags": [ "Document" ], "operationId": "Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/v1/Document/add": { "post": { "tags": [ "Document" ], "operationId": "AddDocument", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Customer", "SourceApplication", "Tenant" ], "type": "object", "properties": { "SourceApplication": { "type": "string", "format": "uuid" }, "Customer": { "type": "string" }, "Tenant": { "type": "string" }, "DocumentType": { "type": "string" }, "File": { "type": "string", "format": "binary" }, "Metadata": { "type": "string" } } }, "encoding": { "SourceApplication": { "style": "form" }, "Customer": { "style": "form" }, "Tenant": { "style": "form" }, "DocumentType": { "style": "form" }, "File": { "style": "form" }, "Metadata": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/v1/Document/update": { "put": { "tags": [ "Document" ], "operationId": "UpdateDocument", "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.Documents.UpdateDocumentRequest" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.Documents.UpdateDocumentRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.Documents.UpdateDocumentRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.Documents.UpdateDocumentRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/v1/Document/delete": { "delete": { "tags": [ "Document" ], "operationId": "DeleteDocument", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "200": { "description": "OK" }, "207": { "description": "Multi-Status" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/v1/DocumentType/all": { "get": { "tags": [ "DocumentType" ], "operationId": "GetAllDocumentTypes", "parameters": [ { "name": "sourceApplicationId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.DocumentTypes.DocumentType" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.DocumentTypes.DocumentType" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.DocumentTypes.DocumentType" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/v1/DocumentType/{id}": { "get": { "tags": [ "DocumentType" ], "operationId": "GetDocumentType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.DocumentTypes.DocumentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.DocumentTypes.DocumentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.DocumentTypes.DocumentType" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } }, "delete": { "tags": [ "DocumentType" ], "operationId": "DeleteDocumentType", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/v1/DocumentType/add": { "post": { "tags": [ "DocumentType" ], "operationId": "AddDocumentType", "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.DocumentTypes.CreateDocumentTypeRequest" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.DocumentTypes.CreateDocumentTypeRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.DocumentTypes.CreateDocumentTypeRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.DocumentTypes.CreateDocumentTypeRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/v1/SourceApplication": { "get": { "tags": [ "SourceApplication" ], "operationId": "GetAllSourceApplications", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.SourceApplications.SourceApplication" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.SourceApplications.SourceApplication" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.SourceApplications.SourceApplication" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/v1/SourceApplication/{id}": { "get": { "tags": [ "SourceApplication" ], "operationId": "GetSourceApplication", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.SourceApplications.SourceApplication" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.SourceApplications.SourceApplication" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.SourceApplications.SourceApplication" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } }, "delete": { "tags": [ "SourceApplication" ], "operationId": "DeleteSourceApplication", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/v1/SourceApplication/add": { "post": { "tags": [ "SourceApplication" ], "operationId": "AddSourceApplication", "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.SourceApplications.CreateSourceApplicationRequest" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.SourceApplications.CreateSourceApplicationRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.SourceApplications.CreateSourceApplicationRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SST.BT.DS.Domain.Models.SourceApplications.CreateSourceApplicationRequest" } ] } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } } }, "components": { "schemas": { "Microsoft.AspNetCore.Mvc.ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "SST.BT.DS.Domain.Models.DocumentTypes.CreateDocumentTypeRequest": { "required": [ "customer", "name", "sourceApplicationId", "tenant" ], "type": "object", "properties": { "sourceApplicationId": { "type": "string", "format": "uuid" }, "customer": { "minLength": 1, "type": "string" }, "tenant": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "SST.BT.DS.Domain.Models.DocumentTypes.DocumentType": { "type": "object", "properties": { "sourceApplicationId": { "type": "string", "format": "uuid" }, "customer": { "type": "string", "nullable": true }, "tenant": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "SST.BT.DS.Domain.Models.Documents.UpdateDocumentRequest": { "required": [ "documentId" ], "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "documentType": { "type": "string", "nullable": true }, "metadata": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SST.BT.DS.Domain.Models.SourceApplications.CreateSourceApplicationRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "SST.BT.DS.Domain.Models.SourceApplications.SourceApplication": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer_OAuth2": { "type": "oauth2", "description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"", "flows": { "clientCredentials": { "authorizationUrl": "https://293-app-dev-carbonite-sso.dv3.bplhost.com/common/oauth2/v1.0/authorize", "tokenUrl": "https://293-app-dev-carbonite-sso.dv3.bplhost.com/common/oauth2/v1.0/token", "scopes": { "DocumentServiceAPI.DocumentType.Post": "", "DocumentServiceAPI.SourceApplication.Get": "", "DocumentServiceAPI.Folders.Delete": "", "DocumentServiceAPI.DocumentType.Patch": "", "DocumentServiceAPI.DocumentType.List": "", "DocumentServiceAPI.Document.Patch": "", "DocumentServiceAPI.Folders.Rename": "", "DocumentServiceAPI.Folders.Create": "", "DocumentServiceAPI.DocumentType.Put": "", "DocumentServiceAPI.SourceApplication.Delete": "", "DocumentServiceAPI.Document.Get": "", "DocumentServiceAPI.DocumentType.Get": "", "DocumentServiceAPI.Document.Delete": "", "DocumentServiceAPI.Document.List": "", "DocumentServiceAPI.DocumentType.Delete": "", "DocumentServiceAPI.Document.Post": "", "DocumentServiceAPI.SourceApplication.Post": "", "DocumentServiceAPI.Folders.List": "", "DocumentServiceAPI.SourceApplication.Put": "", "DocumentServiceAPI.Document.Put": "", "DocumentServiceAPI.SourceApplication.Patch": "", "DocumentServiceAPI.SourceApplication.List": "", "DocumentServiceAPI.Folders.Get": "" } } } } } }, "security": [ { "Bearer_OAuth2": [ ] } ] }