{ "openapi": "3.0.4", "info": { "title": "Public API", "description": "Public Approval Studio API", "contact": { "name": "Approval Studio", "url": "https://approval.studio", "email": "contact@approval.studio" }, "version": "v1" }, "paths": { "/api/v1/annotation/all": { "get": { "tags": [ "Annotation" ], "summary": "Returns a list of annotations for given asset and page.", "parameters": [ { "name": "AssetUID", "in": "query", "schema": { "type": "string" } }, { "name": "PageNum", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Int32AnnotationArrayDictionaryApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Int32AnnotationArrayDictionaryApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Int32AnnotationArrayDictionaryApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/annotation": { "get": { "tags": [ "Annotation" ], "summary": "Returns an annotations for given annotation id.", "parameters": [ { "name": "AnnotationUID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AnnotationApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnnotationApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Annotation" ], "summary": "Creates an annotations for a given asset.", "requestBody": { "description": "Annotation text and an asset UID and page number.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateAnnotationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnnotationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAnnotationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAnnotationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Annotation" ], "summary": "Deletes an annotation for a given annotation id.", "requestBody": { "description": "Annotation id.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteAnnotationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAnnotationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteAnnotationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteAnnotationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/annotation/hide": { "put": { "tags": [ "Annotation" ], "summary": "Hides an annotation for a given annotation id.", "requestBody": { "description": "Annotation id.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HideAnnotationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HideAnnotationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HideAnnotationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HideAnnotationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AnnotationApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnnotationApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/annotation/complete": { "put": { "tags": [ "Annotation" ], "summary": "Completes an annotation for a given annotation id.", "requestBody": { "description": "Annotation id.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CompleteAnnotationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompleteAnnotationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompleteAnnotationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompleteAnnotationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Annotation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Annotation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Annotation" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/annotation/uncomplete": { "put": { "tags": [ "Annotation" ], "summary": "Un-completes an annotation for a given annotation id.", "requestBody": { "description": "Annotation id.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UnCompleteAnnotationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnCompleteAnnotationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnCompleteAnnotationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UnCompleteAnnotationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Annotation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Annotation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Annotation" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/asset": { "get": { "tags": [ "Asset" ], "summary": "Gets an asset instance.", "parameters": [ { "name": "AssetUID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AssetApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AssetApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssetApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Asset" ], "summary": "Deletes asset.", "requestBody": { "description": "Asset id that points to asset to delete.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteAssetRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAssetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteAssetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteAssetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/asset/upload": { "post": { "tags": [ "Asset" ], "summary": "Uploads an asset and initiates asset processing (async).", "parameters": [ { "name": "ProjectUID", "in": "query", "schema": { "type": "string" } }, { "name": "FileName", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "description": "Reference to a file to upload.", "format": "binary" } } }, "encoding": { "uploadedFile": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UploadAssetResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadAssetResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadAssetResponseApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/asset/upload_packet": { "post": { "tags": [ "Asset" ], "summary": "Uploads an asset packet (containing pre-converted image) and initiates asset processing (async).", "parameters": [ { "name": "ProjectUID", "in": "query", "schema": { "type": "string" } }, { "name": "TaskUID", "in": "query", "schema": { "type": "string" } }, { "name": "FileName", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "description": "Reference to a file to upload.", "format": "binary" } } }, "encoding": { "uploadedFile": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UploadAssetResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadAssetResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadAssetResponseApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/asset/upload_url": { "post": { "tags": [ "Asset" ], "summary": "Uploads an asset taken form publicly accessible URL and initiates asset processing (async).", "requestBody": { "description": "Image URL to process as a project's asset..", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UploadUrlAssetRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadUrlAssetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadUrlAssetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UploadUrlAssetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UploadAssetResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadAssetResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadAssetResponseApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/asset/download": { "get": { "tags": [ "Asset" ], "summary": "Returns url to download asset.", "parameters": [ { "name": "AssetUID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AssetDownloadResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AssetDownloadResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssetDownloadResponseApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/asset/proofreport": { "get": { "tags": [ "Asset" ], "summary": "Returns url to download asset's proof report.", "parameters": [ { "name": "AssetUID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AssetProofReportResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AssetProofReportResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssetProofReportResponseApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/dal/folders": { "get": { "tags": [ "DAL" ], "summary": "Returns DAL folders' hierarchy.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetDALFoldersResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetDALFoldersResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDALFoldersResponseApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/dal/folder": { "post": { "tags": [ "DAL" ], "summary": "Create a new DAL folder.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateDALFolderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateDALFolderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDALFolderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDALFolderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "DAL" ], "summary": "Rename an existing DAL folder.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RenameDALFolderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RenameDALFolderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RenameDALFolderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RenameDALFolderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "patch": { "tags": [ "DAL" ], "summary": "Move an existing DAL folder to other parent folder.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MoveDALFolderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MoveDALFolderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveDALFolderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveDALFolderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "DAL" ], "summary": "Deletes an existing DAL folder .", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteDALFolderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDALFolderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteDALFolderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteDALFolderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/dal/asset": { "get": { "tags": [ "DAL" ], "summary": "Returns DAL asset.", "parameters": [ { "name": "AssetUID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetDALAssetResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetDALAssetResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDALAssetResponseApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "DAL" ], "summary": "Move DAL asset to a given folder.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MoveDALAssetRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MoveDALAssetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveDALAssetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveDALAssetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "DAL" ], "summary": "Delete a DAL asset.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteDALAssetRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDALAssetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteDALAssetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteDALAssetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/dal/folder/assets": { "get": { "tags": [ "DAL" ], "summary": "Returns DAL assets that are in the given folder.", "parameters": [ { "name": "FolderUID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetDALAssetsResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetDALAssetsResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDALAssetsResponseApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/dal/asset/project": { "post": { "tags": [ "DAL" ], "summary": "Copy a DAL asset to a given project.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CopyDALAssetToProjectRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CopyDALAssetToProjectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CopyDALAssetToProjectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CopyDALAssetToProjectRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/dal/asset/folder": { "post": { "tags": [ "DAL" ], "summary": "Copy a project's asset to a given DAL folder.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CopyAssetToDALFolderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CopyAssetToDALFolderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CopyAssetToDALFolderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CopyAssetToDALFolderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/links/shortlink": { "post": { "tags": [ "Links" ], "summary": "Returns a shortlink based on any URL provided.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateShortLinkRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateShortLinkRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShortLinkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateShortLinkRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateShortLinkResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateShortLinkResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShortLinkResponseApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/project": { "get": { "tags": [ "Project" ], "summary": "Gets list of projects according to (optional) search criteria.", "parameters": [ { "name": "ProjectUID", "in": "query", "schema": { "type": "string" } }, { "name": "States", "in": "query", "schema": { "type": "string" } }, { "name": "Query", "in": "query", "schema": { "type": "string" } }, { "name": "IsLoadAssets", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsLoadLastVerAssets", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsLoadTasks", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsLoadRefDocs", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsLoadMetadata", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectObjArrayApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectObjArrayApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectObjArrayApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Project" ], "summary": "Creates a new project taking project name and optional attributes.", "requestBody": { "description": "Project name and a set of optional attributes including due date.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateProjectRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProjectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProjectRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateProjectResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProjectResponseApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Project" ], "summary": "Changes project's attributes including name and due date.", "requestBody": { "description": "Project id and set of attributes to set.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditProjectRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EditProjectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditProjectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditProjectRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EditProjectResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EditProjectResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditProjectResponseApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Project" ], "summary": "Delete project.", "requestBody": { "description": "Project id that points to project to delete.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteProjectRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteProjectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteProjectRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteProjectRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/project/proofreport": { "get": { "tags": [ "Project" ], "summary": "Returns url to get a printable proof report for the given project.", "parameters": [ { "name": "ProjectUID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectProofReportApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectProofReportApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectProofReportApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/project/state": { "put": { "tags": [ "Project" ], "summary": "Changes project's state according state rules (see documenatation).", "requestBody": { "description": "Project id and set of attributes to set.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditProjectStateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EditProjectStateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditProjectStateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditProjectStateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/project/meta": { "get": { "tags": [ "Project" ], "summary": "Add a metadata entry to the given project. You may add multiple entries with different keys.", "parameters": [ { "name": "ProjectUID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringStringDictionaryApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringStringDictionaryApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringStringDictionaryApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Project" ], "summary": "Add a metadata entry to the given project. You may add multiple entries with different keys.", "requestBody": { "description": "Project id and key-value of the metadata.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddProjectMetadataRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddProjectMetadataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddProjectMetadataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddProjectMetadataRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Project" ], "summary": "Edits a metadata entry for the given project.", "requestBody": { "description": "Project id and key-value of the metadata.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditProjectMetadataRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EditProjectMetadataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditProjectMetadataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditProjectMetadataRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Project" ], "summary": "Deleted a metadata entry for the given project with the given key.", "requestBody": { "description": "Project id and key-value of the metadata.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteProjectMetadataRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteProjectMetadataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteProjectMetadataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteProjectMetadataRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/project/meta/projects": { "get": { "tags": [ "Project" ], "summary": "Gets one or more projects that contain metadata with the given Key and optional value.", "parameters": [ { "name": "Key", "in": "query", "schema": { "type": "string" } }, { "name": "Value", "in": "query", "schema": { "type": "string" } }, { "name": "States", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProjectObjArrayApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectObjArrayApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectObjArrayApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/project/kanban/column": { "post": { "tags": [ "Project" ], "summary": "Moves a project to a given Kanban column on the dashboard.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SetProjectKanbanColumnRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SetProjectKanbanColumnRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetProjectKanbanColumnRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetProjectKanbanColumnRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/project/folder": { "post": { "tags": [ "Project" ], "summary": "Moves a project to a given Folder on the dashboard.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SetProjectFolderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SetProjectFolderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetProjectFolderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetProjectFolderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/refdoc/upload": { "post": { "tags": [ "RefDoc" ], "summary": "Uploads a reference document and initiates document's processing (async).", "parameters": [ { "name": "ProjectUID", "in": "query", "schema": { "type": "string" } }, { "name": "FileName", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "description": "Reference to a file to upload.", "format": "binary" } } }, "encoding": { "uploadedFile": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UploadRefDocResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadRefDocResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadRefDocResponseApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/refdoc/upload_url": { "post": { "tags": [ "RefDoc" ], "summary": "Uploads an document taken from the publicly accessible URL and initiates its processing (async).", "requestBody": { "description": "Project id that document belong to.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UploadUrlRefDocRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadUrlRefDocRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadUrlRefDocRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UploadUrlRefDocRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UploadRefDocResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadRefDocResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadRefDocResponseApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/refdoc/add_url": { "post": { "tags": [ "RefDoc" ], "summary": "Adds a URL as a reference document.", "requestBody": { "description": "URL to add to the list of reference documents.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddUrlRefDocRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddUrlRefDocRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddUrlRefDocRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddUrlRefDocRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UploadRefDocResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadRefDocResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadRefDocResponseApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/refdoc/download": { "get": { "tags": [ "RefDoc" ], "summary": "Returns url to download reference document.", "parameters": [ { "name": "RefDocUID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RefDocDownloadResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RefDocDownloadResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefDocDownloadResponseApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/refdoc": { "delete": { "tags": [ "RefDoc" ], "summary": "Marks a reference document as deleted.", "requestBody": { "description": "Reference document UID that points to the document to delete.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteRefDocRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteRefDocRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteRefDocRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteRefDocRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "406": { "description": "Not Acceptable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task/all": { "get": { "tags": [ "Task" ], "summary": "Get list of tasks assigned on the current user.", "parameters": [ { "name": "Types", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaskArrayApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskArrayApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskArrayApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task": { "get": { "tags": [ "Task" ], "summary": "Gets a task instance for given task id.", "parameters": [ { "name": "TaskUID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaskApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Task" ], "summary": "Deletes a given task.", "requestBody": { "description": "Id of task.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "410": { "description": "Gone", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task/asset_upload": { "post": { "tags": [ "Task" ], "summary": "Creates a new AssetUpload task for a given user providing optional due date and comment.", "requestBody": { "description": "Id of project and user, optional due date and comment.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateAssetUploadTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAssetUploadTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAssetUploadTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAssetUploadTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task/asset_change_upload": { "post": { "tags": [ "Task" ], "summary": "Creates a new AssetChangeUpload task for a given user providing optional due date and comment.", "requestBody": { "description": "Id of project and user, optional due date and comment.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateAssetUploadChangeTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAssetUploadChangeTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAssetUploadChangeTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAssetUploadChangeTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task/refdoc_upload": { "post": { "tags": [ "Task" ], "summary": "Creates a new RefDocUpload task for a given user providing optional due date and comment.", "requestBody": { "description": "Id of project and user, optional due date and comment.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateRefDocUploadTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateRefDocUploadTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateRefDocUploadTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateRefDocUploadTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task/review_asset": { "post": { "tags": [ "Task" ], "summary": "Creates a new CreateReviewAssetTask task for a given user, project and list of assets providing optional due date and comment.", "requestBody": { "description": "Id of project, user and asset(s), optional due date and comment.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateAssetReviewTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAssetReviewTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAssetReviewTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAssetReviewTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task/review_asset_ext": { "post": { "tags": [ "Task" ], "summary": "Creates a new CreateReviewAssetTask task for a given user, project and list of assets providing optional due date and comment.", "requestBody": { "description": "Id of project, user and asset(s), optional due date and comment.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateAssetExtReviewTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAssetExtReviewTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAssetExtReviewTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAssetExtReviewTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task/upload_asset_ext": { "post": { "tags": [ "Task" ], "summary": "Creates a new ExternalUploadAssetTask task for a given project providing optional due date, language and comment.", "requestBody": { "description": "Id of project, user and asset(s), optional due date and comment.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUploadAssetExtTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUploadAssetExtTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUploadAssetExtTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUploadAssetExtTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task/upload_refdoc_ext": { "post": { "tags": [ "Task" ], "summary": "Creates a new ExternalRefDocUploadTask task for a given project providing optional due date, language and comment.", "requestBody": { "description": "Id of project, user and asset(s), optional due date and comment.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUploadRefDocExtTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateUploadRefDocExtTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUploadRefDocExtTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUploadRefDocExtTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task/approve": { "put": { "tags": [ "Task" ], "summary": "Approves a given image or video review task.", "requestBody": { "description": "Id of task.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ApproveTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApproveTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApproveTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApproveTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "410": { "description": "Gone", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task/reject": { "put": { "tags": [ "Task" ], "summary": "Rejects a given image or video review task.", "requestBody": { "description": "Id of task.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RejectTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RejectTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RejectTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RejectTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "410": { "description": "Gone", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task/complete": { "put": { "tags": [ "Task" ], "summary": "Completes a given task.", "requestBody": { "description": "UID of task to complete.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CompleteTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompleteTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompleteTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompleteTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "410": { "description": "Gone", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/task/reminder/send": { "post": { "tags": [ "Task" ], "summary": "Sends a email reminder to the user that is assigned on the incompleted task.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SendTaskReminderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SendTaskReminderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendTaskReminderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendTaskReminderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "410": { "description": "Gone", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/token/login": { "post": { "tags": [ "Token" ], "summary": "Authorizes a user in API/ApprovalStudio. When sucessully authorized returns \r\nan authorization token which must be supplied to every API call as\r\n\"Bearer XXXXXXXXXXXXXXXXXXXXXXX\".", "requestBody": { "description": "Email and password as it is in Approval Studio (AS). All the AS rules appied.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthTokenRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthTokenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthTokenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthTokenRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthTokenResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthTokenResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthTokenResponseApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/token/validate": { "get": { "tags": [ "Token" ], "summary": "Validates if an authenticating bearer token provided in headers is valid.\r\nReturns 200 HHTP code if it's valid and 401 if it is not valid or not provided.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthTokenResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthTokenResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthTokenResponseApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v1/users": { "get": { "tags": [ "User" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UsersResultApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UsersResultApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsersResultApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/user/loggedin": { "get": { "tags": [ "User" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CurrentUserResultApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CurrentUserResultApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CurrentUserResultApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/webhook": { "post": { "tags": [ "WebHook" ], "summary": "Creates a new webhook subscription.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateWebHookRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebHookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWebHookRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWebHookRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebHookApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebHookApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebHookApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "WebHook" ], "summary": "Deletes a webhook.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteWebHookRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebHookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteWebHookRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteWebHookRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/webhooks": { "get": { "tags": [ "WebHook" ], "summary": "Get list of webhooks for current client/tenant.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebHookArrayApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebHookArrayApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebHookArrayApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/webhook/test": { "put": { "tags": [ "WebHook" ], "summary": "Posts a test Json on a given webhook for test purposes.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TestWebHookRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TestWebHookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TestWebHookRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TestWebHookRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/workflows": { "get": { "tags": [ "Workflow" ], "summary": "Returns all the workflows available.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkflowArrayApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowArrayApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkflowArrayApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/workflow": { "delete": { "tags": [ "Workflow" ], "summary": "Deletes a workflow.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteWorkflowRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWorkflowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteWorkflowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteWorkflowRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Workflow" ], "summary": "Gets a workflow.", "parameters": [ { "name": "WorkflowUID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetWorkflowResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkflowResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetWorkflowResponseApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Workflow" ], "summary": "Create a new workflow.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateWorkflowRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkflowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWorkflowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWorkflowRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateWorkflowResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkflowResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWorkflowResponseApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Workflow" ], "summary": "Edits a workflow.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditWorkflowRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EditWorkflowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditWorkflowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditWorkflowRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EditWorkflowResponseApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EditWorkflowResponseApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditWorkflowResponseApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/project/workflow/run": { "post": { "tags": [ "Workflow" ], "summary": "Runs a workflow assigned to a project.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RunWorkflowRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RunWorkflowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RunWorkflowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RunWorkflowRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "412": { "description": "Precondition Failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } } }, "components": { "schemas": { "AddProjectMetadataRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "AddUrlRefDocRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Annotation": { "type": "object", "properties": { "commentId": { "type": "integer", "format": "int32" }, "commentUID": { "type": "string", "nullable": true }, "parentCommentId": { "type": "integer", "format": "int32", "nullable": true }, "body": { "type": "string", "nullable": true }, "drawingCode": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "pageNum": { "type": "integer", "format": "int32" }, "sequenceId": { "type": "integer", "format": "int32", "nullable": true }, "isCompleted": { "type": "boolean" }, "replies": { "type": "array", "items": { "$ref": "#/components/schemas/Annotation" }, "nullable": true }, "user": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "AnnotationApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/Annotation" } }, "additionalProperties": false }, "ApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "nullable": true } }, "additionalProperties": false }, "ApproveTaskRequest": { "type": "object", "properties": { "taskUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Asset": { "type": "object", "properties": { "assetUID": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/AssetStatus" }, "pagesCount": { "type": "integer", "format": "int32" }, "reviewStatus": { "$ref": "#/components/schemas/ReviewStatus" }, "created": { "type": "string", "format": "date-time" }, "fileSize": { "type": "integer", "format": "int32" }, "reviewUrl": { "type": "string", "nullable": true }, "thumbnailUrl": { "type": "string", "nullable": true }, "fullSizeBitmapUrl": { "type": "string", "nullable": true }, "projectUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AssetApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/Asset" } }, "additionalProperties": false }, "AssetDownloadResponse": { "type": "object", "properties": { "downloadURL": { "type": "string", "nullable": true }, "asset": { "$ref": "#/components/schemas/Asset" } }, "additionalProperties": false }, "AssetDownloadResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/AssetDownloadResponse" } }, "additionalProperties": false }, "AssetProofReportResponse": { "type": "object", "properties": { "downloadURL": { "type": "string", "nullable": true }, "asset": { "$ref": "#/components/schemas/Asset" } }, "additionalProperties": false }, "AssetProofReportResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/AssetProofReportResponse" } }, "additionalProperties": false }, "AssetStatus": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "x-enumNames": [ "Pending", "Processed", "Failed" ] }, "AssignUsers": { "type": "object", "properties": { "internalUsers": { "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "externallUsers": { "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": false }, "AuthTokenRequest": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "keepAliveTime": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AuthTokenResponse": { "type": "object", "properties": { "token": { "type": "string", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "$ref": "#/components/schemas/AuthTokenStatus" }, "user": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "AuthTokenResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/AuthTokenResponse" } }, "additionalProperties": false }, "AuthTokenStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32", "x-enumNames": [ "Success", "WrongCredentials", "AccountLocked", "OnlyProAllowed" ] }, "Client": { "type": "object", "properties": { "clientID": { "type": "integer", "format": "int32" }, "clientUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/ClientStatus" }, "clientType": { "$ref": "#/components/schemas/ClientType" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "nullable": true }, "templates": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTemplate" }, "nullable": true }, "kanbanColumns": { "type": "array", "items": { "$ref": "#/components/schemas/KanbanColumnResponse" }, "nullable": true }, "folders": { "type": "array", "items": { "$ref": "#/components/schemas/FolderResponse" }, "nullable": true }, "workflows": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" }, "nullable": true } }, "additionalProperties": false }, "ClientStatus": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enumNames": [ "Active", "Inactive" ] }, "ClientType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enumNames": [ "Pro", "Lite" ] }, "CompleteAnnotationRequest": { "type": "object", "properties": { "annotationUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CompleteTaskRequest": { "type": "object", "properties": { "taskUID": { "type": "string", "nullable": true }, "data": { "$ref": "#/components/schemas/TaskData" } }, "additionalProperties": false }, "CopyAssetToDALFolderRequest": { "type": "object", "properties": { "assetUID": { "type": "string", "nullable": true }, "folderUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CopyDALAssetToProjectRequest": { "type": "object", "properties": { "assetUID": { "type": "string", "nullable": true }, "projectUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAnnotationRequest": { "type": "object", "properties": { "assetUID": { "type": "string", "nullable": true }, "pageNum": { "type": "integer", "format": "int32" }, "body": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAssetExtReviewTaskRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "assetUIDs": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "password": { "type": "string", "nullable": true }, "emailSubject": { "type": "string", "nullable": true }, "emailLanguage": { "$ref": "#/components/schemas/LanguageCode" }, "comment": { "type": "string", "nullable": true }, "isAllowDownloadAssets": { "type": "boolean", "nullable": true }, "isReadOnly": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreateAssetReviewTaskRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "userUID": { "type": "string", "nullable": true }, "assetUIDs": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAssetUploadChangeTaskRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "userUID": { "type": "string", "nullable": true }, "assetUID": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAssetUploadTaskRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "userUID": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateDALFolderRequest": { "type": "object", "properties": { "folderUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateProjectRequest": { "type": "object", "properties": { "clientUID": { "type": "string", "nullable": true }, "projectName": { "type": "string", "nullable": true }, "customer": { "type": "string", "nullable": true }, "project": { "type": "string", "nullable": true }, "design": { "type": "string", "nullable": true }, "revision": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "projectOwnersUIDS": { "type": "array", "items": { "type": "string" }, "nullable": true }, "templateUID": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "folderUID": { "type": "string", "nullable": true }, "workflowUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateProjectResponse": { "type": "object", "properties": { "project": { "$ref": "#/components/schemas/ProjectObj" } }, "additionalProperties": false }, "CreateProjectResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/CreateProjectResponse" } }, "additionalProperties": false }, "CreateRefDocUploadTaskRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "userUID": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateShortLinkRequest": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateShortLinkResponse": { "type": "object", "properties": { "shortURL": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateShortLinkResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/CreateShortLinkResponse" } }, "additionalProperties": false }, "CreateUploadAssetExtTaskRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "password": { "type": "string", "nullable": true }, "emailSubject": { "type": "string", "nullable": true }, "emailLanguage": { "$ref": "#/components/schemas/LanguageCode" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateUploadRefDocExtTaskRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "password": { "type": "string", "nullable": true }, "emailSubject": { "type": "string", "nullable": true }, "emailLanguage": { "$ref": "#/components/schemas/LanguageCode" }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateWebHookRequest": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "clientUID": { "type": "string", "nullable": true }, "eventType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateWorkflowRequest": { "type": "object", "properties": { "clientUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionDto" }, "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRoleDto" }, "nullable": true } }, "additionalProperties": false }, "CreateWorkflowResponse": { "type": "object", "properties": { "workflowUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionDto" }, "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRoleDto" }, "nullable": true } }, "additionalProperties": false }, "CreateWorkflowResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/CreateWorkflowResponse" } }, "additionalProperties": false }, "CurrentUserResult": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/User" }, "clients": { "type": "array", "items": { "$ref": "#/components/schemas/Client" }, "nullable": true } }, "additionalProperties": false, "description": "Returns currently logged in user." }, "CurrentUserResultApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/CurrentUserResult" } }, "additionalProperties": false }, "DALAsset": { "type": "object", "properties": { "assetUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "originProjectUID": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "addedDate": { "type": "string", "format": "date-time", "nullable": true }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/DALEvent" }, "nullable": true } }, "additionalProperties": false }, "DALEvent": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DALFolder": { "type": "object", "properties": { "folderUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "subFolders": { "type": "array", "items": { "$ref": "#/components/schemas/DALFolder" }, "nullable": true } }, "additionalProperties": false }, "DeleteAnnotationRequest": { "type": "object", "properties": { "annotationUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteAssetRequest": { "type": "object", "properties": { "assetUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteDALAssetRequest": { "type": "object", "properties": { "assetUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteDALFolderRequest": { "type": "object", "properties": { "folderUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteProjectMetadataRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "key": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteProjectRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteRefDocRequest": { "type": "object", "properties": { "refDocUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteTaskRequest": { "type": "object", "properties": { "taskUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteWebHookRequest": { "type": "object", "properties": { "webHookUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeleteWorkflowRequest": { "type": "object", "properties": { "workflowUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EditProjectMetadataRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EditProjectRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "projectName": { "type": "string", "nullable": true }, "customer": { "type": "string", "nullable": true }, "project": { "type": "string", "nullable": true }, "design": { "type": "string", "nullable": true }, "revision": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "projectOwnersUIDS": { "type": "array", "items": { "type": "string" }, "nullable": true }, "folderUID": { "type": "string", "nullable": true }, "workflowUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EditProjectResponse": { "type": "object", "properties": { "project": { "$ref": "#/components/schemas/ProjectObj" } }, "additionalProperties": false }, "EditProjectResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/EditProjectResponse" } }, "additionalProperties": false }, "EditProjectStateRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "projectState": { "$ref": "#/components/schemas/ProjectState" } }, "additionalProperties": false }, "EditWorkflowRequest": { "type": "object", "properties": { "workflowUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionDto" }, "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRoleDto" }, "nullable": true } }, "additionalProperties": false }, "EditWorkflowResponse": { "type": "object", "properties": { "workflowUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionDto" }, "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRoleDto" }, "nullable": true } }, "additionalProperties": false }, "EditWorkflowResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/EditWorkflowResponse" } }, "additionalProperties": false }, "FolderResponse": { "type": "object", "properties": { "folderUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetDALAssetResponse": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/DALAsset" } }, "additionalProperties": false }, "GetDALAssetResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/GetDALAssetResponse" } }, "additionalProperties": false }, "GetDALAssetsResponse": { "type": "object", "properties": { "assets": { "type": "array", "items": { "$ref": "#/components/schemas/DALAsset" }, "nullable": true } }, "additionalProperties": false }, "GetDALAssetsResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/GetDALAssetsResponse" } }, "additionalProperties": false }, "GetDALFoldersResponse": { "type": "object", "properties": { "folders": { "type": "array", "items": { "$ref": "#/components/schemas/DALFolder" }, "nullable": true } }, "additionalProperties": false }, "GetDALFoldersResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/GetDALFoldersResponse" } }, "additionalProperties": false }, "GetWorkflowResponse": { "type": "object", "properties": { "workflowUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionDto" }, "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRoleDto" }, "nullable": true } }, "additionalProperties": false }, "GetWorkflowResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/GetWorkflowResponse" } }, "additionalProperties": false }, "HideAnnotationRequest": { "type": "object", "properties": { "annotationUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Int32AnnotationArrayDictionaryApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Annotation" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "KanbanColumnResponse": { "type": "object", "properties": { "kanbanColumnUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LanguageCode": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32", "x-enumNames": [ "English", "German", "French", "Polish", "Spanish", "Hebrew", "Ukrainian" ] }, "MoveDALAssetRequest": { "type": "object", "properties": { "assetUID": { "type": "string", "nullable": true }, "folderUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MoveDALFolderRequest": { "type": "object", "properties": { "folderUID": { "type": "string", "nullable": true }, "parentFolderUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "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": { } }, "ProjectObj": { "type": "object", "properties": { "projectId": { "type": "integer", "format": "int32" }, "projectUID": { "type": "string", "nullable": true }, "projectState": { "$ref": "#/components/schemas/ProjectState" }, "name": { "type": "string", "nullable": true }, "customer": { "type": "string", "nullable": true }, "project": { "type": "string", "nullable": true }, "design": { "type": "string", "nullable": true }, "revision": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "reviewStatus": { "$ref": "#/components/schemas/ReviewStatus" }, "created": { "type": "string", "format": "date-time" }, "assets": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" }, "nullable": true }, "nullable": true }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/Task" }, "nullable": true }, "refDocs": { "type": "array", "items": { "$ref": "#/components/schemas/RefDoc" }, "nullable": true }, "owners": { "type": "array", "items": { "type": "string" }, "nullable": true }, "template": { "$ref": "#/components/schemas/ProjectTemplate" }, "client": { "$ref": "#/components/schemas/Client" }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "kanbanColumnUID": { "type": "string", "nullable": true }, "folderUID": { "type": "string", "nullable": true }, "workflow": { "$ref": "#/components/schemas/Workflow" } }, "additionalProperties": false }, "ProjectObjArrayApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectObj" }, "nullable": true } }, "additionalProperties": false }, "ProjectProofReport": { "type": "object", "properties": { "downloadURL": { "type": "string", "nullable": true }, "project": { "$ref": "#/components/schemas/ProjectObj" } }, "additionalProperties": false }, "ProjectProofReportApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/ProjectProofReport" } }, "additionalProperties": false }, "ProjectState": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enumNames": [ "Active", "OnHold", "Completed", "Archived", "Intransit" ] }, "ProjectTemplate": { "type": "object", "additionalProperties": false }, "ReactionType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 ], "type": "integer", "format": "int32", "x-enumNames": [ "CreateInternalUploadAssetsTask", "CreateInternalUploadRefDocsTask", "CreateExternalUploadAssetsTask", "CreateExternalUploadRefDocsTask", "CreateInternalReviewTask", "CreateExternalReviewTask", "SendAssetsByEmail", "SendRefDocsByEmail", "CompleteProject", "SendDataWithWebhook", "AssignUserRoles", "SendCustomEmail", "MoveInKanban", "SwitchToWorkflow" ] }, "RefDoc": { "type": "object", "properties": { "refDocUID": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "name": { "type": "string", "nullable": true }, "fileSize": { "type": "integer", "format": "int32" }, "downloadURL": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RefDocDownloadResponse": { "type": "object", "properties": { "downloadURL": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RefDocDownloadResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/RefDocDownloadResponse" } }, "additionalProperties": false }, "RejectTaskRequest": { "type": "object", "properties": { "taskUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RenameDALFolderRequest": { "type": "object", "properties": { "folderUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReviewStatus": { "type": "object", "properties": { "pendingCount": { "type": "integer", "format": "int32" }, "approvedCount": { "type": "integer", "format": "int32" }, "rejectedCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RunWorkflowRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SendTaskReminderRequest": { "type": "object", "properties": { "taskUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetProjectFolderRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "folderUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetProjectKanbanColumnRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "kanbanColumnUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringStringDictionaryApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Task": { "type": "object", "properties": { "taskUID": { "type": "string", "nullable": true }, "projectId": { "type": "integer", "format": "int32" }, "projectUID": { "type": "string", "nullable": true }, "projectName": { "type": "string", "nullable": true }, "clientUID": { "type": "string", "nullable": true }, "project": { "$ref": "#/components/schemas/ProjectObj" }, "type": { "$ref": "#/components/schemas/TaskType" }, "status": { "$ref": "#/components/schemas/TaskStatus" }, "comment": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "closed": { "type": "string", "format": "date-time", "nullable": true }, "user": { "$ref": "#/components/schemas/User" }, "assets": { "type": "array", "items": { "type": "string" }, "nullable": true }, "reviewUrl": { "type": "string", "nullable": true }, "requestedAssetName": { "type": "string", "nullable": true }, "externalUserEmail": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaskApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/Task" } }, "additionalProperties": false }, "TaskArrayApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Task" }, "nullable": true } }, "additionalProperties": false }, "TaskData": { "type": "object", "properties": { "assignUsers": { "$ref": "#/components/schemas/AssignUsers" } }, "additionalProperties": false }, "TaskStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32", "x-enumNames": [ "Pending", "Closed", "Approved", "Rejected", "ApprovedWithChanges" ] }, "TaskType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer", "format": "int32", "x-enumNames": [ "UploadAssets", "UploadRefDocs", "ReviewAssets", "ExternalReviewAssets", "UploadChangedAsset", "UploadVideo", "ExternalReviewVideo", "ReviewVideo", "ExternalUploadAsset", "ExternalUploadRefdoc", "AssignUserRoles" ] }, "TestWebHookRequest": { "type": "object", "properties": { "webHookUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TriggerType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer", "format": "int32", "x-enumNames": [ "ProjectCreated", "InternalUploadAssetsTaskCompleted", "InternalUploadRefDocsTaskCompleted", "InternalReviewTaskRejected", "InternalReviewTaskApproved", "ExternalUploadAssetsTaskCompleted", "ExternalUploadRefDocsTaskCompleted", "ExternalReviewTaskRejected", "ExternalReviewTaskApproved", "UserRolesAssigned", "ManualTrigger" ] }, "UnCompleteAnnotationRequest": { "type": "object", "properties": { "annotationUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UploadAssetResponse": { "type": "object", "properties": { "assetUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UploadAssetResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/UploadAssetResponse" } }, "additionalProperties": false }, "UploadRefDocResponse": { "type": "object", "properties": { "refDocUID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UploadRefDocResponseApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/UploadRefDocResponse" } }, "additionalProperties": false }, "UploadUrlAssetRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UploadUrlRefDocRequest": { "type": "object", "properties": { "projectUID": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "User": { "type": "object", "properties": { "userUID": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/UserRole" }, "profileImageURL": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserRole": { "enum": [ 0, 1 ], "type": "integer", "format": "int32", "x-enumNames": [ "RegularUser", "Administrator" ] }, "UsersResult": { "type": "object", "properties": { "clients": { "type": "array", "items": { "$ref": "#/components/schemas/Client" }, "nullable": true } }, "additionalProperties": false, "description": "Returns all the users and (clients/tenants -- when are multiple)." }, "UsersResultApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/UsersResult" } }, "additionalProperties": false }, "WebHook": { "type": "object", "properties": { "webhookUID": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "eventType": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "WebHookApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "$ref": "#/components/schemas/WebHook" } }, "additionalProperties": false }, "WebHookArrayApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/WebHook" }, "nullable": true } }, "additionalProperties": false }, "Workflow": { "type": "object", "properties": { "workflowUID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "WorkflowActionDto": { "type": "object", "properties": { "uid": { "type": "string", "nullable": true }, "friendlyName": { "type": "string", "nullable": true }, "triggerType": { "$ref": "#/components/schemas/TriggerType" }, "reactionType": { "$ref": "#/components/schemas/ReactionType" }, "userUIDs": { "type": "array", "items": { "type": "string" }, "nullable": true }, "roleUids": { "type": "array", "items": { "type": "string" }, "nullable": true }, "triggerExecutorUid": { "type": "string", "nullable": true }, "triggerRoleUid": { "type": "string", "nullable": true }, "emailSubject": { "type": "string", "nullable": true }, "emailLanguage": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "checklistName": { "type": "string", "nullable": true }, "checklistItems": { "type": "array", "items": { "type": "string" }, "nullable": true }, "daysToDueDate": { "type": "integer", "format": "int32", "nullable": true }, "allowDownload": { "type": "boolean", "nullable": true }, "isSimpleMode": { "type": "boolean", "nullable": true }, "isCustomPayload": { "type": "boolean", "nullable": true }, "webhookURL": { "type": "string", "nullable": true }, "webhookRequestType": { "type": "string", "nullable": true }, "webhookContentType": { "type": "string", "nullable": true }, "webhookHeaders": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "webhookFields": { "type": "array", "items": { "type": "string" }, "nullable": true }, "webhookCustomFields": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "nullable": true }, "webhookCustomPayload": { "type": "string", "nullable": true }, "contacts": { "type": "string", "nullable": true }, "emailTemplateId": { "type": "integer", "format": "int32", "nullable": true }, "targetKanbanColumnUid": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorkflowArrayApiResponse": { "type": "object", "properties": { "version": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isError": { "type": "boolean", "nullable": true }, "responseException": { "nullable": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" }, "nullable": true } }, "additionalProperties": false }, "WorkflowRoleDto": { "type": "object", "properties": { "uid": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isInternal": { "type": "boolean" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "JWT Authorization header using the Bearer scheme. \r\n\r\n Enter 'Bearer' [space] and then your token in the text input below.\r\n\r\nExample: \"Bearer 12345abcdef\"", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "Annotation" }, { "name": "Asset" }, { "name": "DAL" }, { "name": "Links" }, { "name": "Project" }, { "name": "RefDoc" }, { "name": "Task" }, { "name": "Token" }, { "name": "User" }, { "name": "WebHook" }, { "name": "Workflow" } ] }