{ "openapi": "3.0.1", "info": { "title": "Aspose OMR Cloud 5.0 API", "description": "Aspose OMR Cloud 5.0 API", "termsOfService": "https://about.aspose.cloud/legal/tos", "contact": { "name": "Aspose", "url": "https://about.aspose.cloud/contact" }, "license": { "name": "License", "url": "https://about.aspose.cloud/legal" }, "version": "5.0" }, "paths": { "/v5.0/omr/GenerateTemplate/PostGenerateTemplate": { "post": { "tags": [ "GenerateTemplate" ], "summary": "PostGenerateTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmrGenerateTask" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "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" } } } } } } }, "/v5.0/omr/GenerateTemplate/GetGenerateTemplate": { "get": { "tags": [ "GenerateTemplate" ], "summary": "GetGenerateTemplate", "parameters": [ { "name": "id", "in": "query", "description": "Task id to select the result", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OMRResponse" } } } } } } }, "/v5.0/omr/GenerateTemplate/CancelGenerateTemplate": { "delete": { "tags": [ "GenerateTemplate" ], "summary": "CancelGenerateTemplate", "parameters": [ { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v5.0/omr/RecognizeTemplate/PostRecognizeTemplate": { "post": { "tags": [ "RecognizeTemplate" ], "summary": "PostRecognizeTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmrRecognizeTask" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "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" } } } } } } }, "/v5.0/omr/RecognizeTemplate/GetRecognizeTemplate": { "get": { "tags": [ "RecognizeTemplate" ], "summary": "GetRecognizeTemplate", "parameters": [ { "name": "id", "in": "query", "description": "Task id to select the result", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OMRResponse" } } } } } } }, "/v5.0/omr/RecognizeTemplate/CancelRecognizeTemplate": { "delete": { "tags": [ "RecognizeTemplate" ], "summary": "CancelRecognizeTemplate", "parameters": [ { "name": "id", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } } }, "components": { "schemas": { "BubbleSize": { "enum": [ "undefined", "Extrasmall", "Small", "Normal", "Large", "Extralarge" ], "type": "string" }, "Color": { "enum": [ "undefined", "AliceBlue", "AntiqueWhite", "Aqua", "Aquamarine", "Azure", "Beige", "Bisque", "Black", "BlanchedAlmond", "Blue", "BlueViolet", "Brown", "BurlyWood", "CadetBlue", "Chartreuse", "Chocolate", "Coral", "CornflowerBlue", "Cornsilk", "Crimson", "Cyan", "DarkBlue", "DarkCyan", "DarkGoldenrod", "DarkGray", "DarkGreen", "DarkKhaki", "DarkMagenta", "DarkOliveGreen", "DarkOrange", "DarkOrchid", "DarkRed", "DarkSalmon", "DarkSeaGreen", "DarkSlateBlue", "DarkSlateGray", "DarkTurquoise", "DarkViolet", "DeepPink", "DeepSkyBlue", "DimGray", "DodgerBlue", "Firebrick", "FloralWhite", "ForestGreen", "Fuchsia", "Gainsboro", "GhostWhite", "Gold", "Goldenrod", "Gray", "Green", "GreenYellow", "Honeydew", "HotPink", "IndianRed", "Indigo", "Ivory", "Khaki", "Lavender", "LavenderBlush", "LawnGreen", "LemonChiffon", "LightBlue", "LightCoral", "LightCyan", "LightGoldenrodYellow", "LightGray", "LightGreen", "LightPink", "LightSalmon", "LightSeaGreen", "LightSkyBlue", "LightSlateGray", "LightSteelBlue", "LightYellow", "Lime", "LimeGreen", "Linen", "Magenta", "Maroon", "MediumAquamarine", "MediumBlue", "MediumOrchid", "MediumPurple", "MediumSeaGreen", "MediumSlateBlue", "MediumSpringGreen", "MediumTurquoise", "MediumVioletRed", "MidnightBlue", "MintCream", "MistyRose", "Moccasin", "NavajoWhite", "Navy", "OldLace", "Olive", "OliveDrab", "Orange", "OrangeRed", "Orchid", "PaleGoldenrod", "PaleGreen", "PaleTurquoise", "PaleVioletRed", "PapayaWhip", "PeachPuff", "Peru", "Pink", "Plum", "PowderBlue", "Purple", "Red", "RosyBrown", "RoyalBlue", "SaddleBrown", "Salmon", "SandyBrown", "SeaGreen", "SeaShell", "Sienna", "Silver", "SkyBlue", "SlateBlue", "SlateGray", "Snow", "SpringGreen", "SteelBlue", "Tan", "Teal", "Thistle", "Tomato", "Turquoise", "Violet", "Wheat", "White", "WhiteSmoke", "Yellow", "YellowGreen" ], "type": "string" }, "FileExtension": { "enum": [ "Png", "Pdf", "Csv", "Json", "Txt", "Internal", "Jpg", "Omr" ], "type": "string", "description": "File type to correctly unpack and return to user" }, "FontStyle": { "enum": [ "undefined", "Bold", "Italic", "Underline", "Strikeout", "Regular" ], "type": "string" }, "OMRError": { "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "string" }, "description": "A list of various clear descriptions of the errors", "nullable": true, "readOnly": true }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Warning messages - non critical errors: e.g. some data lost", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Error to return to SDK client" }, "OmrGenerateTask": { "required": [ "images", "markupFile", "outputFormat", "settings" ], "type": "object", "properties": { "markupFile": { "type": "string", "description": "Gets or Sets markup file on JSON format", "format": "byte" }, "settings": { "$ref": "#/components/schemas/PageSettings" }, "images": { "type": "object", "additionalProperties": { "type": "string", "format": "byte" }, "description": "Gets or Sets Settings" }, "outputFormat": { "$ref": "#/components/schemas/FileExtension" } }, "additionalProperties": false, "description": "Combines Json file and OMR Generation settings" }, "OmrRecognizeTask": { "required": [ "images", "omrFile", "outputFormat" ], "type": "object", "properties": { "images": { "type": "array", "items": { "type": "string", "format": "byte" }, "description": "Gets or Sets Filled Template" }, "omrFile": { "type": "string", "description": "Gets or Sets Omr file", "format": "byte" }, "outputFormat": { "$ref": "#/components/schemas/FileExtension" }, "recognitionThreshold": { "type": "integer", "description": "Gets or Sets recognition threshold", "format": "int32" } }, "additionalProperties": false, "description": "Combines Filled Template data and OMR file for Recognition" }, "OMRResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The specific Task ID that result was made for", "nullable": true }, "ResponseStatusCode": { "$ref": "#/components/schemas/ResponseStatusCode" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/OMRResult" }, "description": "List of results - Template (PNG / PDF) and .omr file", "nullable": true }, "error": { "$ref": "#/components/schemas/OMRError" } }, "additionalProperties": false, "description": "Response with Recognition result for specific task ID" }, "OMRResult": { "type": "object", "properties": { "type": { "type": "string", "description": "File data type (extension)", "nullable": true }, "data": { "type": "string", "description": "File binary data", "format": "byte", "nullable": true } }, "additionalProperties": false, "description": "Represents information about response after OMR." }, "Orientation": { "enum": [ "undefined", "Vertical", "Horizontal" ], "type": "string" }, "PageSettings": { "type": "object", "properties": { "fontFamily": { "type": "string", "description": "The font family of the text", "nullable": true }, "fontStyle": { "$ref": "#/components/schemas/FontStyle" }, "fontSize": { "type": "integer", "description": "The size of the text font", "format": "int32" }, "paperSize": { "$ref": "#/components/schemas/PaperSize" }, "bubbleColor": { "$ref": "#/components/schemas/Color" }, "pageMarginLeft": { "type": "integer", "description": "Left margin of the page on pixels", "format": "int32" }, "pageMarginRight": { "type": "integer", "description": "Left margin of the page on pixels", "format": "int32" }, "orientation": { "$ref": "#/components/schemas/Orientation" }, "bubbleSize": { "$ref": "#/components/schemas/BubbleSize" }, "outputFormat": { "$ref": "#/components/schemas/FileExtension" } }, "additionalProperties": false, "description": "The global settings applicable to all page elements." }, "PaperSize": { "enum": [ "undefined", "A4", "Legal", "Tabloid", "p8519", "p8521", "A3", "Letter" ], "type": "string" }, "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": { } }, "ResponseStatusCode": { "enum": [ "undefined", "Ok", "PartiallyNotFound", "NoAnyResultData", "ResultDataLost", "TaskNotFound", "NotReady", "Error" ], "type": "string", "description": "Status code showing the status of the request, operation, and result processing." } }, "securitySchemes": { "JWT": { "type": "oauth2", "description": "Please enter APP SID & KEY", "flows": { "clientCredentials": { "tokenUrl": "https://api.aspose.cloud/connect/token", "scopes": { } } } } } }, "security": [ { "JWT": [ ] } ] }