{ "x-generator": "NSwag v12.0.14.0 (NJsonSchema v9.13.18.0 (Newtonsoft.Json v13.0.0.0))", "swagger": "2.0", "info": { "title": "Aspose.PDF Cloud API Reference", "version": "3.0" }, "host": "api.aspose.cloud", "basePath": "/v3.0", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/pdf/{name}/annotations": { "get": { "tags": [ "Annotations" ], "summary": "Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.", "operationId": "GetDocumentAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AnnotationsInfoResponse with the page annotations info.", "schema": { "$ref": "#/definitions/AnnotationsInfoResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Annotations" ], "summary": "Delete all annotations from the document", "operationId": "DeleteDocumentAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations": { "get": { "tags": [ "Annotations" ], "summary": "Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.", "operationId": "GetPageAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AnnotationsInfoResponse with the page annotations info.", "schema": { "$ref": "#/definitions/AnnotationsInfoResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Annotations" ], "summary": "Delete all annotations from the page", "operationId": "DeletePageAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/flatten": { "put": { "tags": [ "Annotations" ], "summary": "Flattens the annotations of the specified types", "operationId": "PutAnnotationsFlatten", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "startPage", "in": "query", "description": "The start page number.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endPage", "in": "query", "description": "The end page number.", "format": "int32", "x-nullable": true }, { "type": "array", "name": "annotationTypes", "in": "query", "description": "Array of annotation types.", "collectionFormat": "multi", "x-nullable": true, "items": { "$ref": "#/definitions/AnnotationType" } }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/freetext": { "get": { "tags": [ "Annotations" ], "summary": "Read document free text annotations.", "operationId": "GetDocumentFreeTextAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "FreeTextAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/FreeTextAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/freetext": { "get": { "tags": [ "Annotations" ], "summary": "Read document page free text annotations.", "operationId": "GetPageFreeTextAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "FreeTextAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/FreeTextAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page free text annotations.", "operationId": "PostPageFreeTextAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/FreeTextAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with the annotation data.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/freetext/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page free text annotation by ID.", "operationId": "GetFreeTextAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "FreeTextAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/FreeTextAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document free text annotation", "operationId": "PutFreeTextAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/FreeTextAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "FreeTextAnnotationResponse with the free text annotation.", "schema": { "$ref": "#/definitions/FreeTextAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/text": { "get": { "tags": [ "Annotations" ], "summary": "Read document text annotations.", "operationId": "GetDocumentTextAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "TextAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/TextAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/text": { "get": { "tags": [ "Annotations" ], "summary": "Read document page text annotations.", "operationId": "GetPageTextAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "TextAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/TextAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page text annotations.", "operationId": "PostPageTextAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/TextAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "TextAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/text/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page text annotation by ID.", "operationId": "GetTextAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "TextAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/TextAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document text annotation", "operationId": "PutTextAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/TextAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "TextAnnotationResponse with the free text annotation.", "schema": { "$ref": "#/definitions/TextAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/line": { "get": { "tags": [ "Annotations" ], "summary": "Read document line annotations.", "operationId": "GetDocumentLineAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "LineAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/LineAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/line": { "get": { "tags": [ "Annotations" ], "summary": "Read document page line annotations.", "operationId": "GetPageLineAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "LineAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/LineAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page line annotations.", "operationId": "PostPageLineAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/LineAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/line/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page line annotation by ID.", "operationId": "GetLineAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "LineAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/LineAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document line annotation", "operationId": "PutLineAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/LineAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "LineAnnotationResponse with the free text annotation.", "schema": { "$ref": "#/definitions/LineAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/square": { "get": { "tags": [ "Annotations" ], "summary": "Read document square annotations.", "operationId": "GetDocumentSquareAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SquareAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/SquareAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/square": { "get": { "tags": [ "Annotations" ], "summary": "Read document page square annotations.", "operationId": "GetPageSquareAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SquareAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/SquareAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page square annotations.", "operationId": "PostPageSquareAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/SquareAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/square/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page square annotation by ID.", "operationId": "GetSquareAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SquareAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/SquareAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document square annotation", "operationId": "PutSquareAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/SquareAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SquareAnnotationResponse with the free text annotation.", "schema": { "$ref": "#/definitions/SquareAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/circle": { "get": { "tags": [ "Annotations" ], "summary": "Read document circle annotations.", "operationId": "GetDocumentCircleAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "CircleAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/CircleAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/circle": { "get": { "tags": [ "Annotations" ], "summary": "Read document page circle annotations.", "operationId": "GetPageCircleAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "CircleAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/CircleAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page circle annotations.", "operationId": "PostPageCircleAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/CircleAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/circle/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page circle annotation by ID.", "operationId": "GetCircleAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "CircleAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/CircleAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document circle annotation", "operationId": "PutCircleAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/CircleAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "CircleAnnotationResponse with the circle annotation.", "schema": { "$ref": "#/definitions/CircleAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/polygon": { "get": { "tags": [ "Annotations" ], "summary": "Read document polygon annotations.", "operationId": "GetDocumentPolygonAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PolygonAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/PolygonAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/polygon": { "get": { "tags": [ "Annotations" ], "summary": "Read document page polygon annotations.", "operationId": "GetPagePolygonAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PolygonAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/PolygonAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page polygon annotations.", "operationId": "PostPagePolygonAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/PolygonAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/polygon/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page polygon annotation by ID.", "operationId": "GetPolygonAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PolygonAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/PolygonAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document polygon annotation", "operationId": "PutPolygonAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/PolygonAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PolygonAnnotationResponse with the polygon annotation.", "schema": { "$ref": "#/definitions/PolygonAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/polyline": { "get": { "tags": [ "Annotations" ], "summary": "Read document polyline annotations.", "operationId": "GetDocumentPolyLineAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PolyLineAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/PolyLineAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/polyline": { "get": { "tags": [ "Annotations" ], "summary": "Read document page polyline annotations.", "operationId": "GetPagePolyLineAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PolyLineAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/PolyLineAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page polyline annotations.", "operationId": "PostPagePolyLineAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/PolyLineAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/polyline/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page polyline annotation by ID.", "operationId": "GetPolyLineAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PolyLineAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/PolyLineAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document polyline annotation", "operationId": "PutPolyLineAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/PolyLineAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PolyLineAnnotationResponse with the polyline annotation.", "schema": { "$ref": "#/definitions/PolyLineAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/highlight": { "get": { "tags": [ "Annotations" ], "summary": "Read document highlight annotations.", "operationId": "GetDocumentHighlightAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "HighlightAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/HighlightAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/highlight": { "get": { "tags": [ "Annotations" ], "summary": "Read document page highlight annotations.", "operationId": "GetPageHighlightAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "HighlightAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/HighlightAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page highlight annotations.", "operationId": "PostPageHighlightAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/HighlightAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/highlight/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page highlight annotation by ID.", "operationId": "GetHighlightAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "HighlightAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/HighlightAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document highlight annotation", "operationId": "PutHighlightAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/HighlightAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "HighlightAnnotationResponse with the highlight annotation.", "schema": { "$ref": "#/definitions/HighlightAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/underline": { "get": { "tags": [ "Annotations" ], "summary": "Read document underline annotations.", "operationId": "GetDocumentUnderlineAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "UnderlineAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/UnderlineAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/underline": { "get": { "tags": [ "Annotations" ], "summary": "Read document page underline annotations.", "operationId": "GetPageUnderlineAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "UnderlineAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/UnderlineAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page underline annotations.", "operationId": "PostPageUnderlineAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/UnderlineAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/underline/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page underline annotation by ID.", "operationId": "GetUnderlineAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "UnderlineAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/UnderlineAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document underline annotation", "operationId": "PutUnderlineAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/UnderlineAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "UnderlineAnnotationResponse with the underline annotation.", "schema": { "$ref": "#/definitions/UnderlineAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/squiggly": { "get": { "tags": [ "Annotations" ], "summary": "Read document squiggly annotations.", "operationId": "GetDocumentSquigglyAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SquigglyAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/SquigglyAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/squiggly": { "get": { "tags": [ "Annotations" ], "summary": "Read document page squiggly annotations.", "operationId": "GetPageSquigglyAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SquigglyAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/SquigglyAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page squiggly annotations.", "operationId": "PostPageSquigglyAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/SquigglyAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/squiggly/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page squiggly annotation by ID.", "operationId": "GetSquigglyAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SquigglyAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/SquigglyAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document squiggly annotation", "operationId": "PutSquigglyAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/SquigglyAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SquigglyAnnotationResponse with the squiggly annotation.", "schema": { "$ref": "#/definitions/SquigglyAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/strikeout": { "get": { "tags": [ "Annotations" ], "summary": "Read document StrikeOut annotations.", "operationId": "GetDocumentStrikeOutAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "StrikeOutAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/StrikeOutAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/strikeout": { "get": { "tags": [ "Annotations" ], "summary": "Read document page StrikeOut annotations.", "operationId": "GetPageStrikeOutAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "StrikeOutAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/StrikeOutAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page StrikeOut annotations.", "operationId": "PostPageStrikeOutAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/StrikeOutAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/strikeout/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page StrikeOut annotation by ID.", "operationId": "GetStrikeOutAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "StrikeOutAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/StrikeOutAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document StrikeOut annotation", "operationId": "PutStrikeOutAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/StrikeOutAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "StrikeOutAnnotationResponse with the strikeout annotation.", "schema": { "$ref": "#/definitions/StrikeOutAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/caret": { "get": { "tags": [ "Annotations" ], "summary": "Read document caret annotations.", "operationId": "GetDocumentCaretAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "CaretAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/CaretAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/caret": { "get": { "tags": [ "Annotations" ], "summary": "Read document page caret annotations.", "operationId": "GetPageCaretAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "CaretAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/CaretAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page caret annotations.", "operationId": "PostPageCaretAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/CaretAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/caret/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page caret annotation by ID.", "operationId": "GetCaretAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "CaretAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/CaretAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document caret annotation", "operationId": "PutCaretAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/CaretAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "CaretAnnotationResponse with the caret annotation.", "schema": { "$ref": "#/definitions/CaretAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/ink": { "get": { "tags": [ "Annotations" ], "summary": "Read document ink annotations.", "operationId": "GetDocumentInkAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "InkAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/InkAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/ink": { "get": { "tags": [ "Annotations" ], "summary": "Read document page ink annotations.", "operationId": "GetPageInkAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "InkAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/InkAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page ink annotations.", "operationId": "PostPageInkAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/InkAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/ink/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page ink annotation by ID.", "operationId": "GetInkAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "InkAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/InkAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document ink annotation", "operationId": "PutInkAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/InkAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "InkAnnotationResponse with the ink annotation.", "schema": { "$ref": "#/definitions/InkAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/popup": { "get": { "tags": [ "Annotations" ], "summary": "Read document popup annotations.", "operationId": "GetDocumentPopupAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PopupAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/PopupAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/{annotationId}/popup": { "get": { "tags": [ "Annotations" ], "summary": "Read document popup annotations by parent id.", "operationId": "GetDocumentPopupAnnotationsByParent", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The parent annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PopupAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/PopupAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document popup annotations.", "operationId": "PostPopupAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The parent annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "The annotation.", "schema": { "$ref": "#/definitions/PopupAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/popup": { "get": { "tags": [ "Annotations" ], "summary": "Read document page popup annotations.", "operationId": "GetPagePopupAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PopupAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/PopupAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/popup/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page popup annotation by ID.", "operationId": "GetPopupAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PopupAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/PopupAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document popup annotation", "operationId": "PutPopupAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/PopupAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "PopupAnnotationResponse with the popup annotation.", "schema": { "$ref": "#/definitions/PopupAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/fileattachment": { "get": { "tags": [ "Annotations" ], "summary": "Read document FileAttachment annotations.", "operationId": "GetDocumentFileAttachmentAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "FileAttachmentAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/FileAttachmentAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/fileattachment": { "get": { "tags": [ "Annotations" ], "summary": "Read document page FileAttachment annotations.", "operationId": "GetPageFileAttachmentAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "FileAttachmentAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/FileAttachmentAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page FileAttachment annotations.", "operationId": "PostPageFileAttachmentAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "Annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/FileAttachmentAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/fileattachment/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page FileAttachment annotation by ID.", "operationId": "GetFileAttachmentAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "FileAttachmentAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/FileAttachmentAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document FileAttachment annotation", "operationId": "PutFileAttachmentAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/FileAttachmentAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "FileAttachmentAnnotationResponse with the FileAttachment annotation.", "schema": { "$ref": "#/definitions/FileAttachmentAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/fileattachment/{annotationId}/data": { "get": { "tags": [ "Annotations" ], "summary": "Read document page FileAttachment annotation by ID.", "operationId": "GetFileAttachmentAnnotationData", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with the annotation data of file.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/fileattachment/{annotationId}/data/extract": { "put": { "tags": [ "Annotations" ], "summary": "Extract document FileAttachment annotation content to storage", "operationId": "PutFileAttachmentAnnotationDataExtract", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "outFolder", "in": "query", "description": "The output folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/sound": { "get": { "tags": [ "Annotations" ], "summary": "Read document sound annotations.", "operationId": "GetDocumentSoundAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SoundAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/SoundAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/sound": { "get": { "tags": [ "Annotations" ], "summary": "Read document page sound annotations.", "operationId": "GetPageSoundAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SoundAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/SoundAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page sound annotations.", "operationId": "PostPageSoundAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/SoundAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/sound/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page sound annotation by ID.", "operationId": "GetSoundAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SoundAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/SoundAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document sound annotation", "operationId": "PutSoundAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/SoundAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SoundAnnotationResponse with the sound annotation.", "schema": { "$ref": "#/definitions/SoundAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/sound/{annotationId}/data": { "get": { "tags": [ "Annotations" ], "summary": "Read document page sound annotation by ID.", "operationId": "GetSoundAnnotationData", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with the annotation data of file.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/sound/{annotationId}/data/extract": { "put": { "tags": [ "Annotations" ], "summary": "Extract document sound annotation content to storage", "operationId": "PutSoundAnnotationDataExtract", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "outFilePath", "in": "query", "required": true, "description": "The output file path.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/redaction": { "get": { "tags": [ "Annotations" ], "summary": "Read document redaction annotations.", "operationId": "GetDocumentRedactionAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "RedactionAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/RedactionAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/redaction": { "get": { "tags": [ "Annotations" ], "summary": "Read document page redaction annotations.", "operationId": "GetPageRedactionAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "RedactionAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/RedactionAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page redaction annotations.", "operationId": "PostPageRedactionAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/RedactionAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "boolean", "name": "apply", "in": "query", "description": "Apply redaction immediately after adding.", "default": false, "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/redaction/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page redaction annotation by ID.", "operationId": "GetRedactionAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "RedactionAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/RedactionAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document redaction annotation", "operationId": "PutRedactionAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/RedactionAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "boolean", "name": "apply", "in": "query", "description": "Apply redaction immediately after adding.", "default": false, "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "RedactionAnnotationResponse with the redaction annotation.", "schema": { "$ref": "#/definitions/RedactionAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/movie": { "get": { "tags": [ "Annotations" ], "summary": "Read document movie annotations.", "operationId": "GetDocumentMovieAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "MovieAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/MovieAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/movie": { "get": { "tags": [ "Annotations" ], "summary": "Read document page movie annotations.", "operationId": "GetPageMovieAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "MovieAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/MovieAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page movie annotations.", "operationId": "PostPageMovieAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/MovieAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/movie/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page movie annotation by ID.", "operationId": "GetMovieAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "MovieAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/MovieAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document movie annotation", "operationId": "PutMovieAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/MovieAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "MovieAnnotationResponse with the movie annotation.", "schema": { "$ref": "#/definitions/MovieAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/screen": { "get": { "tags": [ "Annotations" ], "summary": "Read document screen annotations.", "operationId": "GetDocumentScreenAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ScreenAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/ScreenAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/screen": { "get": { "tags": [ "Annotations" ], "summary": "Read document page screen annotations.", "operationId": "GetPageScreenAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ScreenAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/ScreenAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page screen annotations.", "operationId": "PostPageScreenAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/ScreenAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/screen/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page screen annotation by ID.", "operationId": "GetScreenAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ScreenAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/ScreenAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document screen annotation", "operationId": "PutScreenAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/ScreenAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ScreenAnnotationResponse with the screen annotation.", "schema": { "$ref": "#/definitions/ScreenAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/screen/{annotationId}/data": { "get": { "tags": [ "Annotations" ], "summary": "Read document page screen annotation by ID.", "operationId": "GetScreenAnnotationData", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with the annotation data of file.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/screen/{annotationId}/data/extract": { "put": { "tags": [ "Annotations" ], "summary": "Extract document screen annotation content to storage", "operationId": "PutScreenAnnotationDataExtract", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "outFilePath", "in": "query", "required": true, "description": "The output file path.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/stamp": { "get": { "tags": [ "Annotations" ], "summary": "Read document stamp annotations.", "operationId": "GetDocumentStampAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "StampAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/StampAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/annotations/stamp": { "get": { "tags": [ "Annotations" ], "summary": "Read document page stamp annotations.", "operationId": "GetPageStampAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "StampAnnotationsResponse with the annotation data.", "schema": { "$ref": "#/definitions/StampAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Annotations" ], "summary": "Add document page stamp annotations.", "operationId": "PostPageStampAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "annotations", "in": "body", "required": true, "description": "The array of annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/StampAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/stamp/{annotationId}": { "get": { "tags": [ "Annotations" ], "summary": "Read document page stamp annotation by ID.", "operationId": "GetStampAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "StampAnnotationResponse with the annotation data.", "schema": { "$ref": "#/definitions/StampAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Annotations" ], "summary": "Replace document stamp annotation", "operationId": "PutStampAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "name": "annotation", "in": "body", "required": true, "description": "Annotation.", "schema": { "$ref": "#/definitions/StampAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "StampAnnotationResponse with the stamp annotation.", "schema": { "$ref": "#/definitions/StampAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/stamp/{annotationId}/data": { "get": { "tags": [ "Annotations" ], "summary": "Read document page stamp annotation by ID.", "operationId": "GetStampAnnotationData", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with the annotation data of file.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/stamp/{annotationId}/data/extract": { "put": { "tags": [ "Annotations" ], "summary": "Extract document stamp annotation content to storage", "operationId": "PutStampAnnotationDataExtract", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "outFilePath", "in": "query", "required": true, "description": "The output file path.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/annotations/{annotationId}": { "delete": { "tags": [ "Annotations" ], "summary": "Delete document annotation by ID", "operationId": "DeleteAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "annotationId", "in": "path", "required": true, "description": "The annotation ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/appendDocument": { "post": { "tags": [ "Append" ], "summary": "Append document to existing one.", "operationId": "PostAppendDocument", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The original document name.", "x-nullable": false }, { "type": "string", "name": "appendFile", "in": "query", "required": true, "description": "Append file server path.", "x-nullable": true }, { "type": "integer", "name": "startPage", "in": "query", "description": "Appending start page.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "integer", "name": "endPage", "in": "query", "description": "Appending end page.", "format": "int32", "default": 0, "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The documents storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The original document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DocumentResponse with the updated document data.", "schema": { "$ref": "#/definitions/DocumentResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/attachments": { "post": { "tags": [ "Attachments" ], "summary": "Adds a file attachment to the PDF document.", "operationId": "PostAddDocumentAttachment", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "attachmentInfo", "in": "body", "required": true, "description": "AttachmentInfoAttachmentInfo instance.", "schema": { "$ref": "#/definitions/AttachmentInfo" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AttachmentsResponse with the attachments info.", "schema": { "$ref": "#/definitions/AttachmentsResponse" } } }, "security": [ { "JWT": [] } ] }, "get": { "tags": [ "Attachments" ], "summary": "Read document attachments info.", "operationId": "GetDocumentAttachments", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AttachmentsResponse with the attachments info.", "schema": { "$ref": "#/definitions/AttachmentsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/attachments/{attachmentIndex}": { "get": { "tags": [ "Attachments" ], "summary": "Read document attachment info by its index.", "operationId": "GetDocumentAttachmentByIndex", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "attachmentIndex", "in": "path", "required": true, "description": "The attachment index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AttachmentResponse with the attachment data.", "schema": { "$ref": "#/definitions/AttachmentResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/attachments/{attachmentIndex}/download": { "get": { "tags": [ "Attachments" ], "summary": "Download document attachment content by its index.", "operationId": "GetDownloadDocumentAttachmentByIndex", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "attachmentIndex", "in": "path", "required": true, "description": "The attachment index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "HttpResponseMessage with the attachment content.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/bookmarks/tree": { "get": { "tags": [ "Bookmarks" ], "summary": "Read document bookmarks tree.", "operationId": "GetDocumentBookmarks", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "BookmarksResponse with the page Bookmarks info.", "schema": { "$ref": "#/definitions/BookmarksResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Bookmarks" ], "summary": "Delete all document bookmarks.", "operationId": "DeleteDocumentBookmarks", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/bookmarks/list/{bookmarkPath}": { "get": { "tags": [ "Bookmarks" ], "summary": "Read document bookmarks node list.", "operationId": "GetBookmarks", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "bookmarkPath", "in": "path", "required": true, "description": "The bookmark path.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "BookmarksResponse with the page Bookmarks info.", "schema": { "$ref": "#/definitions/BookmarksResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/bookmarks/bookmark/{bookmarkPath}": { "get": { "tags": [ "Bookmarks" ], "summary": "Read document bookmark.", "operationId": "GetBookmark", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "bookmarkPath", "in": "path", "required": true, "description": "The bookmark path.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "BookmarkResponse with the page Bookmark info.", "schema": { "$ref": "#/definitions/BookmarkResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Bookmarks" ], "summary": "Add document bookmarks.", "operationId": "PostBookmark", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "bookmarkPath", "in": "path", "required": true, "description": "The parent bookmark path. Specify an empty string when adding a bookmark to the root.", "x-nullable": false }, { "name": "bookmarks", "in": "body", "required": true, "description": "The array of bookmark.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Bookmark" } }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "BookmarksResponse with the page Bookmarks info.", "schema": { "$ref": "#/definitions/BookmarksResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Bookmarks" ], "summary": "Update document bookmark.", "operationId": "PutBookmark", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "bookmarkPath", "in": "path", "required": true, "description": "The bookmark path.", "x-nullable": false }, { "name": "bookmark", "in": "body", "required": true, "description": "The bookmark.", "schema": { "$ref": "#/definitions/Bookmark" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "BookmarkResponse with the page Bookmark info.", "schema": { "$ref": "#/definitions/BookmarkResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Bookmarks" ], "summary": "Delete document bookmark by ID.", "operationId": "DeleteBookmark", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "bookmarkPath", "in": "path", "required": true, "description": "The bookmark path.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/markdown": { "get": { "tags": [ "Convert" ], "summary": "Convert MD file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetMarkdownInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.md)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/markdown": { "put": { "tags": [ "Convert" ], "summary": "Convert MD file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutMarkdownInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.md)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/text": { "get": { "tags": [ "Text" ], "summary": "Read document text.", "operationId": "GetText", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "array", "name": "format", "in": "query", "description": "List of formats for search.", "collectionFormat": "multi", "x-nullable": true, "items": { "type": "string" } }, { "type": "string", "name": "regex", "in": "query", "description": "Formats are specified as a regular expression.", "x-nullable": true }, { "type": "boolean", "name": "splitRects", "in": "query", "description": "Split result fragments (default is true).", "default": true, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "number", "name": "LLX", "in": "query", "required": true, "description": "X-coordinate of lower - left corner.", "format": "double", "x-nullable": false }, { "type": "number", "name": "LLY", "in": "query", "required": true, "description": "Y - coordinate of lower-left corner.", "format": "double", "x-nullable": false }, { "type": "number", "name": "URX", "in": "query", "required": true, "description": "X - coordinate of upper-right corner.", "format": "double", "x-nullable": false }, { "type": "number", "name": "URY", "in": "query", "required": true, "description": "Y - coordinate of upper-right corner.", "format": "double", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "", "schema": { "$ref": "#/definitions/TextRectsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/text": { "get": { "tags": [ "Text" ], "summary": "Read page text items.", "operationId": "GetPageText", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "Number of page (starting from 1).", "format": "int32", "x-nullable": false }, { "type": "array", "name": "format", "in": "query", "description": "List of formats for search.", "collectionFormat": "multi", "x-nullable": true, "items": { "type": "string" } }, { "type": "string", "name": "regex", "in": "query", "description": "Formats are specified as a regular expression.", "x-nullable": true }, { "type": "boolean", "name": "splitRects", "in": "query", "description": "Split result fragments (default is true).", "default": true, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "number", "name": "LLX", "in": "query", "required": true, "description": "X-coordinate of lower - left corner.", "format": "double", "x-nullable": false }, { "type": "number", "name": "LLY", "in": "query", "required": true, "description": "Y - coordinate of lower-left corner.", "format": "double", "x-nullable": false }, { "type": "number", "name": "URX", "in": "query", "required": true, "description": "X - coordinate of upper-right corner.", "format": "double", "x-nullable": false }, { "type": "number", "name": "URY", "in": "query", "required": true, "description": "Y - coordinate of upper-right corner.", "format": "double", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "", "schema": { "$ref": "#/definitions/TextRectsResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Text" ], "summary": "Add text to PDF document page.", "operationId": "PutAddText", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "Number of page (starting from 1).", "format": "int32", "x-nullable": false }, { "name": "paragraph", "in": "body", "required": true, "description": "Paragraph data.", "schema": { "$ref": "#/definitions/Paragraph" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "Document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/text": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to Text format and returns resulting file in response content", "operationId": "GetPdfInStorageToText", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/aps": { "get": { "tags": [ "Convert" ], "summary": "Convert APS file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetApsInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.xps)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/aps": { "put": { "tags": [ "Convert" ], "summary": "Convert APS file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutApsInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.xps)", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/epub": { "get": { "tags": [ "Convert" ], "summary": "Convert EPUB file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetEpubInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.epub)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/epub": { "put": { "tags": [ "Convert" ], "summary": "Convert EPUB file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutEpubInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.epub)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/html": { "get": { "tags": [ "Convert" ], "summary": "Convert HTML file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetHtmlInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.zip)", "x-nullable": true }, { "type": "string", "name": "htmlFileName", "in": "query", "description": "Name of HTML file in ZIP.", "x-nullable": true }, { "type": "number", "name": "height", "in": "query", "description": "Page height", "format": "double", "x-nullable": true }, { "type": "number", "name": "width", "in": "query", "description": "Page width", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "isLandscape", "in": "query", "description": "Is page landscaped", "x-nullable": true }, { "type": "number", "name": "marginLeft", "in": "query", "description": "Page margin left", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginBottom", "in": "query", "description": "Page margin bottom", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginRight", "in": "query", "description": "Page margin right", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginTop", "in": "query", "description": "Page margin top", "format": "double", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Convert" ], "summary": "Convert HTML file (zip archive in request content) to PDF format and return resulting file in response. ", "operationId": "PostHtmlToPdf", "consumes": [ "multipart/form-data" ], "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "htmlFileName", "in": "query", "description": "Name of HTML file in ZIP.", "x-nullable": true }, { "type": "number", "name": "height", "in": "query", "description": "Page height", "format": "double", "x-nullable": true }, { "type": "number", "name": "width", "in": "query", "description": "Page width", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "isLandscape", "in": "query", "description": "Is page landscaped", "x-nullable": true }, { "type": "number", "name": "marginLeft", "in": "query", "description": "Page margin left", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginBottom", "in": "query", "description": "Page margin bottom", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginRight", "in": "query", "description": "Page margin right", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginTop", "in": "query", "description": "Page margin top", "format": "double", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/html": { "put": { "tags": [ "Convert" ], "summary": "Convert HTML file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutHtmlInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.zip)", "x-nullable": true }, { "type": "string", "name": "htmlFileName", "in": "query", "description": "Name of HTML file in ZIP.", "x-nullable": true }, { "type": "number", "name": "height", "in": "query", "description": "Page height", "format": "double", "x-nullable": true }, { "type": "number", "name": "width", "in": "query", "description": "Page width", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "isLandscape", "in": "query", "description": "Is page landscaped", "x-nullable": true }, { "type": "number", "name": "marginLeft", "in": "query", "description": "Page margin left", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginBottom", "in": "query", "description": "Page margin bottom", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginRight", "in": "query", "description": "Page margin right", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginTop", "in": "query", "description": "Page margin top", "format": "double", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/images": { "put": { "tags": [ "Convert" ], "summary": "Convert image file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutImageInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "imageTemplates", "in": "body", "required": true, "description": "ImageTemplatesRequestImage templates", "schema": { "$ref": "#/definitions/ImageTemplatesRequest" }, "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/mht": { "get": { "tags": [ "Convert" ], "summary": "Convert MHT file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetMhtInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.mht)", "x-nullable": true }, { "type": "number", "name": "height", "in": "query", "description": "Page height", "format": "double", "x-nullable": true }, { "type": "number", "name": "width", "in": "query", "description": "Page width", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginLeft", "in": "query", "description": "Page margin left", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginBottom", "in": "query", "description": "Page margin bottom", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginRight", "in": "query", "description": "Page margin right", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginTop", "in": "query", "description": "Page margin top", "format": "double", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/mht": { "put": { "tags": [ "Convert" ], "summary": "Convert MHT file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutMhtInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.mht)", "x-nullable": true }, { "type": "number", "name": "height", "in": "query", "description": "Page height", "format": "double", "x-nullable": true }, { "type": "number", "name": "width", "in": "query", "description": "Page width", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginLeft", "in": "query", "description": "Page margin left", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginBottom", "in": "query", "description": "Page margin bottom", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginRight", "in": "query", "description": "Page margin right", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginTop", "in": "query", "description": "Page margin top", "format": "double", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/pcl": { "get": { "tags": [ "Convert" ], "summary": "Convert PCL file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetPclInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.pcl)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/pcl": { "put": { "tags": [ "Convert" ], "summary": "Convert PCL file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutPclInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.pcl)", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/pdfa": { "get": { "tags": [ "Convert" ], "summary": "Convert PDFA file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetPdfAInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.pdf)", "x-nullable": true }, { "type": "boolean", "name": "dontOptimize", "in": "query", "description": "If set, document resources will not be optimized.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/pdfa": { "put": { "tags": [ "Convert" ], "summary": "Convert PDFA file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutPdfAInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.pdf)", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "boolean", "name": "dontOptimize", "in": "query", "description": "If set, document resources will not be optimized.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/aps": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to APS format and returns resulting file in response content", "operationId": "GetPdfInStorageToAps", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to APS format and uploads resulting file to storage", "operationId": "PutPdfInStorageToAps", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.aps)", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/aps": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to APS format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToAps", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.aps)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/doc": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to DOC format and returns resulting file in response content.", "operationId": "GetPdfInStorageToDoc", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "boolean", "name": "addReturnToLineEnd", "in": "query", "description": "Add return to line end.", "x-nullable": true }, { "type": "string", "name": "format", "in": "query", "description": "Allows to specify .doc or .docx file format.", "x-schema": { "$ref": "#/definitions/DocFormat" }, "x-nullable": true, "enum": [ "Doc", "DocX" ] }, { "type": "integer", "name": "imageResolutionX", "in": "query", "description": "Image resolution X.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "imageResolutionY", "in": "query", "description": "Image resolution Y.", "format": "int32", "x-nullable": true }, { "type": "number", "name": "maxDistanceBetweenTextLines", "in": "query", "description": "Max distance between text lines.", "format": "double", "x-nullable": true }, { "type": "string", "name": "mode", "in": "query", "description": "Allows to control how a PDF document is converted into a word processing document.", "x-schema": { "$ref": "#/definitions/DocRecognitionMode" }, "x-nullable": true, "enum": [ "Textbox", "Flow", "EnhancedFlow" ] }, { "type": "boolean", "name": "recognizeBullets", "in": "query", "description": "Recognize bullets.", "x-nullable": true }, { "type": "number", "name": "relativeHorizontalProximity", "in": "query", "description": "Relative horizontal proximity.", "format": "double", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to DOC format and uploads resulting file to storage.", "operationId": "PutPdfInStorageToDoc", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.doc)", "x-nullable": true }, { "type": "boolean", "name": "addReturnToLineEnd", "in": "query", "description": "Add return to line end.", "x-nullable": true }, { "type": "string", "name": "format", "in": "query", "description": "Allows to specify .doc or .docx file format.", "x-schema": { "$ref": "#/definitions/DocFormat" }, "x-nullable": true, "enum": [ "Doc", "DocX" ] }, { "type": "integer", "name": "imageResolutionX", "in": "query", "description": "Image resolution X.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "imageResolutionY", "in": "query", "description": "Image resolution Y.", "format": "int32", "x-nullable": true }, { "type": "number", "name": "maxDistanceBetweenTextLines", "in": "query", "description": "Max distance between text lines.", "format": "double", "x-nullable": true }, { "type": "string", "name": "mode", "in": "query", "description": "Allows to control how a PDF document is converted into a word processing document.", "x-schema": { "$ref": "#/definitions/DocRecognitionMode" }, "x-nullable": true, "enum": [ "Textbox", "Flow", "EnhancedFlow" ] }, { "type": "boolean", "name": "recognizeBullets", "in": "query", "description": "Recognize bullets.", "x-nullable": true }, { "type": "number", "name": "relativeHorizontalProximity", "in": "query", "description": "Relative horizontal proximity.", "format": "double", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/doc": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to DOC format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToDoc", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.doc)", "x-nullable": true }, { "type": "boolean", "name": "addReturnToLineEnd", "in": "query", "description": "Add return to line end.", "x-nullable": true }, { "type": "string", "name": "format", "in": "query", "description": "Allows to specify .doc or .docx file format.", "x-schema": { "$ref": "#/definitions/DocFormat" }, "x-nullable": true, "enum": [ "Doc", "DocX" ] }, { "type": "integer", "name": "imageResolutionX", "in": "query", "description": "Image resolution X.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "imageResolutionY", "in": "query", "description": "Image resolution Y.", "format": "int32", "x-nullable": true }, { "type": "number", "name": "maxDistanceBetweenTextLines", "in": "query", "description": "Max distance between text lines.", "format": "double", "x-nullable": true }, { "type": "string", "name": "mode", "in": "query", "description": "Allows to control how a PDF document is converted into a word processing document.", "x-schema": { "$ref": "#/definitions/DocRecognitionMode" }, "x-nullable": true, "enum": [ "Textbox", "Flow", "EnhancedFlow" ] }, { "type": "boolean", "name": "recognizeBullets", "in": "query", "description": "Recognize bullets.", "x-nullable": true }, { "type": "number", "name": "relativeHorizontalProximity", "in": "query", "description": "Relative horizontal proximity.", "format": "double", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/epub": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to EPUB format and returns resulting file in response content", "operationId": "GetPdfInStorageToEpub", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "contentRecognitionMode", "in": "query", "description": "Property tunes conversion for this or that desirable method of recognition of content.", "x-schema": { "$ref": "#/definitions/EpubRecognitionMode" }, "x-nullable": true, "enum": [ "Flow", "PdfFlow", "Fixed" ] }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to EPUB format and uploads resulting file to storage", "operationId": "PutPdfInStorageToEpub", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.epub)", "x-nullable": true }, { "type": "string", "name": "contentRecognitionMode", "in": "query", "description": "Property tunes conversion for this or that desirable method of recognition of content.", "x-schema": { "$ref": "#/definitions/EpubRecognitionMode" }, "x-nullable": true, "enum": [ "Flow", "PdfFlow", "Fixed" ] }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/epub": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to EPUB format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToEpub", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.epub)", "x-nullable": true }, { "type": "string", "name": "contentRecognitionMode", "in": "query", "description": "Property tunes conversion for this or that desirable method of recognition of content.", "x-schema": { "$ref": "#/definitions/EpubRecognitionMode" }, "x-nullable": true, "enum": [ "Flow", "PdfFlow", "Fixed" ] }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/html": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to Html format and returns resulting file in response content", "operationId": "GetPdfInStorageToHtml", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "additionalMarginWidthInPoints", "in": "query", "description": "Defines width of margin that will be forcibly left around that output HTML-areas.", "format": "int32", "x-nullable": true }, { "type": "boolean", "name": "compressSvgGraphicsIfAny", "in": "query", "description": "The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving.", "x-nullable": true }, { "type": "boolean", "name": "convertMarkedContentToLayers", "in": "query", "description": "If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with \"data-pdflayer\" attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.", "x-nullable": true }, { "type": "string", "name": "defaultFontName", "in": "query", "description": "Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.", "x-nullable": true }, { "type": "string", "name": "documentType", "in": "query", "description": "Result document type.", "x-schema": { "$ref": "#/definitions/HtmlDocumentType" }, "x-nullable": true, "enum": [ "Xhtml", "Html5" ] }, { "type": "boolean", "name": "fixedLayout", "in": "query", "description": "The value indicating whether that HTML is created as fixed layout.", "x-nullable": true }, { "type": "integer", "name": "imageResolution", "in": "query", "description": "Resolution for image rendering.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "minimalLineWidth", "in": "query", "description": "This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.", "format": "int32", "x-nullable": true }, { "type": "boolean", "name": "preventGlyphsGrouping", "in": "query", "description": "This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.", "x-nullable": true }, { "type": "boolean", "name": "splitCssIntoPages", "in": "query", "description": "When multipage-mode selected(i.e 'SplitIntoPages' is 'true'), then this attribute defines whether should be created separate CSS-file for each result HTML page.", "x-nullable": true }, { "type": "boolean", "name": "splitIntoPages", "in": "query", "description": "The flag that indicates whether each page of source document will be converted into it's own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.", "x-nullable": true }, { "type": "boolean", "name": "useZOrder", "in": "query", "description": "If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.", "x-nullable": true }, { "type": "string", "name": "antialiasingProcessing", "in": "query", "description": "The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML.", "x-schema": { "$ref": "#/definitions/AntialiasingProcessingType" }, "x-nullable": true, "enum": [ "NoAdditionalProcessing", "TryCorrectResultHtml" ] }, { "type": "string", "name": "cssClassNamesPrefix", "in": "query", "description": "When PDFtoHTML converter generates result CSSs, CSS class names (something like \".stl_01 {}\" ... \".stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix.", "x-nullable": true }, { "type": "array", "name": "explicitListOfSavedPages", "in": "query", "description": "With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1...[NumberOfPagesInConvertedDocument]) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF.", "collectionFormat": "multi", "x-nullable": true, "items": { "type": "integer", "format": "int32" } }, { "type": "string", "name": "fontEncodingStrategy", "in": "query", "description": "Defines encoding special rule to tune PDF decoding for current document.", "x-schema": { "$ref": "#/definitions/FontEncodingRules" }, "x-nullable": true, "enum": [ "Default", "DecreaseToUnicodePriorityLevel" ] }, { "type": "string", "name": "fontSavingMode", "in": "query", "description": "Defines font saving mode that will be used during saving of PDF to desirable format.", "x-schema": { "$ref": "#/definitions/FontSavingModes" }, "x-nullable": true, "enum": [ "AlwaysSaveAsWOFF", "AlwaysSaveAsTTF", "AlwaysSaveAsEOT", "SaveInAllFormats" ] }, { "type": "string", "name": "htmlMarkupGenerationMode", "in": "query", "description": "Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.", "x-schema": { "$ref": "#/definitions/HtmlMarkupGenerationModes" }, "x-nullable": true, "enum": [ "WriteAllHtml", "WriteOnlyBodyContent" ] }, { "type": "string", "name": "lettersPositioningMethod", "in": "query", "description": "The mode of positioning of letters in words in result HTML.", "x-schema": { "$ref": "#/definitions/LettersPositioningMethods" }, "x-nullable": true, "enum": [ "UseEmUnitsAndCompensationOfRoundingErrorsInCss", "UsePixelUnitsInCssLetterSpacingForIE" ] }, { "type": "boolean", "name": "pagesFlowTypeDependsOnViewersScreenSize", "in": "query", "description": "If attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer.", "x-nullable": true }, { "type": "string", "name": "partsEmbeddingMode", "in": "query", "description": "It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities.", "x-schema": { "$ref": "#/definitions/PartsEmbeddingModes" }, "x-nullable": true, "enum": [ "EmbedAllIntoHtml", "EmbedCssOnly", "NoEmbedding" ] }, { "type": "string", "name": "rasterImagesSavingMode", "in": "query", "description": "Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML.", "x-schema": { "$ref": "#/definitions/RasterImagesSavingModes" }, "x-nullable": true, "enum": [ "AsPngImagesEmbeddedIntoSvg", "AsExternalPngFilesReferencedViaSvg", "AsEmbeddedPartsOfPngPageBackground" ] }, { "type": "boolean", "name": "removeEmptyAreasOnTopAndBottom", "in": "query", "description": "Defines whether in created HTML will be removed top and bottom empty area without any content (if any).", "x-nullable": true }, { "type": "boolean", "name": "saveShadowedTextsAsTransparentTexts", "in": "query", "description": "Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard).", "x-nullable": true }, { "type": "boolean", "name": "saveTransparentTexts", "in": "query", "description": "Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML.", "x-nullable": true }, { "type": "string", "name": "specialFolderForAllImages", "in": "query", "description": "The path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.", "x-nullable": true }, { "type": "string", "name": "specialFolderForSvgImages", "in": "query", "description": "The path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.", "x-nullable": true }, { "type": "boolean", "name": "trySaveTextUnderliningAndStrikeoutingInCss", "in": "query", "description": "PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text's underlining and put this info into CSS instead of drawing of underlining graphically.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "boolean", "name": "flowLayoutParagraphFullWidth", "in": "query", "description": "This attribute specifies full width paragraph text for Flow mode, FixedLayout = false.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to Html format and uploads resulting file to storage", "operationId": "PutPdfInStorageToHtml", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.html)", "x-nullable": true }, { "type": "integer", "name": "additionalMarginWidthInPoints", "in": "query", "description": "Defines width of margin that will be forcibly left around that output HTML-areas.", "format": "int32", "x-nullable": true }, { "type": "boolean", "name": "compressSvgGraphicsIfAny", "in": "query", "description": "The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving.", "x-nullable": true }, { "type": "boolean", "name": "convertMarkedContentToLayers", "in": "query", "description": "If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with \"data-pdflayer\" attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.", "x-nullable": true }, { "type": "string", "name": "defaultFontName", "in": "query", "description": "Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.", "x-nullable": true }, { "type": "string", "name": "documentType", "in": "query", "description": "Result document type.", "x-schema": { "$ref": "#/definitions/HtmlDocumentType" }, "x-nullable": true, "enum": [ "Xhtml", "Html5" ] }, { "type": "boolean", "name": "fixedLayout", "in": "query", "description": "The value indicating whether that HTML is created as fixed layout.", "x-nullable": true }, { "type": "integer", "name": "imageResolution", "in": "query", "description": "Resolution for image rendering.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "minimalLineWidth", "in": "query", "description": "This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.", "format": "int32", "x-nullable": true }, { "type": "boolean", "name": "preventGlyphsGrouping", "in": "query", "description": "This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.", "x-nullable": true }, { "type": "boolean", "name": "splitCssIntoPages", "in": "query", "description": "When multipage-mode selected(i.e 'SplitIntoPages' is 'true'), then this attribute defines whether should be created separate CSS-file for each result HTML page.", "x-nullable": true }, { "type": "boolean", "name": "splitIntoPages", "in": "query", "description": "The flag that indicates whether each page of source document will be converted into it's own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.", "x-nullable": true }, { "type": "boolean", "name": "useZOrder", "in": "query", "description": "If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.", "x-nullable": true }, { "type": "string", "name": "antialiasingProcessing", "in": "query", "description": "The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML.", "x-schema": { "$ref": "#/definitions/AntialiasingProcessingType" }, "x-nullable": true, "enum": [ "NoAdditionalProcessing", "TryCorrectResultHtml" ] }, { "type": "string", "name": "cssClassNamesPrefix", "in": "query", "description": "When PDFtoHTML converter generates result CSSs, CSS class names (something like \".stl_01 {}\" ... \".stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix.", "x-nullable": true }, { "type": "array", "name": "explicitListOfSavedPages", "in": "query", "description": "With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1...[NumberOfPagesInConvertedDocument]) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF.", "collectionFormat": "multi", "x-nullable": true, "items": { "type": "integer", "format": "int32" } }, { "type": "string", "name": "fontEncodingStrategy", "in": "query", "description": "Defines encoding special rule to tune PDF decoding for current document.", "x-schema": { "$ref": "#/definitions/FontEncodingRules" }, "x-nullable": true, "enum": [ "Default", "DecreaseToUnicodePriorityLevel" ] }, { "type": "string", "name": "fontSavingMode", "in": "query", "description": "Defines font saving mode that will be used during saving of PDF to desirable format.", "x-schema": { "$ref": "#/definitions/FontSavingModes" }, "x-nullable": true, "enum": [ "AlwaysSaveAsWOFF", "AlwaysSaveAsTTF", "AlwaysSaveAsEOT", "SaveInAllFormats" ] }, { "type": "string", "name": "htmlMarkupGenerationMode", "in": "query", "description": "Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.", "x-schema": { "$ref": "#/definitions/HtmlMarkupGenerationModes" }, "x-nullable": true, "enum": [ "WriteAllHtml", "WriteOnlyBodyContent" ] }, { "type": "string", "name": "lettersPositioningMethod", "in": "query", "description": "The mode of positioning of letters in words in result HTML.", "x-schema": { "$ref": "#/definitions/LettersPositioningMethods" }, "x-nullable": true, "enum": [ "UseEmUnitsAndCompensationOfRoundingErrorsInCss", "UsePixelUnitsInCssLetterSpacingForIE" ] }, { "type": "boolean", "name": "pagesFlowTypeDependsOnViewersScreenSize", "in": "query", "description": "If attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer.", "x-nullable": true }, { "type": "string", "name": "partsEmbeddingMode", "in": "query", "description": "It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities.", "x-schema": { "$ref": "#/definitions/PartsEmbeddingModes" }, "x-nullable": true, "enum": [ "EmbedAllIntoHtml", "EmbedCssOnly", "NoEmbedding" ] }, { "type": "string", "name": "rasterImagesSavingMode", "in": "query", "description": "Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML.", "x-schema": { "$ref": "#/definitions/RasterImagesSavingModes" }, "x-nullable": true, "enum": [ "AsPngImagesEmbeddedIntoSvg", "AsExternalPngFilesReferencedViaSvg", "AsEmbeddedPartsOfPngPageBackground" ] }, { "type": "boolean", "name": "removeEmptyAreasOnTopAndBottom", "in": "query", "description": "Defines whether in created HTML will be removed top and bottom empty area without any content (if any).", "x-nullable": true }, { "type": "boolean", "name": "saveShadowedTextsAsTransparentTexts", "in": "query", "description": "Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard).", "x-nullable": true }, { "type": "boolean", "name": "saveTransparentTexts", "in": "query", "description": "Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML.", "x-nullable": true }, { "type": "string", "name": "specialFolderForAllImages", "in": "query", "description": "The path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.", "x-nullable": true }, { "type": "string", "name": "specialFolderForSvgImages", "in": "query", "description": "The path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.", "x-nullable": true }, { "type": "boolean", "name": "trySaveTextUnderliningAndStrikeoutingInCss", "in": "query", "description": "PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text's underlining and put this info into CSS instead of drawing of underlining graphically.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "boolean", "name": "flowLayoutParagraphFullWidth", "in": "query", "description": "This attribute specifies full width paragraph text for Flow mode, FixedLayout = false.", "x-nullable": true }, { "type": "string", "name": "outputFormat", "in": "query", "description": "This parameter determines the type of result. The zip archive will be uploaded into the storage if the parameter is \"Zip\" or missed (default). In case of the \"Folder\", all resulting files and directories will be uploaded to the folder of the resulting HTML file.", "x-schema": { "$ref": "#/definitions/OutputFormat" }, "default": "Zip", "x-nullable": false, "enum": [ "Zip", "Folder" ] } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/html": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to Html format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToHtml", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.html)", "x-nullable": true }, { "type": "integer", "name": "additionalMarginWidthInPoints", "in": "query", "description": "Defines width of margin that will be forcibly left around that output HTML-areas.", "format": "int32", "x-nullable": true }, { "type": "boolean", "name": "compressSvgGraphicsIfAny", "in": "query", "description": "The flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving.", "x-nullable": true }, { "type": "boolean", "name": "convertMarkedContentToLayers", "in": "query", "description": "If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with \"data-pdflayer\" attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.", "x-nullable": true }, { "type": "string", "name": "defaultFontName", "in": "query", "description": "Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.", "x-nullable": true }, { "type": "string", "name": "documentType", "in": "query", "description": "Result document type.", "x-schema": { "$ref": "#/definitions/HtmlDocumentType" }, "x-nullable": true, "enum": [ "Xhtml", "Html5" ] }, { "type": "boolean", "name": "fixedLayout", "in": "query", "description": "The value indicating whether that HTML is created as fixed layout.", "x-nullable": true }, { "type": "integer", "name": "imageResolution", "in": "query", "description": "Resolution for image rendering.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "minimalLineWidth", "in": "query", "description": "This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.", "format": "int32", "x-nullable": true }, { "type": "boolean", "name": "preventGlyphsGrouping", "in": "query", "description": "This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.", "x-nullable": true }, { "type": "boolean", "name": "splitCssIntoPages", "in": "query", "description": "When multipage-mode selected(i.e 'SplitIntoPages' is 'true'), then this attribute defines whether should be created separate CSS-file for each result HTML page.", "x-nullable": true }, { "type": "boolean", "name": "splitIntoPages", "in": "query", "description": "The flag that indicates whether each page of source document will be converted into it's own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.", "x-nullable": true }, { "type": "boolean", "name": "useZOrder", "in": "query", "description": "If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.", "x-nullable": true }, { "type": "string", "name": "antialiasingProcessing", "in": "query", "description": "The parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML.", "x-schema": { "$ref": "#/definitions/AntialiasingProcessingType" }, "x-nullable": true, "enum": [ "NoAdditionalProcessing", "TryCorrectResultHtml" ] }, { "type": "string", "name": "cssClassNamesPrefix", "in": "query", "description": "When PDFtoHTML converter generates result CSSs, CSS class names (something like \".stl_01 {}\" ... \".stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix.", "x-nullable": true }, { "type": "array", "name": "explicitListOfSavedPages", "in": "query", "description": "With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1...[NumberOfPagesInConvertedDocument]) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF.", "collectionFormat": "multi", "x-nullable": true, "items": { "type": "integer", "format": "int32" } }, { "type": "string", "name": "fontEncodingStrategy", "in": "query", "description": "Defines encoding special rule to tune PDF decoding for current document.", "x-schema": { "$ref": "#/definitions/FontEncodingRules" }, "x-nullable": true, "enum": [ "Default", "DecreaseToUnicodePriorityLevel" ] }, { "type": "string", "name": "fontSavingMode", "in": "query", "description": "Defines font saving mode that will be used during saving of PDF to desirable format.", "x-schema": { "$ref": "#/definitions/FontSavingModes" }, "x-nullable": true, "enum": [ "AlwaysSaveAsWOFF", "AlwaysSaveAsTTF", "AlwaysSaveAsEOT", "SaveInAllFormats" ] }, { "type": "string", "name": "htmlMarkupGenerationMode", "in": "query", "description": "Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.", "x-schema": { "$ref": "#/definitions/HtmlMarkupGenerationModes" }, "x-nullable": true, "enum": [ "WriteAllHtml", "WriteOnlyBodyContent" ] }, { "type": "string", "name": "lettersPositioningMethod", "in": "query", "description": "The mode of positioning of letters in words in result HTML.", "x-schema": { "$ref": "#/definitions/LettersPositioningMethods" }, "x-nullable": true, "enum": [ "UseEmUnitsAndCompensationOfRoundingErrorsInCss", "UsePixelUnitsInCssLetterSpacingForIE" ] }, { "type": "boolean", "name": "pagesFlowTypeDependsOnViewersScreenSize", "in": "query", "description": "If attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer.", "x-nullable": true }, { "type": "string", "name": "partsEmbeddingMode", "in": "query", "description": "It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities.", "x-schema": { "$ref": "#/definitions/PartsEmbeddingModes" }, "x-nullable": true, "enum": [ "EmbedAllIntoHtml", "EmbedCssOnly", "NoEmbedding" ] }, { "type": "string", "name": "rasterImagesSavingMode", "in": "query", "description": "Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML.", "x-schema": { "$ref": "#/definitions/RasterImagesSavingModes" }, "x-nullable": true, "enum": [ "AsPngImagesEmbeddedIntoSvg", "AsExternalPngFilesReferencedViaSvg", "AsEmbeddedPartsOfPngPageBackground" ] }, { "type": "boolean", "name": "removeEmptyAreasOnTopAndBottom", "in": "query", "description": "Defines whether in created HTML will be removed top and bottom empty area without any content (if any).", "x-nullable": true }, { "type": "boolean", "name": "saveShadowedTextsAsTransparentTexts", "in": "query", "description": "Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard).", "x-nullable": true }, { "type": "boolean", "name": "saveTransparentTexts", "in": "query", "description": "Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML.", "x-nullable": true }, { "type": "string", "name": "specialFolderForAllImages", "in": "query", "description": "The path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.", "x-nullable": true }, { "type": "string", "name": "specialFolderForSvgImages", "in": "query", "description": "The path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.", "x-nullable": true }, { "type": "boolean", "name": "trySaveTextUnderliningAndStrikeoutingInCss", "in": "query", "description": "PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text's underlining and put this info into CSS instead of drawing of underlining graphically.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "boolean", "name": "flowLayoutParagraphFullWidth", "in": "query", "description": "This attribute specifies full width paragraph text for Flow mode, FixedLayout = false.", "x-nullable": true }, { "type": "string", "name": "outputFormat", "in": "query", "description": "This parameter determines the type of result. The zip archive will be uploaded into the storage if the parameter is \"Zip\" or missed (default). In case of the \"Folder\", all resulting files and directories will be uploaded to the folder of the resulting HTML file.", "x-schema": { "$ref": "#/definitions/OutputFormat" }, "default": "Zip", "x-nullable": false, "enum": [ "Zip", "Folder" ] }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/mobixml": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to MOBIXML format and returns resulting ZIP archive file in response content.", "operationId": "GetPdfInStorageToMobiXml", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to MOBIXML format and uploads resulting ZIP archive file to storage", "operationId": "PutPdfInStorageToMobiXml", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.mobixml)", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/mobixml": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to MOBIXML format and uploads resulting ZIP archive file to storage.", "operationId": "PutPdfInRequestToMobiXml", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.mobixml)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/pdfa": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to PdfA format and returns resulting file in response content", "operationId": "GetPdfInStorageToPdfA", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "type", "in": "query", "required": true, "description": "Type of PdfA format.", "x-schema": { "$ref": "#/definitions/PdfAType" }, "x-nullable": false, "enum": [ "PDFA1A", "PDFA1B", "PDFA3A", "PDFA3B" ] }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to PdfA format and uploads resulting file to storage", "operationId": "PutPdfInStorageToPdfA", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.pdf)", "x-nullable": true }, { "type": "string", "name": "type", "in": "query", "required": true, "description": "Type of PdfA format.", "x-schema": { "$ref": "#/definitions/PdfAType" }, "x-nullable": false, "enum": [ "PDFA1A", "PDFA1B", "PDFA3A", "PDFA3B" ] }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/pdfa": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to PdfA format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToPdfA", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.pdf)", "x-nullable": true }, { "type": "string", "name": "type", "in": "query", "required": true, "description": "Type of PdfA format.", "x-schema": { "$ref": "#/definitions/PdfAType" }, "x-nullable": false, "enum": [ "PDFA1A", "PDFA1B", "PDFA3A", "PDFA3B" ] }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/pptx": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to PPTX format and returns resulting file in response content", "operationId": "GetPdfInStorageToPptx", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "boolean", "name": "separateImages", "in": "query", "description": "Separate images.", "x-nullable": true }, { "type": "boolean", "name": "slidesAsImages", "in": "query", "description": "Slides as images.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "IActionResult with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to PPTX format and uploads resulting file to storage", "operationId": "PutPdfInStorageToPptx", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.pptx)", "x-nullable": true }, { "type": "boolean", "name": "separateImages", "in": "query", "description": "Separate images.", "x-nullable": true }, { "type": "boolean", "name": "slidesAsImages", "in": "query", "description": "Slides as images.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/pptx": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to PPTX format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToPptx", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.pptx)", "x-nullable": true }, { "type": "boolean", "name": "separateImages", "in": "query", "description": "Separate images.", "x-nullable": true }, { "type": "boolean", "name": "slidesAsImages", "in": "query", "description": "Slides as images.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/svg": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to SVG format and returns resulting file in response content", "operationId": "GetPdfInStorageToSvg", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "boolean", "name": "compressOutputToZipArchive", "in": "query", "description": "Specifies whether output will be created as one zip-archive.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to SVG format and uploads resulting file to storage", "operationId": "PutPdfInStorageToSvg", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.svg)", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/svg": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to SVG format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToSvg", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.svg)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/tex": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to TeX format and returns resulting file in response content", "operationId": "GetPdfInStorageToTeX", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to TeX format and uploads resulting file to storage", "operationId": "PutPdfInStorageToTeX", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.tex)", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/tex": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to TeX format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToTeX", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.tex)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/tiff": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to TIFF format and returns resulting file in response content", "operationId": "GetPdfInStorageToTiff", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "number", "name": "brightness", "in": "query", "description": "Image brightness.", "format": "double", "x-nullable": true }, { "type": "string", "name": "compression", "in": "query", "description": "Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None.", "x-schema": { "$ref": "#/definitions/CompressionType" }, "x-nullable": true, "enum": [ "LZW", "CCITT4", "CCITT3", "RLE", "None" ] }, { "type": "string", "name": "colorDepth", "in": "query", "description": "Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp.", "x-schema": { "$ref": "#/definitions/ColorDepth" }, "x-nullable": true, "enum": [ "Default", "Format8bpp", "Format4bpp", "Format1bpp" ] }, { "type": "integer", "name": "leftMargin", "in": "query", "description": "Left image margin.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "rightMargin", "in": "query", "description": "Right image margin.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "topMargin", "in": "query", "description": "Top image margin.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "bottomMargin", "in": "query", "description": "Bottom image margin.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "orientation", "in": "query", "description": "Image orientation. Possible values are: None, Landscape, Portait.", "x-schema": { "$ref": "#/definitions/ShapeType" }, "x-nullable": true, "enum": [ "None", "Landscape", "Portrait" ] }, { "type": "boolean", "name": "skipBlankPages", "in": "query", "description": "Skip blank pages flag.", "x-nullable": true }, { "type": "integer", "name": "width", "in": "query", "description": "Image width.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "Image height.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "xResolution", "in": "query", "description": "Horizontal resolution.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "yResolution", "in": "query", "description": "Vertical resolution.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "pageIndex", "in": "query", "description": "Start page to export.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "pageCount", "in": "query", "description": "Number of pages to export.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to TIFF format and uploads resulting file to storage", "operationId": "PutPdfInStorageToTiff", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.tiff)", "x-nullable": true }, { "type": "number", "name": "brightness", "in": "query", "description": "Image brightness.", "format": "double", "x-nullable": true }, { "type": "string", "name": "compression", "in": "query", "description": "Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None.", "x-schema": { "$ref": "#/definitions/CompressionType" }, "x-nullable": true, "enum": [ "LZW", "CCITT4", "CCITT3", "RLE", "None" ] }, { "type": "string", "name": "colorDepth", "in": "query", "description": "Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp.", "x-schema": { "$ref": "#/definitions/ColorDepth" }, "x-nullable": true, "enum": [ "Default", "Format8bpp", "Format4bpp", "Format1bpp" ] }, { "type": "integer", "name": "leftMargin", "in": "query", "description": "Left image margin.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "rightMargin", "in": "query", "description": "Right image margin.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "topMargin", "in": "query", "description": "Top image margin.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "bottomMargin", "in": "query", "description": "Bottom image margin.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "orientation", "in": "query", "description": "Image orientation. Possible values are: None, Landscape, Portait.", "x-schema": { "$ref": "#/definitions/ShapeType" }, "x-nullable": true, "enum": [ "None", "Landscape", "Portrait" ] }, { "type": "boolean", "name": "skipBlankPages", "in": "query", "description": "Skip blank pages flag.", "x-nullable": true }, { "type": "integer", "name": "width", "in": "query", "description": "Image width.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "Image height.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "xResolution", "in": "query", "description": "Horizontal resolution.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "yResolution", "in": "query", "description": "Vertical resolution.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "pageIndex", "in": "query", "description": "Start page to export.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "pageCount", "in": "query", "description": "Number of pages to export.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/tiff": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to TIFF format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToTiff", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.tiff)", "x-nullable": true }, { "type": "number", "name": "brightness", "in": "query", "description": "Image brightness.", "format": "double", "x-nullable": true }, { "type": "string", "name": "compression", "in": "query", "description": "Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None.", "x-schema": { "$ref": "#/definitions/CompressionType" }, "x-nullable": true, "enum": [ "LZW", "CCITT4", "CCITT3", "RLE", "None" ] }, { "type": "string", "name": "colorDepth", "in": "query", "description": "Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp.", "x-schema": { "$ref": "#/definitions/ColorDepth" }, "x-nullable": true, "enum": [ "Default", "Format8bpp", "Format4bpp", "Format1bpp" ] }, { "type": "integer", "name": "leftMargin", "in": "query", "description": "Left image margin.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "rightMargin", "in": "query", "description": "Right image margin.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "topMargin", "in": "query", "description": "Top image margin.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "bottomMargin", "in": "query", "description": "Bottom image margin.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "orientation", "in": "query", "description": "Image orientation. Possible values are: None, Landscape, Portait.", "x-schema": { "$ref": "#/definitions/ShapeType" }, "x-nullable": true, "enum": [ "None", "Landscape", "Portrait" ] }, { "type": "boolean", "name": "skipBlankPages", "in": "query", "description": "Skip blank pages flag.", "x-nullable": true }, { "type": "integer", "name": "width", "in": "query", "description": "Image width.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "Image height.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "xResolution", "in": "query", "description": "Horizontal resolution.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "yResolution", "in": "query", "description": "Vertical resolution.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "pageIndex", "in": "query", "description": "Start page to export.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "pageCount", "in": "query", "description": "Number of pages to export.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/xls": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to XLS format and returns resulting file in response content", "operationId": "GetPdfInStorageToXls", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "boolean", "name": "insertBlankColumnAtFirst", "in": "query", "description": "Insert blank column at first", "x-nullable": true }, { "type": "boolean", "name": "minimizeTheNumberOfWorksheets", "in": "query", "description": "Minimize the number of worksheets", "x-nullable": true }, { "type": "number", "name": "scaleFactor", "in": "query", "description": "Scale factor (Obsolete)", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "uniformWorksheets", "in": "query", "description": "Uniform worksheets", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to XLS format and uploads resulting file to storage", "operationId": "PutPdfInStorageToXls", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.xls)", "x-nullable": true }, { "type": "boolean", "name": "insertBlankColumnAtFirst", "in": "query", "description": "Insert blank column at first", "x-nullable": true }, { "type": "boolean", "name": "minimizeTheNumberOfWorksheets", "in": "query", "description": "Minimize the number of worksheets", "x-nullable": true }, { "type": "number", "name": "scaleFactor", "in": "query", "description": "Scale factor (Obsolete)", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "uniformWorksheets", "in": "query", "description": "Uniform worksheets", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/xls": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to XLS format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToXls", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.xls)", "x-nullable": true }, { "type": "boolean", "name": "insertBlankColumnAtFirst", "in": "query", "description": "Insert blank column at first", "x-nullable": true }, { "type": "boolean", "name": "minimizeTheNumberOfWorksheets", "in": "query", "description": "Minimize the number of worksheets", "x-nullable": true }, { "type": "number", "name": "scaleFactor", "in": "query", "description": "Scale factor (Obsolete)", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "uniformWorksheets", "in": "query", "description": "Uniform worksheets", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/xlsx": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to XLSX format and returns resulting file in response content", "operationId": "GetPdfInStorageToXlsx", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "boolean", "name": "insertBlankColumnAtFirst", "in": "query", "description": "Insert blank column at first", "x-nullable": true }, { "type": "boolean", "name": "minimizeTheNumberOfWorksheets", "in": "query", "description": "Minimize the number of worksheets", "x-nullable": true }, { "type": "number", "name": "scaleFactor", "in": "query", "description": "Scale factor (Obsolete)", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "uniformWorksheets", "in": "query", "description": "Uniform worksheets", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to XLSX format and uploads resulting file to storage", "operationId": "PutPdfInStorageToXlsx", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.xlsx)", "x-nullable": true }, { "type": "boolean", "name": "insertBlankColumnAtFirst", "in": "query", "description": "Insert blank column at first", "x-nullable": true }, { "type": "boolean", "name": "minimizeTheNumberOfWorksheets", "in": "query", "description": "Minimize the number of worksheets", "x-nullable": true }, { "type": "number", "name": "scaleFactor", "in": "query", "description": "Scale factor (Obsolete)", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "uniformWorksheets", "in": "query", "description": "Uniform worksheets", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/xlsx": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to XLSX format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToXlsx", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.xlsx)", "x-nullable": true }, { "type": "boolean", "name": "insertBlankColumnAtFirst", "in": "query", "description": "Insert blank column at first", "x-nullable": true }, { "type": "boolean", "name": "minimizeTheNumberOfWorksheets", "in": "query", "description": "Minimize the number of worksheets", "x-nullable": true }, { "type": "number", "name": "scaleFactor", "in": "query", "description": "Scale factor (Obsolete)", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "uniformWorksheets", "in": "query", "description": "Uniform worksheets", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to XLSX format and uploads and returns resulting file in response content.", "operationId": "PostPdfToXlsx", "consumes": [ "multipart/form-data" ], "produces": [ "multipart/form-data" ], "parameters": [ { "type": "boolean", "name": "insertBlankColumnAtFirst", "in": "query", "description": "Insert blank column at first", "x-nullable": true }, { "type": "boolean", "name": "minimizeTheNumberOfWorksheets", "in": "query", "description": "Minimize the number of worksheets", "x-nullable": true }, { "type": "boolean", "name": "uniformWorksheets", "in": "query", "description": "Uniform worksheets", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/xml": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to XML format and returns resulting file in response content", "operationId": "GetPdfInStorageToXml", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to XML format and uploads resulting file to storage", "operationId": "PutPdfInStorageToXml", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.xml)", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/xml": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to XML format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToXml", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.xml)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/xps": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to XPS format and returns resulting file in response content", "operationId": "GetPdfInStorageToXps", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (located on storage) to XPS format and uploads resulting file to storage", "operationId": "PutPdfInStorageToXps", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.xps)", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/xps": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document (in request content) to XPS format and uploads resulting file to storage.", "operationId": "PutPdfInRequestToXps", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.xps)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/ps": { "get": { "tags": [ "Convert" ], "summary": "Convert PS file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetPsInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.ps)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/ps": { "put": { "tags": [ "Convert" ], "summary": "Convert PS file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutPsInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.ps)", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/svg": { "get": { "tags": [ "Convert" ], "summary": "Convert SVG file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetSvgInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.svg)", "x-nullable": true }, { "type": "boolean", "name": "adjustPageSize", "in": "query", "description": "Adjust page size", "x-nullable": true }, { "type": "number", "name": "height", "in": "query", "description": "Page height", "format": "double", "x-nullable": true }, { "type": "number", "name": "width", "in": "query", "description": "Page width", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "isLandscape", "in": "query", "description": "Is page landscaped", "x-nullable": true }, { "type": "number", "name": "marginLeft", "in": "query", "description": "Page margin left", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginBottom", "in": "query", "description": "Page margin bottom", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginRight", "in": "query", "description": "Page margin right", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginTop", "in": "query", "description": "Page margin top", "format": "double", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/svg": { "put": { "tags": [ "Convert" ], "summary": "Convert SVG file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutSvgInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.svg)", "x-nullable": true }, { "type": "boolean", "name": "adjustPageSize", "in": "query", "description": "Adjust page size", "x-nullable": true }, { "type": "number", "name": "height", "in": "query", "description": "Page height", "format": "double", "x-nullable": true }, { "type": "number", "name": "width", "in": "query", "description": "Page width", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "isLandscape", "in": "query", "description": "Is page landscaped", "x-nullable": true }, { "type": "number", "name": "marginLeft", "in": "query", "description": "Page margin left", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginBottom", "in": "query", "description": "Page margin bottom", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginRight", "in": "query", "description": "Page margin right", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginTop", "in": "query", "description": "Page margin top", "format": "double", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/tex": { "get": { "tags": [ "Convert" ], "summary": "Convert TeX file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetTeXInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.tex)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/tex": { "put": { "tags": [ "Convert" ], "summary": "Convert TeX file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutTeXInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.tex)", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/web": { "get": { "tags": [ "Convert" ], "summary": "Convert web page to PDF format and return resulting file in response. ", "operationId": "GetWebInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "url", "in": "query", "required": true, "description": "Source url", "x-nullable": true }, { "type": "number", "name": "height", "in": "query", "description": "Page height", "format": "double", "x-nullable": true }, { "type": "number", "name": "width", "in": "query", "description": "Page width", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "isLandscape", "in": "query", "description": "Is page landscaped", "x-nullable": true }, { "type": "number", "name": "marginLeft", "in": "query", "description": "Page margin left", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginBottom", "in": "query", "description": "Page margin bottom", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginRight", "in": "query", "description": "Page margin right", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginTop", "in": "query", "description": "Page margin top", "format": "double", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/web": { "put": { "tags": [ "Convert" ], "summary": "Convert web page to PDF format and upload resulting file to storage. ", "operationId": "PutWebInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "url", "in": "query", "required": true, "description": "Source url", "x-nullable": true }, { "type": "number", "name": "height", "in": "query", "description": "Page height", "format": "double", "x-nullable": true }, { "type": "number", "name": "width", "in": "query", "description": "Page width", "format": "double", "x-nullable": true }, { "type": "boolean", "name": "isLandscape", "in": "query", "description": "Is page landscaped", "x-nullable": true }, { "type": "number", "name": "marginLeft", "in": "query", "description": "Page margin left", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginBottom", "in": "query", "description": "Page margin bottom", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginRight", "in": "query", "description": "Page margin right", "format": "double", "x-nullable": true }, { "type": "number", "name": "marginTop", "in": "query", "description": "Page margin top", "format": "double", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/convert/xfatoacroform": { "get": { "tags": [ "Convert" ], "summary": "Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and returns resulting file response content", "operationId": "GetXfaPdfInStorageToAcroForm", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Convert" ], "summary": "Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and uploads resulting file to storage", "operationId": "PutXfaPdfInStorageToAcroForm", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.pdf)", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/convert/xfatoacroform": { "put": { "tags": [ "Convert" ], "summary": "Converts PDF document which contains XFA form (in request content) to PDF with AcroForm and uploads resulting file to storage.", "operationId": "PutXfaPdfInRequestToAcroForm", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.pdf)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be converted." } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/xml": { "get": { "tags": [ "Convert" ], "summary": "Convert XML file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetXmlInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.xml)", "x-nullable": true }, { "type": "string", "name": "xslFilePath", "in": "query", "description": "Full XSL source filename (ex. /folder1/folder2/template.xsl)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/xml": { "put": { "tags": [ "Convert" ], "summary": "Convert XML file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutXmlInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.xml)", "x-nullable": true }, { "type": "string", "name": "xslFilePath", "in": "query", "description": "Full XSL source filename (ex. /folder1/folder2/template.xsl)", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/xps": { "get": { "tags": [ "Convert" ], "summary": "Convert XPS file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetXpsInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.xps)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/xps": { "put": { "tags": [ "Convert" ], "summary": "Convert XPS file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutXpsInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.xps)", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/create/xslfo": { "get": { "tags": [ "Convert" ], "summary": "Convert XslFo file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetXslFoInStorageToPdf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.xslfo)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/create/xslfo": { "put": { "tags": [ "Convert" ], "summary": "Convert XslFo file (located on storage) to PDF format and upload resulting file to storage. ", "operationId": "PutXslFoInStorageToPdf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "srcPath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.xpsfo)", "x-nullable": true }, { "type": "string", "name": "dstFolder", "in": "query", "description": "The destination document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/decrypt": { "post": { "tags": [ "Decrypt" ], "summary": "Decrypt document in storage.", "operationId": "PostDecryptDocumentInStorage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "Document name.", "x-nullable": false }, { "type": "string", "name": "password", "in": "query", "required": true, "description": "The password (encrypted Base64).", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/decrypt": { "put": { "tags": [ "Decrypt" ], "summary": "Decrypt document from content.", "operationId": "PutDecryptDocument", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.doc)", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "required": true, "description": "The password (encrypted Base64).", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be decrypted." } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/displayproperties": { "get": { "tags": [ "DisplayProperties" ], "summary": "Read document display properties.", "operationId": "GetDocumentDisplayProperties", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DisplayPropertiesResponse with the display properties info.", "schema": { "$ref": "#/definitions/DisplayPropertiesResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "DisplayProperties" ], "summary": "Update document display properties.", "operationId": "PutDocumentDisplayProperties", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "displayProperties", "in": "body", "required": true, "description": "The display properties.", "schema": { "$ref": "#/definitions/DisplayProperties" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DisplayPropertiesResponse with the display properties info.", "schema": { "$ref": "#/definitions/DisplayPropertiesResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/crop": { "post": { "tags": [ "Document" ], "summary": "Crop PDF document pages.", "operationId": "PostDocumentPagesCrop", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "pages", "in": "query", "required": true, "description": "Comma separated list of pages and page ranges. (Example: 1,3-5,8)", "x-nullable": true }, { "name": "rect", "in": "body", "required": true, "description": "Rectangle of document area.", "schema": { "$ref": "#/definitions/Rectangle" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/resize": { "post": { "tags": [ "Document" ], "summary": "Rsize PDF document.", "operationId": "PostDocumentPagesResize", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "number", "name": "height", "in": "query", "required": true, "description": "Page Height", "format": "double", "x-nullable": false }, { "type": "number", "name": "width", "in": "query", "required": true, "description": "Page width", "format": "double", "x-nullable": false }, { "type": "string", "name": "pages", "in": "query", "required": true, "description": "Comma separated list of pages and page ranges. (Example: 1,3-5,8)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/rotate": { "post": { "tags": [ "Document" ], "summary": "Rotate PDF document.", "operationId": "PostDocumentPagesRotate", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "rotationAngle", "in": "query", "required": true, "description": "Rotation Angle (CKW). Can be 90, 180, 270.", "x-schema": { "$ref": "#/definitions/Rotation" }, "x-nullable": false, "enum": [ "None", "on90", "on180", "on270" ] }, { "type": "string", "name": "pages", "in": "query", "required": true, "description": "Comma separated list of pages and page ranges. (Example: 1,3-5,8)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "IActionResult", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}": { "get": { "tags": [ "Document" ], "summary": "Read common document info.", "operationId": "GetDocument", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DocumentResponse if the format is not specified or the conversion result.", "schema": { "$ref": "#/definitions/DocumentResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Document" ], "summary": "Create empty document.", "operationId": "PutCreateDocument", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The new document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The new document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DocumentResponse with the created document info.", "schema": { "$ref": "#/definitions/DocumentResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Document" ], "summary": "Create empty document.", "operationId": "PostCreateDocument", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The new document name.", "x-nullable": false }, { "name": "documentConfig", "in": "body", "required": true, "description": "The document config for new document.", "schema": { "$ref": "#/definitions/DocumentConfig" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The new document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DocumentResponse with the created document info.", "schema": { "$ref": "#/definitions/DocumentResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/sign": { "post": { "tags": [ "Document" ], "summary": "Sign document.", "operationId": "PostSignDocument", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "sign", "in": "body", "required": true, "description": "Signature object containing signature data.", "schema": { "$ref": "#/definitions/Signature" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "HttpResponseMessage with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/verifySignature": { "get": { "tags": [ "Document" ], "summary": "Verify signature document.", "operationId": "GetVerifySignature", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "signName", "in": "query", "required": true, "description": "Sign name.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SignatureVerifyResponse with operation result.", "schema": { "$ref": "#/definitions/SignatureVerifyResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/privileges": { "put": { "tags": [ "Document" ], "summary": "Update privilege document.", "operationId": "PutPrivileges", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "privileges", "in": "body", "required": true, "description": "Document privileges. DocumentPrivilege", "schema": { "$ref": "#/definitions/DocumentPrivilege" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/optimize": { "post": { "tags": [ "Document" ], "summary": "Optimize document.", "operationId": "PostOptimizeDocument", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "options", "in": "body", "required": true, "description": "The optimization options.", "schema": { "$ref": "#/definitions/OptimizeOptions" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/flatten": { "post": { "tags": [ "Document" ], "summary": "Flatten the document.", "operationId": "PostFlattenDocument", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "boolean", "name": "updateAppearances", "in": "query", "description": "If set, all field appearances will be regenerated before flattening. This option may help if field is incorrectly flattened. This option may decrease performance..", "x-nullable": true }, { "type": "boolean", "name": "callEvents", "in": "query", "description": "If set, formatting and other JavaScript events will be called.", "x-nullable": true }, { "type": "boolean", "name": "hideButtons", "in": "query", "description": "If set, buttons will be removed from flattened document.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/split": { "post": { "tags": [ "Document" ], "summary": "Split document to parts.", "operationId": "PostSplitDocument", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "Document name.", "x-nullable": false }, { "type": "string", "name": "format", "in": "query", "description": "Resulting documents format.", "x-nullable": true }, { "type": "integer", "name": "from", "in": "query", "description": "Start page if defined.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "to", "in": "query", "description": "End page if defined.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SplitResultResponse with resulting documents names.", "schema": { "$ref": "#/definitions/SplitResultResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/splitrangepdf": { "post": { "tags": [ "Document" ], "summary": "Split document into ranges.", "operationId": "PostSplitRangePdfDocument", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "options", "in": "body", "required": true, "description": "The splitting options.", "schema": { "$ref": "#/definitions/SplitRangePdfOptions" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SplitResultResponse with resulting documents names.", "schema": { "$ref": "#/definitions/SplitResultResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/encrypt": { "put": { "tags": [ "Encrypt" ], "summary": "Encrypt document from content.", "operationId": "PutEncryptDocument", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.doc)", "x-nullable": true }, { "type": "string", "name": "userPassword", "in": "query", "required": true, "description": "User password (encrypted Base64).", "x-nullable": true }, { "type": "string", "name": "ownerPassword", "in": "query", "required": true, "description": "Owner password (encrypted Base64).", "x-nullable": true }, { "type": "string", "name": "cryptoAlgorithm", "in": "query", "required": true, "description": "Cryptographic algorithm, see CryptoAlgorithm for details.", "x-schema": { "$ref": "#/definitions/CryptoAlgorithm" }, "x-nullable": false, "enum": [ "RC4x40", "RC4x128", "AESx128", "AESx256" ] }, { "type": "array", "name": "permissionsFlags", "in": "query", "description": "Array of document permissions, see PermissionsFlags for details.", "collectionFormat": "multi", "x-nullable": true, "items": { "$ref": "#/definitions/PermissionsFlags" } }, { "type": "boolean", "name": "usePdf20", "in": "query", "description": "Support for revision 6 (Extension 8).", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be encrypted." } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/encrypt": { "post": { "tags": [ "Encrypt" ], "summary": "Encrypt document in storage.", "operationId": "PostEncryptDocumentInStorage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "Document name.", "x-nullable": false }, { "type": "string", "name": "userPassword", "in": "query", "required": true, "description": "User password (encrypted Base64).", "x-nullable": true }, { "type": "string", "name": "ownerPassword", "in": "query", "required": true, "description": "Owner password (encrypted Base64).", "x-nullable": true }, { "type": "string", "name": "cryptoAlgorithm", "in": "query", "required": true, "description": "Cryptographic algorithm, see CryptoAlgorithm for details.", "x-schema": { "$ref": "#/definitions/CryptoAlgorithm" }, "x-nullable": false, "enum": [ "RC4x40", "RC4x128", "AESx128", "AESx256" ] }, { "type": "array", "name": "permissionsFlags", "in": "query", "description": "Array of document permissions, see PermissionsFlags for details.", "collectionFormat": "multi", "x-nullable": true, "items": { "$ref": "#/definitions/PermissionsFlags" } }, { "type": "boolean", "name": "usePdf20", "in": "query", "description": "Support for revision 6 (Extension 8).", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/checkbox": { "get": { "tags": [ "Fields" ], "summary": "Read document checkbox fields.", "operationId": "GetDocumentCheckBoxFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "CheckBoxFieldsResponse with the field data.", "schema": { "$ref": "#/definitions/CheckBoxFieldsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Fields" ], "summary": "Add document checkbox fields.", "operationId": "PostCheckBoxFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "fields", "in": "body", "required": true, "description": "The array of field.", "schema": { "type": "array", "items": { "$ref": "#/definitions/CheckBoxField" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/page/{pageNumber}/fields/checkbox": { "get": { "tags": [ "Fields" ], "summary": "Read document page checkbox fields.", "operationId": "GetPageCheckBoxFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "CheckBoxFieldsResponse with the fields data.", "schema": { "$ref": "#/definitions/CheckBoxFieldsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/checkbox/{fieldName}": { "get": { "tags": [ "Fields" ], "summary": "Read document checkbox field by name.", "operationId": "GetCheckBoxField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "CheckBoxFieldResponse with the field data.", "schema": { "$ref": "#/definitions/CheckBoxFieldResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Fields" ], "summary": "Replace document checkbox field", "operationId": "PutCheckBoxField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name.", "x-nullable": false }, { "name": "field", "in": "body", "required": true, "description": "The field.", "schema": { "$ref": "#/definitions/CheckBoxField" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "CheckBoxFieldResponse with the checkbox field.", "schema": { "$ref": "#/definitions/CheckBoxFieldResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/combobox": { "get": { "tags": [ "Fields" ], "summary": "Read document combobox fields.", "operationId": "GetDocumentComboBoxFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ComboBoxFieldsResponse with the field data.", "schema": { "$ref": "#/definitions/ComboBoxFieldsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Fields" ], "summary": "Add document combobox fields.", "operationId": "PostComboBoxFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "fields", "in": "body", "required": true, "description": "The array of field.", "schema": { "type": "array", "items": { "$ref": "#/definitions/ComboBoxField" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/page/{pageNumber}/fields/combobox": { "get": { "tags": [ "Fields" ], "summary": "Read document page combobox fields.", "operationId": "GetPageComboBoxFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ComboBoxFieldsResponse with the fields data.", "schema": { "$ref": "#/definitions/ComboBoxFieldsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/combobox/{fieldName}": { "get": { "tags": [ "Fields" ], "summary": "Read document combobox field by name.", "operationId": "GetComboBoxField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ComboBoxFieldResponse with the field data.", "schema": { "$ref": "#/definitions/ComboBoxFieldResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Fields" ], "summary": "Replace document combobox field", "operationId": "PutComboBoxField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name.", "x-nullable": false }, { "name": "field", "in": "body", "required": true, "description": "The field.", "schema": { "$ref": "#/definitions/ComboBoxField" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ComboBoxFieldResponse with the combobox field.", "schema": { "$ref": "#/definitions/ComboBoxFieldResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/listbox": { "get": { "tags": [ "Fields" ], "summary": "Read document listbox fields.", "operationId": "GetDocumentListBoxFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ListBoxFieldsResponse with the field data.", "schema": { "$ref": "#/definitions/ListBoxFieldsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Fields" ], "summary": "Add document listbox fields.", "operationId": "PostListBoxFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "fields", "in": "body", "required": true, "description": "The array of field.", "schema": { "type": "array", "items": { "$ref": "#/definitions/ListBoxField" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/page/{pageNumber}/fields/listbox": { "get": { "tags": [ "Fields" ], "summary": "Read document page listbox fields.", "operationId": "GetPageListBoxFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ListBoxFieldsResponse with the fields data.", "schema": { "$ref": "#/definitions/ListBoxFieldsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/listbox/{fieldName}": { "get": { "tags": [ "Fields" ], "summary": "Read document listbox field by name.", "operationId": "GetListBoxField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ListBoxFieldResponse with the field data.", "schema": { "$ref": "#/definitions/ListBoxFieldResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Fields" ], "summary": "Replace document listbox field", "operationId": "PutListBoxField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name.", "x-nullable": false }, { "name": "field", "in": "body", "required": true, "description": "The field.", "schema": { "$ref": "#/definitions/ListBoxField" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ListBoxFieldResponse with the listbox field.", "schema": { "$ref": "#/definitions/ListBoxFieldResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/radiobutton": { "get": { "tags": [ "Fields" ], "summary": "Read document radiobutton fields.", "operationId": "GetDocumentRadioButtonFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "RadioButtonFieldsResponse with the field data.", "schema": { "$ref": "#/definitions/RadioButtonFieldsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Fields" ], "summary": "Add document RadioButton fields.", "operationId": "PostRadioButtonFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "fields", "in": "body", "required": true, "description": "The array of field.", "schema": { "type": "array", "items": { "$ref": "#/definitions/RadioButtonField" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/page/{pageNumber}/fields/radiobutton": { "get": { "tags": [ "Fields" ], "summary": "Read document page radiobutton fields.", "operationId": "GetPageRadioButtonFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "RadioButtonFieldsResponse with the fields data.", "schema": { "$ref": "#/definitions/RadioButtonFieldsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/radiobutton/{fieldName}": { "get": { "tags": [ "Fields" ], "summary": "Read document RadioButton field by name.", "operationId": "GetRadioButtonField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "RadioButtonFieldResponse with the field data.", "schema": { "$ref": "#/definitions/RadioButtonFieldResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Fields" ], "summary": "Replace document RadioButton field", "operationId": "PutRadioButtonField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name.", "x-nullable": false }, { "name": "field", "in": "body", "required": true, "description": "The field.", "schema": { "$ref": "#/definitions/RadioButtonField" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "RadioButtonFieldResponse with the RadioButton field.", "schema": { "$ref": "#/definitions/RadioButtonFieldResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/signature": { "get": { "tags": [ "Fields" ], "summary": "Read document signature fields.", "operationId": "GetDocumentSignatureFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SignatureFieldsResponse with the field data.", "schema": { "$ref": "#/definitions/SignatureFieldsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Fields" ], "summary": "Add document signature field.", "operationId": "PostSignatureField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "field", "in": "body", "required": true, "description": "The field.", "schema": { "$ref": "#/definitions/SignatureField" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/page/{pageNumber}/fields/signature": { "get": { "tags": [ "Fields" ], "summary": "Read document page signature fields.", "operationId": "GetPageSignatureFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SignatureFieldsResponse with the fields data.", "schema": { "$ref": "#/definitions/SignatureFieldsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/signature/{fieldName}": { "get": { "tags": [ "Fields" ], "summary": "Read document signature field by name.", "operationId": "GetSignatureField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SignatureFieldResponse with the field data.", "schema": { "$ref": "#/definitions/SignatureFieldResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Fields" ], "summary": "Replace document signature field.", "operationId": "PutSignatureField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name.", "x-nullable": false }, { "name": "field", "in": "body", "required": true, "description": "The field.", "schema": { "$ref": "#/definitions/SignatureField" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "SignatureFieldResponse with the signature field.", "schema": { "$ref": "#/definitions/SignatureFieldResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/textbox": { "get": { "tags": [ "Fields" ], "summary": "Read document text box fields.", "operationId": "GetDocumentTextBoxFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "TextBoxFieldsResponse with the field data.", "schema": { "$ref": "#/definitions/TextBoxFieldsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Fields" ], "summary": "Add document text box fields.", "operationId": "PostTextBoxFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "fields", "in": "body", "required": true, "description": "The array of field.", "schema": { "type": "array", "items": { "$ref": "#/definitions/TextBoxField" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/page/{pageNumber}/fields/textbox": { "get": { "tags": [ "Fields" ], "summary": "Read document page text box fields.", "operationId": "GetPageTextBoxFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "TextBoxFieldsResponse with the fields data.", "schema": { "$ref": "#/definitions/TextBoxFieldsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/textbox/{fieldName}": { "get": { "tags": [ "Fields" ], "summary": "Read document text box field by name.", "operationId": "GetTextBoxField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "TextBoxFieldResponse with the field data.", "schema": { "$ref": "#/definitions/TextBoxFieldResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Fields" ], "summary": "Replace document text box field", "operationId": "PutTextBoxField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name.", "x-nullable": false }, { "name": "field", "in": "body", "required": true, "description": "The field.", "schema": { "$ref": "#/definitions/TextBoxField" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "TextBoxFieldResponse with the text field.", "schema": { "$ref": "#/definitions/TextBoxFieldResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/{fieldName}": { "put": { "tags": [ "Fields" ], "summary": "Update field.", "operationId": "PutUpdateField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The name of a field to be updated.", "x-nullable": false }, { "name": "field", "in": "body", "required": true, "description": "Field with the field data.", "schema": { "$ref": "#/definitions/Field" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "FieldResponse with updated field data.", "schema": { "$ref": "#/definitions/FieldResponse" } } }, "security": [ { "JWT": [] } ] }, "get": { "tags": [ "Fields" ], "summary": "Get document field by name.", "operationId": "GetField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name (name should be encoded).", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "FieldResponse with the field data.", "schema": { "$ref": "#/definitions/FieldResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Fields" ], "summary": "Delete document field by name.", "operationId": "DeleteField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fieldName", "in": "path", "required": true, "description": "The field name/", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields": { "put": { "tags": [ "Fields" ], "summary": "Update fields.", "operationId": "PutUpdateFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "fields", "in": "body", "required": true, "description": "Fields with the fields data.", "schema": { "$ref": "#/definitions/Fields" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "FieldsResponse with updated fields data.", "schema": { "$ref": "#/definitions/FieldsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Fields" ], "summary": "Create field.", "operationId": "PostCreateField", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "page", "in": "query", "required": true, "description": "Document page number.", "format": "int32", "x-nullable": false }, { "name": "field", "in": "body", "required": true, "description": "Field with the field data.", "schema": { "$ref": "#/definitions/Field" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] }, "get": { "tags": [ "Fields" ], "summary": "Get document fields.", "operationId": "GetFields", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "FieldsResponse with the fields data.", "schema": { "$ref": "#/definitions/FieldsResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/fields/flatten": { "put": { "tags": [ "Fields" ], "summary": "Flatten form fields in document.", "operationId": "PutFieldsFlatten", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/export/fdf": { "get": { "tags": [ "FormData" ], "summary": "Export fields from from PDF in storage to FDF file.", "operationId": "GetExportFieldsFromPdfToFdfInStorage", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "FormData" ], "summary": "Export fields from from PDF in storage to FDF file in storage.", "operationId": "PutExportFieldsFromPdfToFdfInStorage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fdfOutputFilePath", "in": "query", "required": true, "description": "The output Fdf file path.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/export/xfdf": { "get": { "tags": [ "FormData" ], "summary": "Export fields from from PDF in storage to XFDF file.", "operationId": "GetExportFieldsFromPdfToXfdfInStorage", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "FormData" ], "summary": "Export fields from from PDF in storage to XFDF file in storage.", "operationId": "PutExportFieldsFromPdfToXfdfInStorage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "xfdfOutputFilePath", "in": "query", "required": true, "description": "The output xfdf file path.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/export/xml": { "get": { "tags": [ "FormData" ], "summary": "Export fields from from PDF in storage to XML file.", "operationId": "GetExportFieldsFromPdfToXmlInStorage", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "FormData" ], "summary": "Export fields from from PDF in storage to XML file in storage.", "operationId": "PutExportFieldsFromPdfToXmlInStorage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "xmlOutputFilePath", "in": "query", "required": true, "description": "The output xml file path.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/import/fdf": { "get": { "tags": [ "FormData" ], "summary": "Update fields from FDF file in storage.", "operationId": "GetImportFieldsFromFdfInStorage", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fdfFilePath", "in": "query", "required": true, "description": "The Fdf file path.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "FormData" ], "summary": "Update fields from FDF file in request.", "operationId": "PostImportFieldsFromFdf", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "file", "name": "fdfData", "in": "formData", "description": "Fdf file." } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "FormData" ], "summary": "Update fields from FDF file in storage.", "operationId": "PutImportFieldsFromFdfInStorage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "fdfFilePath", "in": "query", "required": true, "description": "The Fdf file path.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/import/xfdf": { "get": { "tags": [ "FormData" ], "summary": "Update fields from XFDF file in storage.", "operationId": "GetImportFieldsFromXfdfInStorage", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "xfdfFilePath", "in": "query", "required": true, "description": "The XFDF file path.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "FormData" ], "summary": "Update fields from XFDF file in request.", "operationId": "PostImportFieldsFromXfdf", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "file", "name": "xfdfData", "in": "formData", "description": "Xfdf file." } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "FormData" ], "summary": "Update fields from XFDF file in storage.", "operationId": "PutImportFieldsFromXfdfInStorage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "xfdfFilePath", "in": "query", "required": true, "description": "The XFDF file path.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/import/xml": { "get": { "tags": [ "FormData" ], "summary": "Import from XML file (located on storage) to PDF format and return resulting file in response. ", "operationId": "GetImportFieldsFromXmlInStorage", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "xmlFilePath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.xml)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion result in content", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "FormData" ], "summary": "Update fields from XML file in request.", "operationId": "PostImportFieldsFromXml", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "file", "name": "xmlData", "in": "formData", "description": "Xml file." } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "FormData" ], "summary": "Update fields from XML file in storage.", "operationId": "PutImportFieldsFromXmlInStorage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "xmlFilePath", "in": "query", "required": true, "description": "Full source filename (ex. /folder1/folder2/template.xml)", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/header/text": { "post": { "tags": [ "HeaderFooter" ], "summary": "Add document text header.", "operationId": "PostDocumentTextHeader", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "textHeader", "in": "body", "required": true, "description": "The text header.", "schema": { "$ref": "#/definitions/TextHeader" }, "x-nullable": true }, { "type": "integer", "name": "startPageNumber", "in": "query", "description": "The start page number.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endPageNumber", "in": "query", "description": "The end page number.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/footer/text": { "post": { "tags": [ "HeaderFooter" ], "summary": "Add document text footer.", "operationId": "PostDocumentTextFooter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "textFooter", "in": "body", "required": true, "description": "The text footer.", "schema": { "$ref": "#/definitions/TextFooter" }, "x-nullable": true }, { "type": "integer", "name": "startPageNumber", "in": "query", "description": "The start page number.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endPageNumber", "in": "query", "description": "The end page number.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/header/image": { "post": { "tags": [ "HeaderFooter" ], "summary": "Add document image header.", "operationId": "PostDocumentImageHeader", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "imageHeader", "in": "body", "required": true, "description": "The image header.", "schema": { "$ref": "#/definitions/ImageHeader" }, "x-nullable": true }, { "type": "integer", "name": "startPageNumber", "in": "query", "description": "The start page number.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endPageNumber", "in": "query", "description": "The end page number.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/footer/image": { "post": { "tags": [ "HeaderFooter" ], "summary": "Add document image footer.", "operationId": "PostDocumentImageFooter", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "imageFooter", "in": "body", "required": true, "description": "The image footer.", "schema": { "$ref": "#/definitions/ImageFooter" }, "x-nullable": true }, { "type": "integer", "name": "startPageNumber", "in": "query", "description": "The start page number.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endPageNumber", "in": "query", "description": "The end page number.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/images": { "get": { "tags": [ "Images" ], "summary": "Read document images.", "operationId": "GetImages", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ImagesResponse with page images common info.", "schema": { "$ref": "#/definitions/ImagesResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Images" ], "summary": "Insert image to document page.", "operationId": "PostInsertImage", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "number", "name": "llx", "in": "query", "required": true, "description": "Coordinate lower left X.", "format": "double", "x-nullable": false }, { "type": "number", "name": "lly", "in": "query", "required": true, "description": "Coordinate lower left Y.", "format": "double", "x-nullable": false }, { "type": "number", "name": "urx", "in": "query", "required": true, "description": "Coordinate upper right X.", "format": "double", "x-nullable": false }, { "type": "number", "name": "ury", "in": "query", "required": true, "description": "Coordinate upper right Y.", "format": "double", "x-nullable": false }, { "type": "string", "name": "imageFilePath", "in": "query", "description": "Path to image file if specified. Request content is used otherwise.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "file", "name": "image", "in": "formData", "description": "Image file." } ], "responses": { "200": { "x-nullable": true, "description": "ImageResponse with updated image data.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/images/{imageId}": { "get": { "tags": [ "Images" ], "summary": "Read document image by ID.", "operationId": "GetImage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "imageId", "in": "path", "required": true, "description": "Image ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "HttpResponseMessage with image common data or its conversion result.", "schema": { "$ref": "#/definitions/ImageResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Images" ], "summary": "Delete image from document page.", "operationId": "DeleteImage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "imageId", "in": "path", "required": true, "description": "Image ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ImageResponse with updated image data.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Images" ], "summary": "Replace document image.", "operationId": "PutReplaceImage", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "imageId", "in": "path", "required": true, "description": "The image ID.", "x-nullable": false }, { "type": "string", "name": "imageFilePath", "in": "query", "description": "Path to image file if specified. Request content is used otherwise.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "file", "name": "image", "in": "formData", "description": "Image file." } ], "responses": { "200": { "x-nullable": true, "description": "ImageResponse with updated image data.", "schema": { "$ref": "#/definitions/ImageResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/images/replace": { "put": { "tags": [ "Images" ], "summary": "Replace document multiple image.", "operationId": "PutReplaceMultipleImage", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "array", "name": "imageIds", "in": "query", "required": true, "description": "The image IDs.", "collectionFormat": "multi", "x-nullable": true, "items": { "type": "string" } }, { "type": "string", "name": "imageFilePath", "in": "query", "description": "Path to image file if specified. Request content is used otherwise.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "file", "name": "image", "in": "formData", "description": "Image file." } ], "responses": { "200": { "x-nullable": true, "description": "ImageResponse with updated image data.", "schema": { "$ref": "#/definitions/ImagesResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/images/{imageId}/extract/jpeg": { "get": { "tags": [ "Images" ], "summary": "Extract document image in JPEG format", "operationId": "GetImageExtractAsJpeg", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "imageId", "in": "path", "required": true, "description": "Image ID.", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Images" ], "summary": "Extract document image in JPEG format to folder", "operationId": "PutImageExtractAsJpeg", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "imageId", "in": "path", "required": true, "description": "Image ID.", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "destFolder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/images/{imageId}/extract/tiff": { "get": { "tags": [ "Images" ], "summary": "Extract document image in TIFF format", "operationId": "GetImageExtractAsTiff", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "imageId", "in": "path", "required": true, "description": "Image ID.", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Images" ], "summary": "Extract document image in TIFF format to folder", "operationId": "PutImageExtractAsTiff", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "imageId", "in": "path", "required": true, "description": "Image ID.", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "destFolder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/images/{imageId}/extract/gif": { "get": { "tags": [ "Images" ], "summary": "Extract document image in GIF format", "operationId": "GetImageExtractAsGif", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "imageId", "in": "path", "required": true, "description": "Image ID.", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Images" ], "summary": "Extract document image in GIF format to folder", "operationId": "PutImageExtractAsGif", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "imageId", "in": "path", "required": true, "description": "Image ID.", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "destFolder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/images/{imageId}/extract/png": { "get": { "tags": [ "Images" ], "summary": "Extract document image in PNG format", "operationId": "GetImageExtractAsPng", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "imageId", "in": "path", "required": true, "description": "Image ID.", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Images" ], "summary": "Extract document image in PNG format to folder", "operationId": "PutImageExtractAsPng", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "imageId", "in": "path", "required": true, "description": "Image ID.", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "destFolder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/images/extract/jpeg": { "put": { "tags": [ "Images" ], "summary": "Extract document images in JPEG format to folder.", "operationId": "PutImagesExtractAsJpeg", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "destFolder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/images/extract/tiff": { "put": { "tags": [ "Images" ], "summary": "Extract document images in TIFF format to folder.", "operationId": "PutImagesExtractAsTiff", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "destFolder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/images/extract/gif": { "put": { "tags": [ "Images" ], "summary": "Extract document images in GIF format to folder.", "operationId": "PutImagesExtractAsGif", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "destFolder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/images/extract/png": { "put": { "tags": [ "Images" ], "summary": "Extract document images in PNG format to folder.", "operationId": "PutImagesExtractAsPng", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "destFolder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/images/extract/svg": { "get": { "tags": [ "Images" ], "summary": "Extract SVG images from document page.", "operationId": "GetImagesExtractSvg", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "passBase64", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "", "schema": { "$ref": "#/definitions/SvgImages" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/layers": { "get": { "tags": [ "Layer" ], "summary": "Gets document layers.", "operationId": "GetDocumentLayers", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "passBase64", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DocumentLayers instance", "schema": { "$ref": "#/definitions/DocumentLayers" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Layer" ], "summary": "Remove document layer.", "operationId": "DeleteDocumentLayer", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "query", "required": true, "description": "Layer page.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "layerId", "in": "query", "required": true, "description": "Layer Id.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "passBase64", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse instance", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Layer" ], "summary": "Create a separate PDF from a PDF Layer and upload resulting file to storage.", "operationId": "PutCreatePdfFromLayer", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "query", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "The out path of result image.", "x-nullable": true }, { "type": "string", "name": "layerId", "in": "query", "required": true, "description": "Layer Id.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "passBase64", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/links": { "get": { "tags": [ "Links" ], "summary": "Read document page link annotations.", "operationId": "GetPageLinkAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "LinkAnnotationsResponse with the page link annotations info.", "schema": { "$ref": "#/definitions/LinkAnnotationsResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Links" ], "summary": "Add document page link annotations.", "operationId": "PostPageLinkAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "links", "in": "body", "required": true, "description": "Array of link annotation.", "schema": { "type": "array", "items": { "$ref": "#/definitions/LinkAnnotation" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Links" ], "summary": "Delete all link annotations from the page", "operationId": "DeletePageLinkAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/links/{linkId}": { "get": { "tags": [ "Links" ], "summary": "Read document page link annotation by ID.", "operationId": "GetPageLinkAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "linkId", "in": "path", "required": true, "description": "The link ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "LinkAnnotationResponse with the link data.", "schema": { "$ref": "#/definitions/LinkAnnotationResponse" } } }, "deprecated": true, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/links/{linkId}": { "get": { "tags": [ "Links" ], "summary": "Read document link annotation by ID.", "operationId": "GetLinkAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "linkId", "in": "path", "required": true, "description": "The link ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "LinkAnnotationResponse with the link data.", "schema": { "$ref": "#/definitions/LinkAnnotationResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Links" ], "summary": "Delete document page link annotation by ID", "operationId": "DeleteLinkAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "linkId", "in": "path", "required": true, "description": "The link ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Links" ], "summary": "Replace document page link annotations", "operationId": "PutLinkAnnotation", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "linkId", "in": "path", "required": true, "description": "The link ID.", "x-nullable": false }, { "name": "link", "in": "body", "required": true, "description": "Link annotation.", "schema": { "$ref": "#/definitions/LinkAnnotation" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "LinkAnnotationResponse with the page link annotation info.", "schema": { "$ref": "#/definitions/LinkAnnotationResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/links": { "delete": { "tags": [ "Links" ], "summary": "Delete all link annotations from the document", "operationId": "DeleteDocumentLinkAnnotations", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/merge": { "put": { "tags": [ "Merge" ], "summary": "Merge a list of documents.", "operationId": "PutMergeDocuments", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "Resulting document name.", "x-nullable": false }, { "name": "mergeDocuments", "in": "body", "required": true, "description": "MergeDocuments with a list of documents.", "schema": { "$ref": "#/definitions/MergeDocuments" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "Resulting document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "Resulting document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DocumentResponse with the resulting document info.", "schema": { "$ref": "#/definitions/DocumentResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/ocr": { "put": { "tags": [ "Ocr" ], "summary": "Create searchable PDF document.\nGenerate OCR layer for images in input PDF document.", "operationId": "PutSearchableDocument", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "lang", "in": "query", "description": "language for OCR engine. Possible values: eng, ara, bel, ben, bul, ces, dan, deu, ell, fin, fra, heb, hin, ind, isl, ita, jpn, kor, nld, nor, pol, por, ron, rus, spa, swe, tha, tur, ukr, vie, chi_sim, chi_tra or thier combination e.g. eng,rus ", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/organize": { "post": { "tags": [ "Organize" ], "summary": "Merge selected pages of a document.", "operationId": "PostOrganizeDocument", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The original document name.", "x-nullable": false }, { "type": "string", "name": "pages", "in": "query", "required": true, "description": "1-based page numbers of the source document that make up the resulting document.", "minLength": 1, "x-nullable": true }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full filename of the resulting document.", "minLength": 1, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The documents storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The source document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/organize": { "post": { "tags": [ "Organize" ], "summary": "Merge selected pages of different documents.", "operationId": "PostOrganizeDocuments", "parameters": [ { "name": "organizeDocuments", "in": "body", "required": true, "description": "Array of OrganizeDocumentData to make up the resulting document.", "schema": { "$ref": "#/definitions/OrganizeDocumentRequest" }, "x-nullable": true }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full filename of the resulting document.", "minLength": 1, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The documents storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/compare": { "post": { "tags": [ "Organize" ], "summary": "Compare two PDF documents.", "operationId": "PostComparePdf", "parameters": [ { "type": "string", "name": "path1", "in": "query", "required": true, "description": "Path to first PDF document.", "x-nullable": true }, { "type": "string", "name": "path2", "in": "query", "required": true, "description": "Path to second PDF document.", "x-nullable": true }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full filename of the resulting document.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The documents storage.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages": { "get": { "tags": [ "Pages" ], "summary": "Read document pages info.", "operationId": "GetPages", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DocumentPagesResponse with the pages info.", "schema": { "$ref": "#/definitions/DocumentPagesResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Pages" ], "summary": "Add new page to end of the document.", "operationId": "PutAddNewPage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DocumentPagesResponse with updated pages info.", "schema": { "$ref": "#/definitions/DocumentPagesResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}": { "get": { "tags": [ "Pages" ], "summary": "Read document page info.", "operationId": "GetPage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DocumentPageResponse is the format is not specified, the converting result otherwise.", "schema": { "$ref": "#/definitions/DocumentPageResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Pages" ], "summary": "Delete document page by its number.", "operationId": "DeletePage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with the operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/sign": { "post": { "tags": [ "Pages" ], "summary": "Sign page.", "operationId": "PostSignPage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "sign", "in": "body", "required": true, "description": "Signature object containing signature data.", "schema": { "$ref": "#/definitions/Signature" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with the operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/certify": { "post": { "tags": [ "Pages" ], "summary": "Certify document page.", "operationId": "PostPageCertify", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "sign", "in": "body", "required": true, "description": "Signature object containing signature data.", "schema": { "$ref": "#/definitions/Signature" }, "x-nullable": true }, { "type": "string", "name": "docMdpAccessPermissionType", "in": "query", "required": true, "description": "The access permissions granted for this document.", "x-schema": { "$ref": "#/definitions/DocMDPAccessPermissionType" }, "x-nullable": false, "enum": [ "NoChanges", "FillingInForms", "AnnotationModification" ] }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "IActionResult with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/convert/tiff": { "get": { "tags": [ "Pages" ], "summary": "Convert document page to Tiff image and return resulting file in response.", "operationId": "GetPageConvertToTiff", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "IActionResult with conversion result.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Pages" ], "summary": "Convert document page to Tiff image and upload resulting file to storage.", "operationId": "PutPageConvertToTiff", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "The out path of result image.", "x-nullable": true }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/convert/jpeg": { "get": { "tags": [ "Pages" ], "summary": "Convert document page to Jpeg image and return resulting file in response.", "operationId": "GetPageConvertToJpeg", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "IActionResult with conversion result.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Pages" ], "summary": "Convert document page to Jpeg image and upload resulting file to storage.", "operationId": "PutPageConvertToJpeg", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "The out path of result image.", "x-nullable": true }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/convert/png": { "get": { "tags": [ "Pages" ], "summary": "Convert document page to Png image and return resulting file in response.", "operationId": "GetPageConvertToPng", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "IActionResult with conversion result.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Pages" ], "summary": "Convert document page to png image and upload resulting file to storage.", "operationId": "PutPageConvertToPng", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "The out path of result image.", "x-nullable": true }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/convert/emf": { "get": { "tags": [ "Pages" ], "summary": "Convert document page to Emf image and return resulting file in response.", "operationId": "GetPageConvertToEmf", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "IActionResult with conversion result.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Pages" ], "summary": "Convert document page to emf image and upload resulting file to storage.", "operationId": "PutPageConvertToEmf", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "The out path of result image.", "x-nullable": true }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/convert/bmp": { "get": { "tags": [ "Pages" ], "summary": "Convert document page to Bmp image and return resulting file in response.", "operationId": "GetPageConvertToBmp", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "IActionResult with conversion result.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Pages" ], "summary": "Convert document page to bmp image and upload resulting file to storage.", "operationId": "PutPageConvertToBmp", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "The out path of result image.", "x-nullable": true }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/convert/gif": { "get": { "tags": [ "Pages" ], "summary": "Convert document page to Gif image and return resulting file in response.", "operationId": "GetPageConvertToGif", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "IActionResult with conversion result.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Pages" ], "summary": "Convert document page to gif image and upload resulting file to storage.", "operationId": "PutPageConvertToGif", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "The out path of result image.", "x-nullable": true }, { "type": "integer", "name": "width", "in": "query", "description": "The converted image width.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "integer", "name": "height", "in": "query", "description": "The converted image height.", "format": "int32", "default": 0, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "ResponseMessage with conversion status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/wordCount": { "get": { "tags": [ "Pages" ], "summary": "Get number of words per document page.", "operationId": "GetWordsPerPage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "WordCountResponse with number of words per document page.", "schema": { "$ref": "#/definitions/WordCountResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/movePage": { "post": { "tags": [ "Pages" ], "summary": "Move page to new position.", "operationId": "PostMovePage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "integer", "name": "newIndex", "in": "query", "required": true, "description": "The new page position/index.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with the operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/stamp": { "put": { "tags": [ "Pages" ], "summary": "Add page stamp.", "operationId": "PutPageAddStamp", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "stamp", "in": "body", "required": true, "description": "Stamp with data.", "schema": { "$ref": "#/definitions/Stamp" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/changepassword": { "put": { "tags": [ "Password" ], "summary": "Change document password from content.", "operationId": "PutChangePasswordDocument", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "outPath", "in": "query", "required": true, "description": "Full resulting filename (ex. /folder1/folder2/result.doc)", "x-nullable": true }, { "type": "string", "name": "ownerPassword", "in": "query", "required": true, "description": "Owner password (encrypted Base64).", "x-nullable": true }, { "type": "string", "name": "newUserPassword", "in": "query", "required": true, "description": "New user password (encrypted Base64).", "x-nullable": true }, { "type": "string", "name": "newOwnerPassword", "in": "query", "required": true, "description": "New owner password (encrypted Base64).", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "file", "name": "file", "in": "formData", "description": "A file to be changed password." } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/changepassword": { "post": { "tags": [ "Password" ], "summary": "Change document password in storage.", "operationId": "PostChangePasswordDocumentInStorage", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "Document name.", "x-nullable": false }, { "type": "string", "name": "ownerPassword", "in": "query", "required": true, "description": "Owner password (encrypted Base64).", "x-nullable": true }, { "type": "string", "name": "newUserPassword", "in": "query", "required": true, "description": "New user password (encrypted Base64).", "x-nullable": true }, { "type": "string", "name": "newOwnerPassword", "in": "query", "required": true, "description": "New owner password (encrypted Base64).", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/documentproperties": { "get": { "tags": [ "Properties" ], "summary": "Read document properties.", "operationId": "GetDocumentProperties", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DocumentPropertiesResponse instance.", "schema": { "$ref": "#/definitions/DocumentPropertiesResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Properties" ], "summary": "Delete custom document properties.", "operationId": "DeleteProperties", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/documentproperties/{propertyName}": { "get": { "tags": [ "Properties" ], "summary": "Read document property by name.", "operationId": "GetDocumentProperty", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "propertyName", "in": "path", "required": true, "description": "Property name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DocumentPropertyResponse", "schema": { "$ref": "#/definitions/DocumentPropertyResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Properties" ], "summary": "Add/update document property.", "operationId": "PutSetProperty", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "propertyName", "in": "path", "required": true, "description": "Property name.", "x-nullable": false }, { "type": "string", "name": "value", "in": "query", "required": true, "description": "Property value.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "DocumentPropertyResponse", "schema": { "$ref": "#/definitions/DocumentPropertyResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Properties" ], "summary": "Delete document property.", "operationId": "DeleteProperty", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "propertyName", "in": "path", "required": true, "description": "Property name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/stamps": { "get": { "tags": [ "Stamps" ], "summary": "Read document stamps.", "operationId": "GetDocumentStamps", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "StampsInfoResponse with the page stamps info.", "schema": { "$ref": "#/definitions/StampsInfoResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Stamps" ], "summary": "Delete all stamps from the document", "operationId": "DeleteDocumentStamps", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/stamps": { "get": { "tags": [ "Stamps" ], "summary": "Read page document stamps.", "operationId": "GetPageStamps", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "StampsInfoResponse with the page stamps info.", "schema": { "$ref": "#/definitions/StampsInfoResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Stamps" ], "summary": "Delete all stamps from the page", "operationId": "DeletePageStamps", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/stamps/text": { "post": { "tags": [ "Stamps" ], "summary": "Add document pages text stamps.", "operationId": "PostDocumentTextStamps", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "stamps", "in": "body", "required": true, "description": "The array of stamp.", "schema": { "type": "array", "items": { "$ref": "#/definitions/TextStamp" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/stamps/text": { "post": { "tags": [ "Stamps" ], "summary": "Add document page text stamps.", "operationId": "PostPageTextStamps", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "stamps", "in": "body", "required": true, "description": "The array of stamp.", "schema": { "type": "array", "items": { "$ref": "#/definitions/TextStamp" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/stamps/text/pagespecified": { "post": { "tags": [ "Stamps" ], "summary": "Add document text stamps to specified pages.", "operationId": "PostDocumentTextStampsPageSpecified", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "stamps", "in": "body", "required": true, "description": "The array of stamps.", "schema": { "type": "array", "items": { "$ref": "#/definitions/TextStampPageSpecified" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/stamps/image": { "post": { "tags": [ "Stamps" ], "summary": "Add document pages image stamps.", "operationId": "PostDocumentImageStamps", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "stamps", "in": "body", "required": true, "description": "The array of stamp.", "schema": { "type": "array", "items": { "$ref": "#/definitions/ImageStamp" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/stamps/image/pagespecified": { "post": { "tags": [ "Stamps" ], "summary": "Add document image stamps to specified pages.", "operationId": "PostDocumentImageStampsPageSpecified", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "stamps", "in": "body", "required": true, "description": "The array of stamps.", "schema": { "type": "array", "items": { "$ref": "#/definitions/ImageStampPageSpecified" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/stamps/image": { "post": { "tags": [ "Stamps" ], "summary": "Add document page image stamps.", "operationId": "PostPageImageStamps", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "stamps", "in": "body", "required": true, "description": "The array of stamp.", "schema": { "type": "array", "items": { "$ref": "#/definitions/ImageStamp" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/stamps/pdfpage": { "post": { "tags": [ "Stamps" ], "summary": "Add document pdf page stamps.", "operationId": "PostPagePdfPageStamps", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "stamps", "in": "body", "required": true, "description": "The array of stamp.", "schema": { "type": "array", "items": { "$ref": "#/definitions/PdfPageStamp" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/stamps/pagenumber": { "post": { "tags": [ "Stamps" ], "summary": "Add document page number stamps.", "operationId": "PostDocumentPageNumberStamps", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "stamp", "in": "body", "required": true, "description": "The stamp.", "schema": { "$ref": "#/definitions/PageNumberStamp" }, "x-nullable": true }, { "type": "integer", "name": "startPageNumber", "in": "query", "description": "The start page number.", "format": "int32", "x-nullable": true }, { "type": "integer", "name": "endPageNumber", "in": "query", "description": "The end page number.", "format": "int32", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with status.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/stamps/{stampId}": { "delete": { "tags": [ "Stamps" ], "summary": "Delete document stamp by ID", "operationId": "DeleteStamp", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "stampId", "in": "path", "required": true, "description": "The stamp ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "password", "in": "query", "description": "Base64 encoded password.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/tables": { "get": { "tags": [ "Table" ], "summary": "Read document tables.", "operationId": "GetDocumentTables", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "TablesRecognizedResponse with the page tables info.", "schema": { "$ref": "#/definitions/TablesRecognizedResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Table" ], "summary": "Delete all tables from the document", "operationId": "DeleteDocumentTables", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/tables": { "get": { "tags": [ "Table" ], "summary": "Read document page tables.", "operationId": "GetPageTables", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "TablesRecognizedResponse with the page tables info.", "schema": { "$ref": "#/definitions/TablesRecognizedResponse" } } }, "security": [ { "JWT": [] } ] }, "post": { "tags": [ "Table" ], "summary": "Add document page tables.", "operationId": "PostPageTables", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "name": "tables", "in": "body", "required": true, "description": "The array of table.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Table" } }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Table" ], "summary": "Delete all tables from the page", "operationId": "DeletePageTables", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "description": "The page number.", "format": "int32", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/tables/{tableId}": { "get": { "tags": [ "Table" ], "summary": "Read document page table by ID.", "operationId": "GetTable", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "tableId", "in": "path", "required": true, "description": "The table ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "TableRecognizedResponse with the table data.", "schema": { "$ref": "#/definitions/TableRecognizedResponse" } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Table" ], "summary": "Replace document page table.", "operationId": "PutTable", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "tableId", "in": "path", "required": true, "description": "The table ID.", "x-nullable": false }, { "name": "table", "in": "body", "required": true, "description": "The table.", "schema": { "$ref": "#/definitions/Table" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Table" ], "summary": "Delete document table by ID", "operationId": "DeleteTable", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "tableId", "in": "path", "required": true, "description": "The table ID.", "x-nullable": false }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse with operation result.", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/text/replace": { "post": { "tags": [ "TextReplace" ], "summary": "Document's replace text method.", "operationId": "PostDocumentTextReplace", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "x-nullable": false }, { "name": "textReplace", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TextReplaceListRequest" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "", "schema": { "$ref": "#/definitions/TextReplaceResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/pages/{pageNumber}/text/replace": { "post": { "tags": [ "TextReplace" ], "summary": "Page's replace text method.", "operationId": "PostPageTextReplace", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "x-nullable": false }, { "type": "integer", "name": "pageNumber", "in": "path", "required": true, "format": "int32", "x-nullable": false }, { "name": "textReplaceListRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TextReplaceListRequest" }, "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "", "schema": { "$ref": "#/definitions/TextReplaceResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/xmpmetadata/json": { "get": { "tags": [ "XmpMetadata" ], "summary": "Gets document XMP Metadata as JSON.", "operationId": "GetXmpMetadataJson", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "passBase64", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "XmpMetadata instance", "schema": { "$ref": "#/definitions/XmpMetadata" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/xmpmetadata/xml": { "get": { "tags": [ "XmpMetadata" ], "summary": "Gets document XMP Metadata as XML file.", "operationId": "GetXmpMetadataXml", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "passBase64", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "XML file.", "schema": { "type": "file" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/{name}/xmpmetadata": { "post": { "tags": [ "XmpMetadata" ], "summary": "Add or remove XMP Metadata properties.", "operationId": "PostXmpMetadata", "parameters": [ { "type": "string", "name": "name", "in": "path", "required": true, "description": "The document name.", "x-nullable": false }, { "name": "metadata", "in": "body", "required": true, "description": "XmpMetadata instance.", "schema": { "$ref": "#/definitions/XmpMetadata" }, "x-nullable": true }, { "type": "string", "name": "folder", "in": "query", "description": "The document folder.", "x-nullable": true }, { "type": "string", "name": "storage", "in": "query", "description": "The document storage.", "x-nullable": true }, { "type": "string", "name": "passBase64", "in": "query", "description": "The password (Base64).", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "AsposeResponse instance", "schema": { "$ref": "#/definitions/AsposeResponse" } } }, "security": [ { "JWT": [] } ] } }, "/pdf/storage/file/{path}": { "get": { "tags": [ "File" ], "summary": "Download file", "operationId": "DownloadFile", "produces": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "File path e.g. '/folder/file.ext'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true }, { "type": "string", "name": "versionId", "in": "query", "description": "File version ID to download", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "The raw data of the file.", "schema": { "type": "file" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "File for given path not found." } }, "security": [ { "JWT": [] } ], "x-binary-result": true }, "put": { "tags": [ "File" ], "summary": "Upload file", "operationId": "UploadFile", "consumes": [ "multipart/form-data" ], "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext\n If the content is multipart and path does not contains the file name it tries to get them from filename parameter\n from Content-Disposition header.\n ", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true }, { "type": "file", "name": "File", "in": "formData", "required": true, "description": "File to upload" } ], "responses": { "200": { "x-nullable": true, "description": "Empty error list if the upload is successful.", "schema": { "$ref": "#/definitions/FilesUploadResult" } }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "File" ], "summary": "Delete file", "operationId": "DeleteFile", "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "File path e.g. '/folder/file.ext'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true }, { "type": "string", "name": "versionId", "in": "query", "description": "File version ID to delete", "x-nullable": true } ], "responses": { "200": { "description": "Returns 200 if the delete is successful." }, "401": { "description": "Authorization token is invalid or expired" } }, "security": [ { "JWT": [] } ] } }, "/pdf/storage/file/copy/{srcPath}": { "put": { "tags": [ "File" ], "summary": "Copy file", "operationId": "CopyFile", "parameters": [ { "type": "string", "name": "srcPath", "in": "path", "required": true, "description": "Source file path e.g. '/folder/file.ext'", "x-nullable": false }, { "type": "string", "name": "destPath", "in": "query", "required": true, "description": "Destination file path", "x-nullable": true }, { "type": "string", "name": "srcStorageName", "in": "query", "description": "Source storage name", "x-nullable": true }, { "type": "string", "name": "destStorageName", "in": "query", "description": "Destination storage name", "x-nullable": true }, { "type": "string", "name": "versionId", "in": "query", "description": "File version ID to copy", "x-nullable": true } ], "responses": { "200": { "description": "Returns 200 if the copy is successful." }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] } }, "/pdf/storage/file/move/{srcPath}": { "put": { "tags": [ "File" ], "summary": "Move file", "operationId": "MoveFile", "parameters": [ { "type": "string", "name": "srcPath", "in": "path", "required": true, "description": "Source file path e.g. '/src.ext'", "x-nullable": false }, { "type": "string", "name": "destPath", "in": "query", "required": true, "description": "Destination file path e.g. '/dest.ext'", "x-nullable": true }, { "type": "string", "name": "srcStorageName", "in": "query", "description": "Source storage name", "x-nullable": true }, { "type": "string", "name": "destStorageName", "in": "query", "description": "Destination storage name", "x-nullable": true }, { "type": "string", "name": "versionId", "in": "query", "description": "File version ID to move", "x-nullable": true } ], "responses": { "200": { "description": "Returns 200 if the move is successful." }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "File for given path not found." } }, "security": [ { "JWT": [] } ] } }, "/pdf/storage/folder/{path}": { "get": { "tags": [ "Folder" ], "summary": "Get all files and folders within a folder", "operationId": "GetFilesList", "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "Folder path e.g. '/folder'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Returns all files and folders contained by the folder.", "schema": { "$ref": "#/definitions/FilesList" } }, "401": { "description": "Authorization token is invalid or expired." }, "404": { "description": "Can't find folder for given path." } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Folder" ], "summary": "Create the folder", "operationId": "CreateFolder", "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "Folder path to create e.g. 'folder_1/folder_2/'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true } ], "responses": { "200": { "description": "Returns 200 if the create is successful." }, "401": { "description": "Authorization token is invalid or expired." }, "400": { "description": "Storage not found or it is not associated with the application." } }, "security": [ { "JWT": [] } ] }, "delete": { "tags": [ "Folder" ], "summary": "Delete folder", "operationId": "DeleteFolder", "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "Folder path e.g. '/folder'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true }, { "type": "boolean", "name": "recursive", "in": "query", "description": "Enable to delete folders, subfolders and files", "default": false, "x-nullable": false } ], "responses": { "200": { "description": "Returns 200 if the delete is successful." }, "401": { "description": "Authorization token is invalid or expired" } }, "security": [ { "JWT": [] } ] } }, "/pdf/storage/folder/copy/{srcPath}": { "put": { "tags": [ "Folder" ], "summary": "Copy folder", "operationId": "CopyFolder", "parameters": [ { "type": "string", "name": "srcPath", "in": "path", "required": true, "description": "Source folder path e.g. '/src'", "x-nullable": false }, { "type": "string", "name": "destPath", "in": "query", "required": true, "description": "Destination folder path e.g. '/dst'", "x-nullable": true }, { "type": "string", "name": "srcStorageName", "in": "query", "description": "Source storage name", "x-nullable": true }, { "type": "string", "name": "destStorageName", "in": "query", "description": "Destination storage name", "x-nullable": true } ], "responses": { "200": { "description": "Returns 200 if the copy is successful." }, "401": { "description": "Authorization token is invalid or expired" } }, "security": [ { "JWT": [] } ] } }, "/pdf/storage/folder/move/{srcPath}": { "put": { "tags": [ "Folder" ], "summary": "Move folder", "operationId": "MoveFolder", "parameters": [ { "type": "string", "name": "srcPath", "in": "path", "required": true, "description": "Folder path to move e.g. '/folder'", "x-nullable": false }, { "type": "string", "name": "destPath", "in": "query", "required": true, "description": "Destination folder path to move to e.g '/dst'", "x-nullable": true }, { "type": "string", "name": "srcStorageName", "in": "query", "description": "Source storage name", "x-nullable": true }, { "type": "string", "name": "destStorageName", "in": "query", "description": "Destination storage name", "x-nullable": true } ], "responses": { "200": { "description": "Returns 200 if the move is successful." }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] } }, "/pdf/storage/{storageName}/exist": { "get": { "tags": [ "Storage" ], "summary": "Check if storage exists", "operationId": "StorageExists", "parameters": [ { "type": "string", "name": "storageName", "in": "path", "required": true, "description": "Storage name", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Storage exist result.", "schema": { "$ref": "#/definitions/StorageExist" } }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] } }, "/pdf/storage/exist/{path}": { "get": { "tags": [ "Storage" ], "summary": "Check if file or folder exists", "operationId": "ObjectExists", "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "File or folder path e.g. '/file.ext' or '/folder'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true }, { "type": "string", "name": "versionId", "in": "query", "description": "File version ID", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Object exist result.", "schema": { "$ref": "#/definitions/ObjectExist" } }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] } }, "/pdf/storage/disc": { "get": { "tags": [ "Storage" ], "summary": "Get disc usage", "operationId": "GetDiscUsage", "parameters": [ { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Disc usage.", "schema": { "$ref": "#/definitions/DiscUsage" } }, "400": { "description": "Storage not found or it is not associated with an application." }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] } }, "/pdf/storage/version/{path}": { "get": { "tags": [ "Storage" ], "summary": "Get file versions", "operationId": "GetFileVersions", "parameters": [ { "type": "string", "name": "path", "in": "path", "required": true, "description": "File path e.g. '/file.ext'", "x-nullable": false }, { "type": "string", "name": "storageName", "in": "query", "description": "Storage name", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "File versions.", "schema": { "$ref": "#/definitions/FileVersions" } }, "401": { "description": "Authorization token is invalid or expired." } }, "security": [ { "JWT": [] } ] } } }, "definitions": { "AnnotationsInfoResponse": { "type": "object", "description": "Represents multiple annotations info reponse", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents multiple annotations info reponse", "additionalProperties": false, "properties": { "Annotations": { "description": "Annotations info", "allOf": [ {} ], "$ref": "#/definitions/AnnotationsInfo" } } } ] }, "AnnotationsInfo": { "type": "object", "description": "Object representing a list of annotation info objects.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of annotation info objects.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of annotation info objects.", "items": { "$ref": "#/definitions/AnnotationInfo" } } } } ] }, "AnnotationInfo": { "type": "object", "description": "Provides annotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Annotation" }, { "type": "object", "description": "Provides annotation.", "additionalProperties": false, "required": [ "AnnotationType" ], "properties": { "AnnotationType": { "description": "Gets annotation type.", "allOf": [ {} ], "$ref": "#/definitions/AnnotationType" } } } ] }, "AnnotationType": { "type": "string", "description": "", "x-enumNames": [ "Text", "Circle", "Polygon", "PolyLine", "Line", "Square", "FreeText", "Highlight", "Underline", "Squiggly", "StrikeOut", "Caret", "Ink", "Link", "Popup", "FileAttachment", "Sound", "Movie", "Screen", "Widget", "Watermark", "TrapNet", "PrinterMark", "Redaction", "Stamp", "RichMedia", "Unknown", "PDF3D" ], "enum": [ "Text", "Circle", "Polygon", "PolyLine", "Line", "Square", "FreeText", "Highlight", "Underline", "Squiggly", "StrikeOut", "Caret", "Ink", "Link", "Popup", "FileAttachment", "Sound", "Movie", "Screen", "Widget", "Watermark", "TrapNet", "PrinterMark", "Redaction", "Stamp", "RichMedia", "Unknown", "PDF3D" ], "x-enumDescriptions": { "Text": "Text annotation type.", "Circle": "Circle annotation type.", "Polygon": "Polygon annotation type.", "PolyLine": "Plyline annotation type.", "Line": "Line annotation type.", "Square": "Square annotatotion type.", "FreeText": "Free text annotation type.", "Highlight": "Highlight annotation type.", "Underline": "Underline annotation type.", "Squiggly": "Squiggle annotation type.", "StrikeOut": "Strikeout annotation type.", "Caret": "Caret annotation type.", "Ink": "Ink annotation type.", "Link": "Link annotation type.", "Popup": "Popup annotation type.", "FileAttachment": "File attachment annotation type.", "Sound": "Sound annotation type.", "Movie": "Movie annotation type.", "Screen": "Screen annotation type.", "Widget": "Widget annotation type.", "Watermark": "Watermark annotation type.", "TrapNet": "Trap network annotation type.", "PrinterMark": "Printer mark annotation type.", "Redaction": "Redaction annotation type.", "Stamp": "Rubber stamp annotation type.", "RichMedia": "Rich media annotation type", "Unknown": "Unknown annotation.", "PDF3D": "" } }, "Annotation": { "type": "object", "discriminator": "Type", "description": "Provides annotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Provides annotation.", "x-abstract": true, "additionalProperties": false, "required": [ "Rect" ], "properties": { "Color": { "description": "Color of the annotation.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "Contents": { "type": "string", "description": "Get the annotation content." }, "Modified": { "type": "string", "description": "The date and time when the annotation was last modified." }, "Id": { "type": "string", "description": "Gets ID of the annotation." }, "Flags": { "type": "array", "description": "Gets Flags of the annotation.", "items": { "$ref": "#/definitions/AnnotationFlags" } }, "Name": { "type": "string", "description": "Gets Name of the annotation." }, "Rect": { "description": "Gets Rect of the annotation.", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" }, "PageIndex": { "type": "integer", "description": "Gets PageIndex of the annotation.", "format": "int32" }, "ZIndex": { "type": "integer", "description": "Gets ZIndex of the annotation.", "format": "int32" }, "HorizontalAlignment": { "description": "Gets HorizontalAlignment of the annotation.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "VerticalAlignment": { "description": "Gets VerticalAlignment of the annotation.", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" } } } ] }, "Color": { "type": "object", "description": "Represents color DTO.", "additionalProperties": false, "required": [ "A", "R", "G", "B" ], "properties": { "A": { "type": "integer", "description": "Alpha component.", "format": "byte" }, "R": { "type": "integer", "description": "Red component.", "format": "byte" }, "G": { "type": "integer", "description": "Green component.", "format": "byte" }, "B": { "type": "integer", "description": "Blue component.", "format": "byte" } } }, "AnnotationFlags": { "type": "string", "description": "A set of flags specifying various characteristics of the annotation.", "x-enumNames": [ "Default", "Invisible", "Hidden", "Print", "NoZoom", "NoRotate", "NoView", "ReadOnly", "Locked", "ToggleNoView", "LockedContents" ], "enum": [ "Default", "Invisible", "Hidden", "Print", "NoZoom", "NoRotate", "NoView", "ReadOnly", "Locked", "ToggleNoView", "LockedContents" ], "x-enumDescriptions": { "Default": "Default value.", "Invisible": "If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an unknown annotation using an appearance stream specified by its appearance dictionary, if any.", "Hidden": "If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available. In cases where screen space is limited, the ability to hide and show annotations selectively can be used in combination with appearance streams to display auxiliary pop-up information similar in function to online help systems.", "Print": "If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.", "NoZoom": "If set, do not scale the annotation’s appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) remains fixed, regardless of the page magnification.", "NoRotate": "If set, do not rotate the annotation’s appearance to match the rotation of the page. The upper-left corner of the annotation rectangle remains in a fixed location on the page, regardless of the page rotation.", "NoView": "If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction.", "ReadOnly": "If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions. This flag is ignored for widget annotations; its function is subsumed by the ReadOnly flag of the associated form field.", "Locked": "If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation’s contents, such as the value of a form field.", "ToggleNoView": "If set, invert the interpretation of the NoView flag for certain events. A typical use is to have an annotation that appears only when a mouse cursor is held over it.", "LockedContents": "If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size." } }, "Rectangle": { "type": "object", "description": "Represents rectangle DTO.", "additionalProperties": false, "required": [ "LLX", "LLY", "URX", "URY" ], "properties": { "LLX": { "type": "number", "description": "X-coordinate of lower - left corner.", "format": "double" }, "LLY": { "type": "number", "description": "Y - coordinate of lower-left corner.", "format": "double" }, "URX": { "type": "number", "description": "X - coordinate of upper-right corner.", "format": "double" }, "URY": { "type": "number", "description": "Y - coordinate of upper-right corner.", "format": "double" } } }, "HorizontalAlignment": { "type": "string", "description": "Describes horizontal alignment.", "x-enumNames": [ "None", "Left", "Center", "Right" ], "enum": [ "None", "Left", "Center", "Right" ], "x-enumDescriptions": { "None": "No alignment.", "Left": "Align to left.", "Center": "Center alignment.", "Right": "Align to right." } }, "VerticalAlignment": { "type": "string", "description": "Enumeration of possible vertical alignment values.", "x-enumNames": [ "None", "Top", "Center", "Bottom" ], "enum": [ "None", "Top", "Center", "Bottom" ], "x-enumDescriptions": { "None": "No alignment (use specified position).", "Top": "Align to top.", "Center": "Center alignment.", "Bottom": "Align to bottom." } }, "LinkElement": { "type": "object", "discriminator": "Type", "description": "Represents base DTO object.", "additionalProperties": false, "properties": { "Links": { "type": "array", "description": "Link to the document.", "items": { "$ref": "#/definitions/Link" } } } }, "Link": { "type": "object", "discriminator": "Type", "description": "Provides information for the object link.\nThis is supposed to be an atom:link, therefore it should have all attributes specified here http://tools.ietf.org/html/rfc4287#section-4.2.7", "additionalProperties": false, "properties": { "Href": { "type": "string", "description": "The \"href\" attribute contains the link's IRI. atom:link elements MUST\nhave an href attribute, whose value MUST be a IRI reference" }, "Rel": { "type": "string", "description": "atom:link elements MAY have a \"rel\" attribute that indicates the link\nrelation type. If the \"rel\" attribute is not present, the link\nelement MUST be interpreted as if the link relation type is \"alternate\"." }, "Type": { "type": "string", "description": "On the link element, the \"type\" attribute's value is an advisory\nmedia type: it is a hint about the type of the representation that is\nexpected to be returned when the value of the href attribute is\ndereferenced. Note that the type attribute does not override the\nactual media type returned with the representation." }, "Title": { "type": "string", "description": "The \"title\" attribute conveys human-readable information about the\nlink. The content of the \"title\" attribute is Language-Sensitive." } } }, "AsposeResponse": { "type": "object", "discriminator": "Type", "description": "Base class for all responses.", "additionalProperties": false, "required": [ "Code" ], "properties": { "Code": { "type": "integer", "description": "Response status code.", "format": "int32" }, "Status": { "type": "string", "description": "Response status." } } }, "FreeTextAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple free text annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple free text annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Free text annotations object", "allOf": [ {} ], "$ref": "#/definitions/FreeTextAnnotations" } } } ] }, "FreeTextAnnotations": { "type": "object", "description": "Object representing a list of free text annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of free text annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of free text annotations.", "items": { "$ref": "#/definitions/FreeTextAnnotation" } } } } ] }, "FreeTextAnnotation": { "type": "object", "description": "Provides FreeTextAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides FreeTextAnnotation.", "additionalProperties": false, "required": [ "TextStyle" ], "properties": { "Justification": { "description": "Gets Justification of the annotation.", "allOf": [ {} ], "$ref": "#/definitions/Justification" }, "Intent": { "description": "Gets or sets the intent of the free text annotation.", "allOf": [ {} ], "$ref": "#/definitions/FreeTextIntent" }, "Rotate": { "description": "Angle of annotation rotation.", "allOf": [ {} ], "$ref": "#/definitions/Rotation" }, "TextStyle": { "description": "Text style of the annotation.", "allOf": [ {} ], "$ref": "#/definitions/TextStyle" } } } ] }, "Justification": { "type": "string", "description": "Enumerates the forms of quadding (justification) to be used in displaying the annotation’s text.", "x-enumNames": [ "Left", "Center", "Right" ], "enum": [ "Left", "Center", "Right" ], "x-enumDescriptions": { "Left": "Left justification.", "Center": "Center justification.", "Right": "Right justification." } }, "FreeTextIntent": { "type": "string", "description": "Enumerates the intents of the free text annotation.", "x-enumNames": [ "Undefined", "FreeTextCallout", "FreeTextTypeWriter" ], "enum": [ "Undefined", "FreeTextCallout", "FreeTextTypeWriter" ], "x-enumDescriptions": { "Undefined": "Not defined state.", "FreeTextCallout": "Means that the annotation is intended to function as a callout.", "FreeTextTypeWriter": "Means that the annotation is intended to function as a click-to-type or typewriter object." } }, "Rotation": { "type": "string", "description": "Enumeration of possible rotation values.", "x-enumNames": [ "None", "on90", "on180", "on270" ], "enum": [ "None", "on90", "on180", "on270" ], "x-enumDescriptions": { "None": "Non-rotated.", "on90": "Rotated on 90 degrees clockwise.", "on180": "Rotated on 180 degrees.", "on270": "Rotated on 270 degrees clockwise." } }, "TextStyle": { "type": "object", "description": "Represents a text style of a text", "additionalProperties": false, "required": [ "FontSize" ], "properties": { "FontSize": { "type": "number", "description": "Gets or sets font size of the text.", "format": "double" }, "Font": { "type": "string", "description": "Gets or sets font of the text." }, "ForegroundColor": { "description": "Gets or sets foreground color of the text.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "BackgroundColor": { "description": "Sets background color of the text.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "FontFile": { "type": "string", "description": "Sets path of font file in storage." } } }, "MarkupAnnotation": { "type": "object", "discriminator": "Type", "description": "Provides MarkupAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Annotation" }, { "type": "object", "description": "Provides MarkupAnnotation.", "x-abstract": true, "additionalProperties": false, "properties": { "CreationDate": { "type": "string", "description": "The date and time when the annotation was created." }, "Subject": { "type": "string", "description": "Get the annotation subject." }, "Title": { "type": "string", "description": "Get the annotation title." }, "RichText": { "type": "string", "description": "Get the annotation RichText." } } } ] }, "FreeTextAnnotationResponse": { "type": "object", "description": "Represents response containing single free text annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single free text annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Free text annotation object", "allOf": [ {} ], "$ref": "#/definitions/FreeTextAnnotation" } } } ] }, "TextAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple text annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple text annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Text annotations object", "allOf": [ {} ], "$ref": "#/definitions/TextAnnotations" } } } ] }, "TextAnnotations": { "type": "object", "description": "Object representing a list of text annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of text annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of text annotations.", "items": { "$ref": "#/definitions/TextAnnotation" } } } } ] }, "TextAnnotation": { "type": "object", "description": "Provides TextAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides TextAnnotation.", "additionalProperties": false, "properties": { "State": { "description": "Gets or sets the state to which the original annotation should be set.", "allOf": [ {} ], "$ref": "#/definitions/AnnotationState" }, "Open": { "type": "boolean", "description": "Gets or sets is the annotation open." }, "Icon": { "description": "Gets or sets an icon to be used in displaying the annotation.", "allOf": [ {} ], "$ref": "#/definitions/TextIcon" } } } ] }, "AnnotationState": { "type": "string", "description": "The enumeration of states to which the original annotation can be set.", "x-enumNames": [ "Undefined", "Marked", "Unmarked", "Accepted", "Rejected", "Cancelled", "Completed", "None" ], "enum": [ "Undefined", "Marked", "Unmarked", "Accepted", "Rejected", "Cancelled", "Completed", "None" ], "x-enumDescriptions": { "Undefined": "Not defined state.", "Marked": "The annotation has been marked by the user.", "Unmarked": "The annotation has not been marked by the user.", "Accepted": "The user agrees with the change.", "Rejected": "The user disagrees with the change.", "Cancelled": "The change has been cancelled.", "Completed": "The change has been completed.", "None": "The user has indicated nothing about the change." } }, "TextIcon": { "type": "string", "description": "Enumerates the icons to be used in displaying the annotation.", "x-enumNames": [ "Note", "Comment", "Key", "Help", "NewParagraph", "Paragraph", "Insert", "Check", "Cross", "Circle", "Star" ], "enum": [ "Note", "Comment", "Key", "Help", "NewParagraph", "Paragraph", "Insert", "Check", "Cross", "Circle", "Star" ], "x-enumDescriptions": { "Note": "Note icon.", "Comment": "Comment icon.", "Key": "Key icon.", "Help": "Help icon.", "NewParagraph": "NewParagraph icon.", "Paragraph": "Paragraph icon.", "Insert": "Insert icon.", "Check": "Check icon.", "Cross": "Cross icon.", "Circle": "Circle icon.", "Star": "Star icon." } }, "TextAnnotationResponse": { "type": "object", "description": "Represents response containing single text annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single text annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Text annotation object", "allOf": [ {} ], "$ref": "#/definitions/TextAnnotation" } } } ] }, "LineAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple line annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple line annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Line annotations object", "allOf": [ {} ], "$ref": "#/definitions/LineAnnotations" } } } ] }, "LineAnnotations": { "type": "object", "description": "Object representing a list of line annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of line annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of line annotations.", "items": { "$ref": "#/definitions/LineAnnotation" } } } } ] }, "LineAnnotation": { "type": "object", "description": "Provides LineAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides LineAnnotation.", "additionalProperties": false, "required": [ "Starting", "Ending" ], "properties": { "Starting": { "description": "Gets or sets starting point of line.", "allOf": [ {} ], "$ref": "#/definitions/Point" }, "StartingStyle": { "description": "Gets or sets line ending style for line starting point.", "allOf": [ {} ], "$ref": "#/definitions/LineEnding" }, "Ending": { "description": "Gets or sets ending point of line.", "allOf": [ {} ], "$ref": "#/definitions/Point" }, "EndingStyle": { "description": "Gets or sets ending style for end point of line.", "allOf": [ {} ], "$ref": "#/definitions/LineEnding" }, "InteriorColor": { "description": "Gets or sets interior color of the annotation.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "LeaderLine": { "type": "number", "description": "Gets or sets leader line length.", "format": "double" }, "LeaderLineExtension": { "type": "number", "description": "Gets or sets length of leader line extension.", "format": "double" }, "LeaderLineOffset": { "type": "number", "description": "Gets or sets leader line offset.", "format": "double" }, "ShowCaption": { "type": "boolean", "description": "Gets or sets boolean flag which determinies is contents must be shown as caption." }, "CaptionOffset": { "description": "Gets or sets caption text offset from its normal position.", "allOf": [ {} ], "$ref": "#/definitions/Point" }, "CaptionPosition": { "description": "Gets or sets annotation caption position.", "allOf": [ {} ], "$ref": "#/definitions/CaptionPosition" }, "Intent": { "description": "Gets or sets the intent of the line annotation.", "allOf": [ {} ], "$ref": "#/definitions/LineIntent" } } } ] }, "Point": { "type": "object", "description": "Represent point with fractional coordinates.", "additionalProperties": false, "required": [ "X", "Y" ], "properties": { "X": { "type": "number", "description": "X coordinate value.", "format": "double" }, "Y": { "type": "number", "description": "Y coordinate value.", "format": "double" } } }, "LineEnding": { "type": "string", "description": "Enumerates the line ending styles to be used in drawing the line.", "x-enumNames": [ "None", "Square", "Circle", "Diamond", "OpenArrow", "ClosedArrow", "Butt", "ROpenArrow", "RClosedArrow", "Slash" ], "enum": [ "None", "Square", "Circle", "Diamond", "OpenArrow", "ClosedArrow", "Butt", "ROpenArrow", "RClosedArrow", "Slash" ], "x-enumDescriptions": { "None": "No line ending.", "Square": "A square filled with the annotation’s interior color, if any.", "Circle": "A circle filled with the annotation’s interior color, if any.", "Diamond": "A diamond shape filled with the annotation’s interior color, if any.", "OpenArrow": "Two short lines meeting in an acute angle to form an open arrowhead.", "ClosedArrow": "Two short lines meeting in an acute angle as in the OpenArrow style and connected by a third line to form a triangular closed arrowhead filled with the annotation’s interior color, if any.", "Butt": "A short line at the endpoint perpendicular to the line itself.", "ROpenArrow": "Two short lines in the reverse direction from OpenArrow.", "RClosedArrow": "A triangular closed arrowhead in the reverse direction from ClosedArrow.", "Slash": "A short line at the endpoint approximately 30 degrees clockwise from perpendicular to the line itself." } }, "CaptionPosition": { "type": "string", "description": "Enumeration of the annotation’s caption positioning.", "x-enumNames": [ "Inline", "Top" ], "enum": [ "Inline", "Top" ], "x-enumDescriptions": { "Inline": "The caption will be centered inside the line (default value).", "Top": "The caption will be on top of the line." } }, "LineIntent": { "type": "string", "description": "Enumerates the intents of the line annotation.", "x-enumNames": [ "Undefined", "LineArrow", "LineDimension" ], "enum": [ "Undefined", "LineArrow", "LineDimension" ], "x-enumDescriptions": { "Undefined": "Undefined state.", "LineArrow": "Means that the annotation is intended to function as an arrow.", "LineDimension": "Means that the annotation is intended to function as a dimension line." } }, "LineAnnotationResponse": { "type": "object", "description": "Represents response containing single line annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single line annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Line annotation object", "allOf": [ {} ], "$ref": "#/definitions/LineAnnotation" } } } ] }, "SquareAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple square annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple square annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Square annotations object", "allOf": [ {} ], "$ref": "#/definitions/SquareAnnotations" } } } ] }, "SquareAnnotations": { "type": "object", "description": "Object representing a list of square annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of square annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of square annotations.", "items": { "$ref": "#/definitions/SquareAnnotation" } } } } ] }, "SquareAnnotation": { "type": "object", "description": "Provides SquareAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CommonFigureAnnotation" }, { "type": "object", "description": "Provides SquareAnnotation.", "additionalProperties": false } ] }, "CommonFigureAnnotation": { "type": "object", "discriminator": "Type", "description": "Provides CommonFigureAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides CommonFigureAnnotation.", "additionalProperties": false, "properties": { "InteriorColor": { "description": "Get the annotation InteriorColor.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "Frame": { "description": "Get or set the annotation Rectangle of frame.", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" } } } ] }, "SquareAnnotationResponse": { "type": "object", "description": "Represents response containing single square annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single square annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Square annotation object", "allOf": [ {} ], "$ref": "#/definitions/SquareAnnotation" } } } ] }, "CircleAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple circle annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple circle annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Circle annotations object", "allOf": [ {} ], "$ref": "#/definitions/CircleAnnotations" } } } ] }, "CircleAnnotations": { "type": "object", "description": "Object representing a list of circle annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of circle annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of circle annotations.", "items": { "$ref": "#/definitions/CircleAnnotation" } } } } ] }, "CircleAnnotation": { "type": "object", "description": "Provides CircleAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/CommonFigureAnnotation" }, { "type": "object", "description": "Provides CircleAnnotation.", "additionalProperties": false } ] }, "CircleAnnotationResponse": { "type": "object", "description": "Represents response containing single circle annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single circle annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Circle annotation object", "allOf": [ {} ], "$ref": "#/definitions/CircleAnnotation" } } } ] }, "PolygonAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple polygon annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple polygon annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Polygon annotations object", "allOf": [ {} ], "$ref": "#/definitions/PolygonAnnotations" } } } ] }, "PolygonAnnotations": { "type": "object", "description": "Object representing a list of polygon annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of polygon annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of polygon annotations.", "items": { "$ref": "#/definitions/PolygonAnnotation" } } } } ] }, "PolygonAnnotation": { "type": "object", "description": "Provides PolygonAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/PolyAnnotation" }, { "type": "object", "description": "Provides PolygonAnnotation.", "additionalProperties": false } ] }, "PolyAnnotation": { "type": "object", "discriminator": "Type", "description": "Provides PolyAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides PolyAnnotation.", "additionalProperties": false, "required": [ "Vertices" ], "properties": { "InteriorColor": { "description": "Gets or sets the interior color with which to fill the annotation’s line endings.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "StartingStyle": { "description": "Gets or sets the style of first line ending.", "allOf": [ {} ], "$ref": "#/definitions/LineEnding" }, "EndingStyle": { "description": "Gets or sets the style of second line ending.", "allOf": [ {} ], "$ref": "#/definitions/LineEnding" }, "Intent": { "description": "Gets or sets the intent of the polygon or polyline annotation.", "allOf": [ {} ], "$ref": "#/definitions/PolyIntent" }, "Vertices": { "type": "array", "description": "Gets or sets an array of points representing the horizontal and vertical coordinates of each vertex.", "items": { "$ref": "#/definitions/Point" } } } } ] }, "PolyIntent": { "type": "string", "description": "Enumerates the intents of the polygon or polyline annotation.", "x-enumNames": [ "Undefined", "PolygonCloud", "PolyLineDimension", "PolygonDimension" ], "enum": [ "Undefined", "PolygonCloud", "PolyLineDimension", "PolygonDimension" ], "x-enumDescriptions": { "Undefined": "Undefined state.", "PolygonCloud": "Means that the annotation is intended to function as a cloud object.", "PolyLineDimension": "Indicates that the polyline annotation is intended to function as a dimension.", "PolygonDimension": "Indicates that the polygon annotation is intended to function as a dimension." } }, "PolygonAnnotationResponse": { "type": "object", "description": "Represents response containing single polygon annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single polygon annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Polygon annotation object", "allOf": [ {} ], "$ref": "#/definitions/PolygonAnnotation" } } } ] }, "PolyLineAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple polyline annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple polyline annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Polyline annotations object", "allOf": [ {} ], "$ref": "#/definitions/PolyLineAnnotations" } } } ] }, "PolyLineAnnotations": { "type": "object", "description": "Object representing a list of polyline annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of polyline annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of polyline annotations.", "items": { "$ref": "#/definitions/PolyLineAnnotation" } } } } ] }, "PolyLineAnnotation": { "type": "object", "description": "Provides PolyLineAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/PolyAnnotation" }, { "type": "object", "description": "Provides PolyLineAnnotation.", "additionalProperties": false } ] }, "PolyLineAnnotationResponse": { "type": "object", "description": "Represents response containing single polyline annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single polyline annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Polyline annotation object", "allOf": [ {} ], "$ref": "#/definitions/PolyLineAnnotation" } } } ] }, "HighlightAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple highlight annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple highlight annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Highlight annotations object", "allOf": [ {} ], "$ref": "#/definitions/HighlightAnnotations" } } } ] }, "HighlightAnnotations": { "type": "object", "description": "Object representing a list of highlight annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of highlight annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of highlight annotations.", "items": { "$ref": "#/definitions/HighlightAnnotation" } } } } ] }, "HighlightAnnotation": { "type": "object", "description": "Provides HighlightAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides HighlightAnnotation.", "additionalProperties": false, "properties": { "QuadPoints": { "type": "array", "description": "Gets or sets an array of points specifying the coordinates of n quadrilaterals.\n Each quadrilateral encompasses a word or group of contiguous words in the text\n underlying the annotation.\n ", "items": { "$ref": "#/definitions/Point" } } } } ] }, "HighlightAnnotationResponse": { "type": "object", "description": "Represents response containing single highlight annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single highlight annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Highlight annotation object", "allOf": [ {} ], "$ref": "#/definitions/HighlightAnnotation" } } } ] }, "UnderlineAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple underline annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple underline annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Underline annotations object", "allOf": [ {} ], "$ref": "#/definitions/UnderlineAnnotations" } } } ] }, "UnderlineAnnotations": { "type": "object", "description": "Object representing a list of underline annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of underline annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of underline annotations.", "items": { "$ref": "#/definitions/UnderlineAnnotation" } } } } ] }, "UnderlineAnnotation": { "type": "object", "description": "Provides UnderlineAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides UnderlineAnnotation.", "additionalProperties": false, "properties": { "QuadPoints": { "type": "array", "description": "Gets or sets an array of points specifying the coordinates of n quadrilaterals. Each quadrilateral encompasses a word or group of contiguous words in the text underlying the annotation.", "items": { "$ref": "#/definitions/Point" } } } } ] }, "UnderlineAnnotationResponse": { "type": "object", "description": "Represents response containing single underline annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single underline annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Underline annotation object", "allOf": [ {} ], "$ref": "#/definitions/UnderlineAnnotation" } } } ] }, "SquigglyAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple squiggly-underline annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple squiggly-underline annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Squiggly-underline annotations object", "allOf": [ {} ], "$ref": "#/definitions/SquigglyAnnotations" } } } ] }, "SquigglyAnnotations": { "type": "object", "description": "Object representing a list of squiggly-underline annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of squiggly-underline annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of squiggly-underline annotations.", "items": { "$ref": "#/definitions/SquigglyAnnotation" } } } } ] }, "SquigglyAnnotation": { "type": "object", "description": "Provides SquigglyAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides SquigglyAnnotation.", "additionalProperties": false, "properties": { "QuadPoints": { "type": "array", "description": "Gets or sets an array of points specifying the coordinates of n quadrilaterals. Each quadrilateral encompasses a word or group of contiguous words in the text underlying the annotation.", "items": { "$ref": "#/definitions/Point" } } } } ] }, "SquigglyAnnotationResponse": { "type": "object", "description": "Represents response containing single squiggly-underline annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single squiggly-underline annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Squiggly-underline annotation object", "allOf": [ {} ], "$ref": "#/definitions/SquigglyAnnotation" } } } ] }, "StrikeOutAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple strikeout annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple strikeout annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Strikeout annotations object", "allOf": [ {} ], "$ref": "#/definitions/StrikeOutAnnotations" } } } ] }, "StrikeOutAnnotations": { "type": "object", "description": "Object representing a list of strikeout annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of strikeout annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of strikeout annotations.", "items": { "$ref": "#/definitions/StrikeOutAnnotation" } } } } ] }, "StrikeOutAnnotation": { "type": "object", "description": "Provides StrikeOutAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides StrikeOutAnnotation.", "additionalProperties": false, "properties": { "QuadPoints": { "type": "array", "description": "Gets or sets an array of points specifying the coordinates of n quadrilaterals. Each quadrilateral encompasses a word or group of contiguous words in the text underlying the annotation.", "items": { "$ref": "#/definitions/Point" } } } } ] }, "StrikeOutAnnotationResponse": { "type": "object", "description": "Represents response containing single strikeout annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single strikeout annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Strikeout annotation object", "allOf": [ {} ], "$ref": "#/definitions/StrikeOutAnnotation" } } } ] }, "CaretAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple caret annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple caret annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Caret annotations object", "allOf": [ {} ], "$ref": "#/definitions/CaretAnnotations" } } } ] }, "CaretAnnotations": { "type": "object", "description": "Object representing a list of caret annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of caret annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of caret annotations.", "items": { "$ref": "#/definitions/CaretAnnotation" } } } } ] }, "CaretAnnotation": { "type": "object", "description": "Provides CaretAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides CaretAnnotation.", "additionalProperties": false, "properties": { "Frame": { "description": "Gets or sets caret rectangle.", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" }, "Symbol": { "description": "Gets or sets symbol associated with caret.", "allOf": [ {} ], "$ref": "#/definitions/CaretSymbol" } } } ] }, "CaretSymbol": { "type": "string", "description": "A symbol to be associated with the caret.", "x-enumNames": [ "None", "Paragraph" ], "enum": [ "None", "Paragraph" ], "x-enumDescriptions": { "None": "No symbol should be associated with the caret.", "Paragraph": "A new paragraph symbol (¶) should be associated with the caret." } }, "CaretAnnotationResponse": { "type": "object", "description": "Represents response containing single caret annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single caret annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Caret annotation object", "allOf": [ {} ], "$ref": "#/definitions/CaretAnnotation" } } } ] }, "InkAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple ink annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple ink annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Ink annotations object", "allOf": [ {} ], "$ref": "#/definitions/InkAnnotations" } } } ] }, "InkAnnotations": { "type": "object", "description": "Object representing a list of ink annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of ink annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of ink annotations.", "items": { "$ref": "#/definitions/InkAnnotation" } } } } ] }, "InkAnnotation": { "type": "object", "description": "Provides InkAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides InkAnnotation.", "additionalProperties": false, "properties": { "InkList": { "type": "array", "description": "Gets or sets list of gestures that are independent lines which are represented by Point[] arrays.", "minItems": 1, "items": { "type": "array", "items": { "$ref": "#/definitions/Point" } } }, "CapStyle": { "description": "Style of ink annotation line endings.", "allOf": [ {} ], "$ref": "#/definitions/CapStyle" } } } ] }, "CapStyle": { "type": "string", "description": "Style of line ending of Ink annotation line. ", "x-enumNames": [ "Rectangular", "Rounded" ], "enum": [ "Rectangular", "Rounded" ], "x-enumDescriptions": { "Rectangular": "End is rectangular.", "Rounded": "End is rounded." } }, "InkAnnotationResponse": { "type": "object", "description": "Represents response containing single ink annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single ink annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Ink annotation object", "allOf": [ {} ], "$ref": "#/definitions/InkAnnotation" } } } ] }, "PopupAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple popup annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple popup annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Popup annotations object", "allOf": [ {} ], "$ref": "#/definitions/PopupAnnotations" } } } ] }, "PopupAnnotations": { "type": "object", "description": "Object representing a list of popup annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of popup annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of popup annotations.", "items": { "$ref": "#/definitions/PopupAnnotationWithParent" } } } } ] }, "PopupAnnotationWithParent": { "type": "object", "description": "Provides PopupAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/PopupAnnotation" }, { "type": "object", "description": "Provides PopupAnnotation.", "additionalProperties": false, "properties": { "Parent": { "description": "Parent of annotation.", "allOf": [ {} ], "$ref": "#/definitions/AnnotationInfo" } } } ] }, "PopupAnnotation": { "type": "object", "discriminator": "Type", "description": "Provides PopupAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Annotation" }, { "type": "object", "description": "Provides PopupAnnotation.", "additionalProperties": false, "properties": { "Open": { "type": "boolean", "description": "Gets or sets a flag specifying whether the pop-up annotation should initially be displayed open." } } } ] }, "PopupAnnotationResponse": { "type": "object", "description": "Represents response containing single popup annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single popup annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Popup annotation object", "allOf": [ {} ], "$ref": "#/definitions/PopupAnnotationWithParent" } } } ] }, "FileAttachmentAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple FileAttachment annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple FileAttachment annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Free text annotations object", "allOf": [ {} ], "$ref": "#/definitions/FileAttachmentAnnotations" } } } ] }, "FileAttachmentAnnotations": { "type": "object", "description": "Object representing a list of FileAttachment annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of FileAttachment annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of FileAttachment annotations.", "items": { "$ref": "#/definitions/FileAttachmentAnnotation" } } } } ] }, "FileAttachmentAnnotation": { "type": "object", "description": "Provides FileAttachmentAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides FileAttachmentAnnotation.", "additionalProperties": false, "properties": { "Icon": { "description": "Gets or sets icon that shall be used in displaying annotation.", "allOf": [ {} ], "$ref": "#/definitions/FileIcon" }, "Opacity": { "type": "number", "description": "Gets or sets icon's opacity from 0 to 1: 0 - completely transparant, 1 - completely opaque.", "format": "double" }, "FileDescription": { "type": "string", "description": "Gets or sets text associated with the file specification. " }, "FileName": { "type": "string", "description": "Gets or sets file specification name. " }, "FilePath": { "type": "string", "description": "Sets content file path. " } } } ] }, "FileIcon": { "type": "string", "description": "An icon to be used in displaying the annotation.", "x-enumNames": [ "PushPin", "Graph", "Paperclip", "Tag" ], "enum": [ "PushPin", "Graph", "Paperclip", "Tag" ], "x-enumDescriptions": { "PushPin": "PushPin icon (default value).", "Graph": "Graph icon.", "Paperclip": "Paperclip icon.", "Tag": "This is tag icon." } }, "FileAttachmentAnnotationResponse": { "type": "object", "description": "Represents response containing single FileAttachment annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single FileAttachment annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "FileAttachment annotation object", "allOf": [ {} ], "$ref": "#/definitions/FileAttachmentAnnotation" } } } ] }, "SoundAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple sound annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple sound annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Sound annotations object", "allOf": [ {} ], "$ref": "#/definitions/SoundAnnotations" } } } ] }, "SoundAnnotations": { "type": "object", "description": "Object representing a list of Sound annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of Sound annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of Sound annotations.", "items": { "$ref": "#/definitions/SoundAnnotation" } } } } ] }, "SoundAnnotation": { "type": "object", "description": "Provides SoundAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides SoundAnnotation.", "additionalProperties": false, "required": [ "FilePath" ], "properties": { "FilePath": { "type": "string", "description": "A sound file path defining the sound to be played when the annotation is activated.", "minLength": 1 }, "Icon": { "description": "Gets or sets an icon to be used in displaying the annotation.", "allOf": [ {} ], "$ref": "#/definitions/SoundIcon" }, "Rate": { "type": "integer", "description": "Gets or sets the sampling rate, in samples per second.", "format": "int32" }, "Channels": { "type": "integer", "description": "Gets or sets the number of sound channels.", "format": "int32" }, "Bits": { "type": "integer", "description": "Gets or sets the number of bits per sample value per channel.", "format": "int32" }, "Encoding": { "description": "Gets or sets the encoding format for the sample data.", "allOf": [ {} ], "$ref": "#/definitions/SoundEncoding" } } } ] }, "SoundIcon": { "type": "string", "description": "An icon to be used in displaying the annotation.", "x-enumNames": [ "Speaker", "Mic" ], "enum": [ "Speaker", "Mic" ], "x-enumDescriptions": { "Speaker": "Speaker icon.", "Mic": "Microphone icon." } }, "SoundEncoding": { "type": "string", "description": "The encoding format for the sample data. ", "x-enumNames": [ "Raw", "Signed", "MuLaw", "ALaw" ], "enum": [ "Raw", "Signed", "MuLaw", "ALaw" ], "x-enumDescriptions": { "Raw": "Unspecified or unsigned values in the range 0 to 2^bits − 1.", "Signed": "Twos-complement values.", "MuLaw": "μ-law–encoded samples.", "ALaw": "A-law–encoded samples." } }, "SoundAnnotationResponse": { "type": "object", "description": "Represents response containing single Sound annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single Sound annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Sound annotation object", "allOf": [ {} ], "$ref": "#/definitions/SoundAnnotation" } } } ] }, "RedactionAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple redaction annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple redaction annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Redaction annotations object", "allOf": [ {} ], "$ref": "#/definitions/RedactionAnnotations" } } } ] }, "RedactionAnnotations": { "type": "object", "description": "Object representing a list of redaction annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of redaction annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of redaction annotations.", "items": { "$ref": "#/definitions/RedactionAnnotation" } } } } ] }, "RedactionAnnotation": { "type": "object", "description": "Provides RedactionAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Annotation" }, { "type": "object", "description": "Provides RedactionAnnotation.", "additionalProperties": false, "properties": { "QuadPoint": { "type": "array", "description": "An array of 8xN numbers specifying the coordinates of content region that is intended to be removed. ", "items": { "$ref": "#/definitions/Point" } }, "FillColor": { "description": "Gets or sets color to fill annotation.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "BorderColor": { "description": "Gets or sets color of border which is drawn when redaction is not active.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "OverlayText": { "type": "string", "description": "Text to print on redact annotation." }, "Repeat": { "type": "boolean", "description": "If true overlay text will be repeated on the annotation. " }, "TextAlignment": { "description": "Gets or sets. Alignment of Overlay Text.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" } } } ] }, "RedactionAnnotationResponse": { "type": "object", "description": "Represents response containing single redaction annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single redaction annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Redaction annotation object", "allOf": [ {} ], "$ref": "#/definitions/RedactionAnnotation" } } } ] }, "MovieAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple movie annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple movie annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Movie annotations object", "allOf": [ {} ], "$ref": "#/definitions/MovieAnnotations" } } } ] }, "MovieAnnotations": { "type": "object", "description": "Object representing a list of movie annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of movie annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of movie annotations.", "items": { "$ref": "#/definitions/MovieAnnotation" } } } } ] }, "MovieAnnotation": { "type": "object", "description": "Provides MovieAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Annotation" }, { "type": "object", "description": "Provides MovieAnnotation.", "additionalProperties": false, "properties": { "Title": { "type": "string", "description": "Get the annotation title." }, "FileName": { "type": "string", "description": "Gets or sets file specification name. " }, "FilePath": { "type": "string", "description": "Sets content file path. " } } } ] }, "MovieAnnotationResponse": { "type": "object", "description": "Represents response containing single movie annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single movie annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Movie annotation object", "allOf": [ {} ], "$ref": "#/definitions/MovieAnnotation" } } } ] }, "ScreenAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple screen annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple screen annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Screen annotations object", "allOf": [ {} ], "$ref": "#/definitions/ScreenAnnotations" } } } ] }, "ScreenAnnotations": { "type": "object", "description": "Object representing a list of screen annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of screen annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of screen annotations.", "items": { "$ref": "#/definitions/ScreenAnnotation" } } } } ] }, "ScreenAnnotation": { "type": "object", "description": "Provides ScreenAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Annotation" }, { "type": "object", "description": "Provides ScreenAnnotation.", "additionalProperties": false, "properties": { "Title": { "type": "string", "description": "Get the annotation title." }, "FilePath": { "type": "string", "description": "Sets content file path. " } } } ] }, "ScreenAnnotationResponse": { "type": "object", "description": "Represents response containing single screen annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single screen annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Screen annotation object", "allOf": [ {} ], "$ref": "#/definitions/ScreenAnnotation" } } } ] }, "StampAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple stamp annotation objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple stamp annotation objects", "additionalProperties": false, "properties": { "Annotations": { "description": "Stamp annotations object", "allOf": [ {} ], "$ref": "#/definitions/StampAnnotations" } } } ] }, "StampAnnotations": { "type": "object", "description": "Object representing a list of stamp annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of stamp annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of stamp annotations.", "items": { "$ref": "#/definitions/StampAnnotation" } } } } ] }, "StampAnnotation": { "type": "object", "description": "Provides StampAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/MarkupAnnotation" }, { "type": "object", "description": "Provides StampAnnotation.", "additionalProperties": false, "properties": { "Icon": { "description": "Gets or sets icon for rubber stamp.", "allOf": [ {} ], "$ref": "#/definitions/StampIcon" }, "FilePath": { "type": "string", "description": "Sets content file path. " }, "HasImage": { "type": "boolean", "description": "Gets is image exist. " } } } ] }, "StampIcon": { "type": "string", "description": "Enumerates the icons to be used in displaying the annotation.", "x-enumNames": [ "Draft", "Approved", "Experimental", "NotApproved", "AsIs", "Expired", "NotForPublicRelease", "Confidential", "Final", "Sold", "Departmental", "ForComment", "ForPublicRelease", "TopSecret" ], "enum": [ "Draft", "Approved", "Experimental", "NotApproved", "AsIs", "Expired", "NotForPublicRelease", "Confidential", "Final", "Sold", "Departmental", "ForComment", "ForPublicRelease", "TopSecret" ], "x-enumDescriptions": { "Draft": "Draft stamp icon.", "Approved": "Approved stamp icon.", "Experimental": "Experimental stamp icon.", "NotApproved": "Stamp icon is not approved.", "AsIs": "Stamp icon \"as is\".", "Expired": "Stamp icon is expired.", "NotForPublicRelease": "Not for public release.", "Confidential": "Confidential.", "Final": "Final stamp.", "Sold": "Sold stamp.", "Departmental": "Departamental.", "ForComment": "For comment.", "ForPublicRelease": "For public release.", "TopSecret": "Top secret." } }, "StampAnnotationResponse": { "type": "object", "description": "Represents response containing single stamp annotation object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single stamp annotation object", "additionalProperties": false, "properties": { "Annotation": { "description": "Ink annotation object", "allOf": [ {} ], "$ref": "#/definitions/StampAnnotation" } } } ] }, "DocumentResponse": { "type": "object", "description": "Represents response containing document info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing document info", "additionalProperties": false, "properties": { "Document": { "description": "Document object", "allOf": [ {} ], "$ref": "#/definitions/Document" }, "Messages": { "type": "array", "description": "A list of messages obtained while producing the responce", "items": { "type": "string" } } } } ] }, "Document": { "type": "object", "description": "Represents document DTO.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents document DTO.", "additionalProperties": false, "properties": { "DocumentProperties": { "description": "Document properties.", "allOf": [ {} ], "$ref": "#/definitions/DocumentProperties" }, "DisplayProperties": { "description": "Document display properties.", "allOf": [ {} ], "$ref": "#/definitions/DisplayProperties" }, "Pages": { "description": "Document pages.", "allOf": [ {} ], "$ref": "#/definitions/Pages" } } } ] }, "DocumentProperties": { "type": "object", "description": "Represents list of PDF document properties.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents list of PDF document properties.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of PDF document properties.", "items": { "$ref": "#/definitions/DocumentProperty" } } } } ] }, "DocumentProperty": { "type": "object", "description": "Pdf document property.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Pdf document property.", "additionalProperties": false, "required": [ "BuiltIn" ], "properties": { "Name": { "type": "string", "description": "Name of the property." }, "Value": { "type": "string", "description": "Property value." }, "BuiltIn": { "type": "boolean", "description": "Value indicating whether it is a built-in property." } } } ] }, "DisplayProperties": { "type": "object", "description": "Provides link to DisplayProperties.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Provides link to DisplayProperties.", "additionalProperties": false, "properties": { "CenterWindow": { "type": "boolean", "description": "Gets or sets flag specifying whether position of the document's window will be centerd on the screen." }, "Direction": { "description": "Gets or sets reading order of text: L2R (left to right) or R2L (right to left).", "allOf": [ {} ], "$ref": "#/definitions/Direction" }, "DisplayDocTitle": { "type": "boolean", "description": "Gets or sets flag specifying whether document's window title bar should display document title." }, "HideMenuBar": { "type": "boolean", "description": "Gets or sets flag specifying whether menu bar should be hidden when document is active." }, "HideToolBar": { "type": "boolean", "description": "Gets or sets flag specifying whether toolbar should be hidden when document is active." }, "HideWindowUI": { "type": "boolean", "description": "Gets or sets flag specifying whether user interface elements should be hidden when document is active." }, "NonFullScreenPageMode": { "description": "Gets or sets page mode, specifying how to display the document on exiting full-screen mode.", "allOf": [ {} ], "$ref": "#/definitions/PageMode" }, "PageLayout": { "description": "Gets or sets page layout which shall be used when the document is opened.", "allOf": [ {} ], "$ref": "#/definitions/PageLayout" }, "PageMode": { "description": "Gets or sets page mode, specifying how document should be displayed when opened.", "allOf": [ {} ], "$ref": "#/definitions/PageMode" } } } ] }, "Direction": { "type": "string", "description": "Text direction.", "x-enumNames": [ "L2R", "R2L" ], "enum": [ "L2R", "R2L" ], "x-enumDescriptions": { "L2R": "Left to right direction.", "R2L": "Right to left direction." } }, "PageMode": { "type": "string", "description": "Class descibes used components of the document page.", "x-enumNames": [ "UseNone", "UseOutlines", "UseThumbs", "FullScreen", "UseOC", "UseAttachments" ], "enum": [ "UseNone", "UseOutlines", "UseThumbs", "FullScreen", "UseOC", "UseAttachments" ], "x-enumDescriptions": { "UseNone": "Dont use any components.", "UseOutlines": "Document outline visible.", "UseThumbs": "Thumbnail images visible.", "FullScreen": "FullScreenFull-screen mode, with no menu bar, window controls, or any other window visible.", "UseOC": "Optional content group panel visible.", "UseAttachments": "Attachments panel visible." } }, "PageLayout": { "type": "string", "description": "Descibes page layout.", "x-enumNames": [ "SinglePage", "OneColumn", "TwoColumnLeft", "TwoColumnRight", "TwoPageLeft", "TwoPageRight", "Default" ], "enum": [ "SinglePage", "OneColumn", "TwoColumnLeft", "TwoColumnRight", "TwoPageLeft", "TwoPageRight", "Default" ], "x-enumDescriptions": { "SinglePage": "Single page.", "OneColumn": "Display the pages in one column.", "TwoColumnLeft": "Display the pages in two columns, with odd-numbered pages on the left.", "TwoColumnRight": "Display the pages in two columns, with odd-numbered pages on the right.", "TwoPageLeft": "Display the pages two at a time, with odd-numbered pages on the left.", "TwoPageRight": "Display the pages two at a time, with odd-numbered pages on the right.", "Default": "Default layout." } }, "Pages": { "type": "object", "description": "Represents list of pages.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents list of pages.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of pages.", "items": { "$ref": "#/definitions/Page" } } } } ] }, "Page": { "type": "object", "description": "Provides link to page.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Provides link to page.", "additionalProperties": false, "required": [ "Id" ], "properties": { "Id": { "type": "integer", "description": "Page's id.", "format": "int32" }, "Rectangle": { "description": "Page's rectangle", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" } } } ] }, "AttachmentsResponse": { "type": "object", "description": "Represents response containing multiple attachments info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple attachments info", "additionalProperties": false, "properties": { "Attachments": { "description": "Attachments object", "allOf": [ {} ], "$ref": "#/definitions/Attachments" } } } ] }, "Attachments": { "type": "object", "description": "Represents list of attachment.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents list of attachment.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of annotations.", "items": { "$ref": "#/definitions/LinkElement" } } } } ] }, "AttachmentInfo": { "type": "object", "description": "Attachment Info.", "additionalProperties": false, "required": [ "Path" ], "properties": { "Path": { "type": "string", "description": "Attachment file path.", "minLength": 1 }, "Description": { "type": "string", "description": "Attachment file description." }, "Name": { "type": "string", "description": "Attachment file name." }, "MimeType": { "type": "string", "description": "Attachment file MIME type." } } }, "AttachmentResponse": { "type": "object", "description": "Represents response containing single attachment info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single attachment info", "additionalProperties": false, "properties": { "Attachment": { "description": "Attachment object", "allOf": [ {} ], "$ref": "#/definitions/Attachment" } } } ] }, "Attachment": { "type": "object", "description": "Provides link to attachment.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Provides link to attachment.", "additionalProperties": false, "required": [ "Size" ], "properties": { "Description": { "type": "string", "description": "Gets text associated with the attachment. " }, "MimeType": { "type": "string", "description": "Gets subtype of the attachment file." }, "Name": { "type": "string", "description": "Gets the name of the attachment. " }, "CreationDate": { "type": "string", "description": "The date and time when the embedded file was created." }, "ModificationDate": { "type": "string", "description": "The date and time when the embedded file was last modified." }, "Size": { "type": "integer", "description": "The size of the uncompressed embedded file, in bytes.", "format": "int32" }, "CheckSum": { "type": "string", "description": "A 16-byte string that is the checksum of the bytes of the uncompressed embedded file. \nThe checksum is calculated by applying the standard MD5 message-digest algorithm \nto the bytes of the embedded file stream." } } } ] }, "BookmarksResponse": { "type": "object", "description": "Represents response containing multiple bookmarks info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple bookmarks info", "additionalProperties": false, "properties": { "Bookmarks": { "description": "Bookmarks object", "allOf": [ {} ], "$ref": "#/definitions/Bookmarks" } } } ] }, "Bookmarks": { "type": "object", "description": "Represents list of bookmark.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents list of bookmark.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of bookmarks.", "items": { "$ref": "#/definitions/Bookmark" } } } } ] }, "Bookmark": { "type": "object", "description": "Provides link to bookmark.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Provides link to bookmark.", "additionalProperties": false, "properties": { "Title": { "type": "string", "description": "Get the Title;" }, "Italic": { "type": "boolean", "description": "Is bookmark italic." }, "Bold": { "type": "boolean", "description": "Is bookmark bold." }, "Color": { "description": "Get the color", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "Action": { "type": "string", "description": "Gets or sets the action bound with the bookmark.\nIf PageNumber is presented the action can not be specified.\nThe action type includes: \"GoTo\", \"GoToR\", \"Launch\", \"Named\"." }, "Level": { "type": "integer", "description": "Gets or sets bookmark's hierarchy level.", "format": "int32" }, "Destination": { "type": "string", "description": "Gets or sets bookmark's destination page. Required if action is set as string.Empty." }, "PageDisplay": { "type": "string", "description": "Gets or sets the type of display bookmark's destination page." }, "PageDisplay_Bottom": { "type": "integer", "description": "Gets or sets the bottom coordinate of page display.", "format": "int32" }, "PageDisplay_Left": { "type": "integer", "description": "Gets or sets the left coordinate of page display.", "format": "int32" }, "PageDisplay_Right": { "type": "integer", "description": "Gets or sets the right coordinate of page display.", "format": "int32" }, "PageDisplay_Top": { "type": "integer", "description": "Gets or sets the top coordinate of page display.", "format": "int32" }, "PageDisplay_Zoom": { "type": "integer", "description": "Gets or sets the zoom factor of page display.", "format": "int32" }, "PageNumber": { "type": "integer", "description": "Gets or sets the number of bookmark's destination page. ", "format": "int32" }, "RemoteFile": { "type": "string", "description": "Gets or sets the file (path) which is required for \"GoToR\" action of bookmark." }, "Bookmarks": { "description": "The children bookmarks.", "allOf": [ {} ], "$ref": "#/definitions/Bookmarks" } } } ] }, "BookmarkResponse": { "type": "object", "description": "Represents response containing single bookmark info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single bookmark info", "additionalProperties": false, "properties": { "Bookmark": { "description": "Bookmark object", "allOf": [ {} ], "$ref": "#/definitions/Bookmark" } } } ] }, "TextRectsResponse": { "type": "object", "description": "Represents response containing multiple text occurrences info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple text occurrences info", "additionalProperties": false, "properties": { "TextOccurrences": { "description": "TextRects object", "allOf": [ {} ], "$ref": "#/definitions/TextRects" } } } ] }, "TextRects": { "type": "object", "description": "Represents multiple text occurrences DTO.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "The list of text occurrences.", "items": { "$ref": "#/definitions/TextRect" } } } }, "TextRect": { "type": "object", "description": "Represents text occurrence.", "additionalProperties": false, "properties": { "Text": { "type": "string", "description": "Text of the occurrence." }, "Page": { "type": "integer", "description": "Page on which the occurrence is found.", "format": "int32" }, "Rect": { "description": "Rectangle of the occurrence.", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" }, "HorizontalAlignment": { "description": "Gets or sets a horizontal alignment of text fragment. ", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "VerticalAlignment": { "description": "Gets or sets a vertical alignment of text fragment. ", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" }, "Position": { "description": "Gets or sets text position for text, represented with TextRect object.", "allOf": [ {} ], "$ref": "#/definitions/Position" }, "BaselinePosition": { "description": "Gets text position for text, represented with TextRect object.\nThe YIndent of the Position structure represents baseline coordinate of the text fragment.", "allOf": [ {} ], "$ref": "#/definitions/Position" }, "TextState": { "description": "Gets or sets text state for the text that TextRect object represents.", "allOf": [ {} ], "$ref": "#/definitions/TextState" } } }, "Position": { "type": "object", "description": "Represents a position object", "additionalProperties": false, "required": [ "XIndent", "YIndent" ], "properties": { "XIndent": { "type": "number", "description": "Gets the X coordinate of the object", "format": "double" }, "YIndent": { "type": "number", "description": "Gets the Y coordinate of the object", "format": "double" } } }, "TextState": { "type": "object", "description": "Represents a text state of a text", "additionalProperties": false, "required": [ "FontSize", "FontStyle" ], "properties": { "FontSize": { "type": "number", "description": "Gets or sets font size of the text.", "format": "double" }, "Font": { "type": "string", "description": "Gets or sets font name of the text." }, "ForegroundColor": { "description": "Gets or sets foreground color of the text.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "BackgroundColor": { "description": "Sets background color of the text.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "FontStyle": { "description": "Sets font style of the text.", "allOf": [ {} ], "$ref": "#/definitions/FontStyles" }, "FontFile": { "type": "string", "description": "Sets path of font file in storage." }, "Underline": { "type": "boolean", "description": "Gets or sets underline of the text." }, "StrikeOut": { "type": "boolean", "description": "Gets or sets strikeout of the text." }, "Superscript": { "type": "boolean", "description": "Gets or sets superscript mode of the text." }, "Subscript": { "type": "boolean", "description": "Gets or sets subscript mode of the text." } } }, "FontStyles": { "type": "string", "description": "Specifies style information applied to text.", "x-enumFlags": true, "x-enumNames": [ "Regular", "Bold", "Italic", "BoldItalic" ], "enum": [ "Regular", "Bold", "Italic", "BoldItalic" ], "x-enumDescriptions": { "Regular": "Regular text", "Bold": "Bold text", "Italic": "Italic text", "BoldItalic": "Bold Italic text" } }, "Paragraph": { "type": "object", "description": "Represents text paragraphs as multiline text object.", "additionalProperties": false, "required": [ "Lines" ], "properties": { "LineSpacing": { "description": "Line spacing mode.", "allOf": [ {} ], "$ref": "#/definitions/LineSpacing" }, "WrapMode": { "description": "Word wrap mode.", "allOf": [ {} ], "$ref": "#/definitions/WrapMode" }, "HorizontalAlignment": { "description": "Horizontal alignment for the text inside paragraph's rectangle.", "allOf": [ {} ], "$ref": "#/definitions/TextHorizontalAlignment" }, "LeftMargin": { "type": "number", "description": "Left margin.", "format": "double" }, "RightMargin": { "type": "number", "description": "Right margin.", "format": "double" }, "TopMargin": { "type": "number", "description": "Top margin.", "format": "double" }, "BottomMargin": { "type": "number", "description": "Bottom margin.", "format": "double" }, "Rectangle": { "description": "Rectangle of the paragraph.", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" }, "Rotation": { "type": "number", "description": "Rotation angle in degrees.", "format": "double" }, "SubsequentLinesIndent": { "type": "number", "description": "Subsequent lines indent value.", "format": "double" }, "VerticalAlignment": { "description": "Vertical alignment for the text inside paragraph's rectangle", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" }, "Lines": { "type": "array", "description": "An array of text lines.", "minItems": 1, "items": { "$ref": "#/definitions/TextLine" } } } }, "LineSpacing": { "type": "string", "description": "Defines line spacing specifics", "x-enumNames": [ "FontSize", "FullSize" ], "enum": [ "FontSize", "FullSize" ], "x-enumDescriptions": { "FontSize": "Line spacing is font size", "FullSize": "Line spacing is a full space between descender and ascender" } }, "WrapMode": { "type": "string", "description": "Defines word wrapping strategies", "x-enumNames": [ "NoWrap", "ByWords", "DiscretionaryHyphenation" ], "enum": [ "NoWrap", "ByWords", "DiscretionaryHyphenation" ], "x-enumDescriptions": { "NoWrap": "No wrapping is performed", "ByWords": "Word wrapping only wraps complete words. If the complete word cannot be wrapped, attempts to use discretionary hyphenation", "DiscretionaryHyphenation": "Discretionary hyphenation is performed. Allows breaking words in the middle." } }, "TextHorizontalAlignment": { "type": "string", "description": "Describes text horizontal alignment.", "x-enumNames": [ "Left", "Right", "Center", "Justify", "FullJustify", "None" ], "enum": [ "Left", "Right", "Center", "Justify", "FullJustify", "None" ], "x-enumDescriptions": { "Left": "Align to left.", "Right": "Align to right.", "Center": "Center alignment.", "Justify": "Justify alignment. Text will be aligned on both left and right margins.", "FullJustify": "Similar to 'Justify' alignment, except that the very last line will only be left-aligned in 'Justify' mode, while in 'FullJustify' mode all lines will be left- and right-aligned.", "None": "No alignment." } }, "TextLine": { "type": "object", "description": "A line of text to be inserted into paragraph.", "additionalProperties": false, "required": [ "Segments" ], "properties": { "HorizontalAlignment": { "description": "Line's horizontal alignment", "allOf": [ {} ], "$ref": "#/definitions/TextHorizontalAlignment" }, "Segments": { "type": "array", "description": "Segments that form the line. Every segment has its own formatting.", "minItems": 1, "items": { "$ref": "#/definitions/Segment" } } } }, "Segment": { "type": "object", "description": "Represents segment of Pdf text.", "additionalProperties": false, "required": [ "Value" ], "properties": { "Value": { "type": "string", "description": "Text that the Segment object represents.", "minLength": 1 }, "TextState": { "description": "Text state for the text that Segment object represents.", "allOf": [ {} ], "$ref": "#/definitions/TextState" } } }, "ImageTemplatesRequest": { "type": "object", "description": "Create document from images request.", "additionalProperties": false, "required": [ "IsOCR", "ImagesList" ], "properties": { "IsOCR": { "type": "boolean", "description": "Using OCR function." }, "OCRLangs": { "type": "string", "description": "Language for recognition\npossible values:\neng, ara, bel, ben, bul, ces, dan, deu, ell, fin, fra, heb, hin, ind, isl, ita, jpn, kor, nld, nor, pol, por, ron, rus, spa, swe, tha, tur, ukr, vie, chi_sim, chi_tra\n\n or thier combination e.g. eng+rus" }, "ImagesList": { "type": "array", "description": "A List of objects describing images to be added.", "minItems": 1, "items": { "$ref": "#/definitions/ImageTemplate" } } } }, "ImageTemplate": { "type": "object", "description": "Template of image.", "additionalProperties": false, "required": [ "ImagePath", "ImageSrcType" ], "properties": { "ImagePath": { "type": "string", "description": "A path for image.", "minLength": 1 }, "ImageSrcType": { "description": "Image type.", "minLength": 1, "allOf": [ {} ], "$ref": "#/definitions/ImageSrcType" }, "LeftMargin": { "type": "number", "format": "double" }, "RightMargin": { "type": "number", "format": "double" }, "TopMargin": { "type": "number", "format": "double" }, "BottomMargin": { "type": "number", "format": "double" }, "PageWidth": { "type": "number", "format": "double" }, "PageHeight": { "type": "number", "format": "double" }, "MarginInfo": { "$ref": "#/definitions/MarginInfo" } } }, "ImageSrcType": { "type": "string", "description": "Allows to specify image file format.", "x-enumNames": [ "Common", "Emf" ], "enum": [ "Common", "Emf" ], "x-enumDescriptions": { "Common": "Any image format except EMF", "Emf": "EMF image format" } }, "MarginInfo": { "type": "object", "description": "This class represents a margin for different objects.", "additionalProperties": false, "properties": { "Left": { "type": "number", "description": "Gets or sets a float value that indicates the left margin.", "format": "double" }, "Right": { "type": "number", "description": "Gets or sets a float value that indicates the right margin.", "format": "double" }, "Top": { "type": "number", "description": "Gets or sets a float value that indicates the top margin.", "format": "double" }, "Bottom": { "type": "number", "description": "Gets or sets a float value that indicates the bottom margin.", "format": "double" } } }, "DocFormat": { "type": "string", "description": "Allows to specify .doc or .docx file format.", "x-enumNames": [ "Doc", "DocX" ], "enum": [ "Doc", "DocX" ], "x-enumDescriptions": { "Doc": "[MS-DOC]: Word (.doc) Binary File Format", "DocX": "Office Open XML (.docx) File Format" } }, "DocRecognitionMode": { "type": "string", "description": "Allows to control how a PDF document is converted into a word processing document.", "x-enumNames": [ "Textbox", "Flow", "EnhancedFlow" ], "enum": [ "Textbox", "Flow", "EnhancedFlow" ], "x-enumDescriptions": { "Textbox": "This mode is fast and good for maximally preserving original look of the PDF file, but editability of the resulting document could be limited.Every visually grouped block of text int the original PDF file is converted into a textbox in the resulting document. This achieves maximal resemblance of the output document to the original PDF file. The output document will look good, but it will consist entirely of textboxes and it could makes further editing of the document in Microsoft Word quite hard.This is the default mode.", "Flow": "Full recognition mode, the engine performs grouping and multi-level analysis to restore the original document author's intent and produce a maximally editable document. The downside is that the output document might look different from the original PDF file.", "EnhancedFlow": "An alternative Flow mode that supports the recognition of tables." } }, "EpubRecognitionMode": { "type": "string", "description": "When PDF file (that usually has fixed layout) is being converted,\n the conversion engine tries to perform grouping and multi-level analysis to restore\n the original document author's intent and produce result in flow layout.\n This property tunes that conversion for this or that\n desirable method of recognition of content.\n ", "x-enumNames": [ "Flow", "PdfFlow", "Fixed" ], "enum": [ "Flow", "PdfFlow", "Fixed" ], "x-enumDescriptions": { "Flow": "Full recognition mode, the engine tries to perform grouping and multi-level analysis to restore the original document author's intent and produce xhtml in flow layout.", "PdfFlow": "The main idea of this conversion is based on saving \"natural\" order of content rendering that is formed during processing of pdf documents. In the general cases pdf documents keep top-down\\left-right rendering order (see attachment directions.png). This assumption allows to create a single-path algorithm that will transform Aps elements that have positions (fixed-layout) into flow formats like HTML,EPUB,DOC. This mode will be especially useful for converting from PDF(APS) into EPUB, because the EPUB format was developed for e-readers like the Kindle or smart-phones. The size of screen those devices usually is less than the size of screen of ordinary PC. Therefore the content of EPUB documents is better to save in the flow format, for correct rendering on screens with different sizes. In this mode every column will be added to the end of previous column this allows to keep the logical structure of transformed document during \"pagination\" in EPUB readers. This achievement allows correctly render scientific or magazine articles.", "Fixed": "This mode is fast and good for maximally preserving the original look pages, but unfortunately many EPUB readeres don't support xhtml with fixed layout" } }, "HtmlDocumentType": { "type": "string", "description": "Represents enumeration of the Html document types.", "x-enumNames": [ "Xhtml", "Html5" ], "enum": [ "Xhtml", "Html5" ], "x-enumDescriptions": { "Xhtml": "The XHtml Document Type.", "Html5": "The HTML5 Document Type." } }, "AntialiasingProcessingType": { "type": "string", "description": "This enum describes possible antialiasing measures during conversion", "x-enumNames": [ "NoAdditionalProcessing", "TryCorrectResultHtml" ], "enum": [ "NoAdditionalProcessing", "TryCorrectResultHtml" ], "x-enumDescriptions": { "NoAdditionalProcessing": "no special antialiasing processing in use. This is an optimal option for overhelming majority of documents and it does not require additional time during conversion", "TryCorrectResultHtml": "" } }, "FontEncodingRules": { "type": "string", "description": "This enumeration defines rules which tune encoding logic", "x-enumNames": [ "Default", "DecreaseToUnicodePriorityLevel" ], "enum": [ "Default", "DecreaseToUnicodePriorityLevel" ], "x-enumDescriptions": { "Default": "Leave encoding logic \"as is\" - in accordance with PDF specification", "DecreaseToUnicodePriorityLevel": "ToUnicode is a special mechanism which helps to decode input codes to unicode symbols. According to specification it must be used first of all mechanisms to get unicode symbols for specific input code. But some documents has non-standard fonts and to convert these documents correctly it may be necessary to decrease ToUnicode priority and use another mechanisms to decode input codes." } }, "FontSavingModes": { "type": "string", "description": "Enumerates modes that can be used for saving of fonts\nreferenced in saved PDF \n ", "x-enumNames": [ "AlwaysSaveAsWOFF", "AlwaysSaveAsTTF", "AlwaysSaveAsEOT", "SaveInAllFormats" ], "enum": [ "AlwaysSaveAsWOFF", "AlwaysSaveAsTTF", "AlwaysSaveAsEOT", "SaveInAllFormats" ], "x-enumDescriptions": { "AlwaysSaveAsWOFF": "All referenced fonts will be saved and referenced as WOFF-fonts", "AlwaysSaveAsTTF": "All referenced fonts will be saved and referenced as TTF-fonts", "AlwaysSaveAsEOT": "All referenced fonts will be saved and referenced as EOT-fonts", "SaveInAllFormats": "All referenced fonts will be saved (and referenced in CSS) as 3 independent files : EOT, TTH,WOFF. It increases size of output data but makes output sutable for overhelming majority of web brawsers" } }, "HtmlMarkupGenerationModes": { "type": "string", "description": "Sometimes specific reqirments to created HTML are present.\nThis enum defines HTML preparing modes that can be used\nduring conversion of PDF to HTML to match such specific requirments.\n ", "x-enumNames": [ "WriteAllHtml", "WriteOnlyBodyContent" ], "enum": [ "WriteAllHtml", "WriteOnlyBodyContent" ], "x-enumDescriptions": { "WriteAllHtml": "Default mode any specific requirments are absent. Will be generated output that will contain all parts of HTML without any special additional processing.", "WriteOnlyBodyContent": "will be stripped away all HTML content that is outside HTML's body, i.e. will be left only content that is inside tags" } }, "LettersPositioningMethods": { "type": "string", "description": "It enumerates possible modes of positioning of letters in words in result HTML\n ", "x-enumNames": [ "UseEmUnitsAndCompensationOfRoundingErrorsInCss", "UsePixelUnitsInCssLetterSpacingForIE" ], "enum": [ "UseEmUnitsAndCompensationOfRoundingErrorsInCss", "UsePixelUnitsInCssLetterSpacingForIE" ], "x-enumDescriptions": { "UseEmUnitsAndCompensationOfRoundingErrorsInCss": "It's default method. It uses EM-units and special alhorithm of compensation of rounding errors It's preferable for usage in IE10.0 and more fresh versions and gives better scaling of captions when scaling is necessary", "UsePixelUnitsInCssLetterSpacingForIE": "It allows to get sometimes more precise results in old IE browser versions" } }, "PartsEmbeddingModes": { "type": "string", "description": "This enum enumerates possible modes of embedding of files referenced in HTML\nIt allows to control whether referenced files (HTML, Fonts,Images, CSSes)\nwill be embedded into main HTML file or will be generated as apart binary entities \n ", "x-enumNames": [ "EmbedAllIntoHtml", "EmbedCssOnly", "NoEmbedding" ], "enum": [ "EmbedAllIntoHtml", "EmbedCssOnly", "NoEmbedding" ], "x-enumDescriptions": { "EmbedAllIntoHtml": "Enforces embed all referenced files(Css,Images,Fonts) into generated HTML markup (i.e. into HTML itself) This approach generates one HTML file, but total size of output becames bigger(because Base64 encoding of binaries is in use) and not all browsers (especially legacy) successfully process binaries embedded into HTML. But it allows get HTML that contains whole result, without any additional files.", "EmbedCssOnly": "Enforces put apart all referenced files except CSS (Images and Fonts) I.e. CSS will be embedded into result HTML , and all other referenced files(Images and Fonts) will be processed as external parts It generates HTML that is sutable for wide set of browsers", "NoEmbedding": "Enforces put apart referenced files(Css,Images,Fonts) This approach generates set of files, but total size of output becames smaller(because no Base64 encoding of binaries is in use) Also such approach generates HTML that is sutable for wide set of browsers" } }, "RasterImagesSavingModes": { "type": "string", "description": "Converted PDF can contain raster images(.png, *.jpeg etc.)\nThis enum defines methods of how raster images can be handled\nduring conversion of PDF to HTML\n ", "x-enumNames": [ "AsPngImagesEmbeddedIntoSvg", "AsExternalPngFilesReferencedViaSvg", "AsEmbeddedPartsOfPngPageBackground" ], "enum": [ "AsPngImagesEmbeddedIntoSvg", "AsExternalPngFilesReferencedViaSvg", "AsEmbeddedPartsOfPngPageBackground" ], "x-enumDescriptions": { "AsPngImagesEmbeddedIntoSvg": "for each distinct raster file will be generated wrapper SVG image, and raster image will be embedded as Base64 encoded strings into that SVG image", "AsExternalPngFilesReferencedViaSvg": "distinct raster images will be put apart as PNG files but will be referenced through wrapping SVG images, i.e. will be generated one PNG file and one SVG for each raster image, and each of such SVGs will contain links to relevant PNG file", "AsEmbeddedPartsOfPngPageBackground": "Will be generated one big PNG background file for each result page. Raster images will be embedded into that file and rendered as regions of that image. No external PNG files for each image will be generated, only one PNG file per page will be present in conversion result set of files." } }, "OutputFormat": { "type": "string", "description": "Enumeration for output type format.", "x-enumNames": [ "Zip", "Folder" ], "enum": [ "Zip", "Folder" ], "x-enumDescriptions": { "Zip": "Zip archive.", "Folder": "Folder." } }, "PdfAType": { "type": "string", "description": "Allows to specify PdfA file format.", "x-enumNames": [ "PDFA1A", "PDFA1B", "PDFA3A", "PDFA3B" ], "enum": [ "PDFA1A", "PDFA1B", "PDFA3A", "PDFA3B" ], "x-enumDescriptions": { "PDFA1A": "Pdf/A-1a format", "PDFA1B": "Pdf/A-1b format", "PDFA3A": "Pdf/A-3a format", "PDFA3B": "Pdf/A-3b format" } }, "CompressionType": { "type": "string", "description": "Used to specify the parameter value passed to a Tiff image device.", "x-enumNames": [ "LZW", "CCITT4", "CCITT3", "RLE", "None" ], "enum": [ "LZW", "CCITT4", "CCITT3", "RLE", "None" ], "x-enumDescriptions": { "LZW": "Specifies the LZW compression scheme. Can be passed to the Tiff encoder as a parameter that belongs to the Compression category.", "CCITT4": "Specifies the CCITT4 compression scheme. Can be passed to the CCITT4 encoder as a parameter that belongs to the Compression category.", "CCITT3": "Specifies the CCITT3 compression scheme. Can be passed to the CCITT3 encoder as a parameter that belongs to the Compression category.", "RLE": "Specifies the RLE compression scheme. Can be passed to the RLE encoder as a parameter that belongs to the Compression category.", "None": "Specifies no compression. Can be passed to the Tiff encoder as a parameter that belongs to the compression category." } }, "ColorDepth": { "type": "string", "description": "Used to specify the parameter value passed to a Tiff image device.", "x-enumNames": [ "Default", "Format8bpp", "Format4bpp", "Format1bpp" ], "enum": [ "Default", "Format8bpp", "Format4bpp", "Format1bpp" ], "x-enumDescriptions": { "Default": "Default color depth. 32 bit depth is used by default.", "Format8bpp": "8 bits per pixel. Equal", "Format4bpp": "4 bits per pixel. Equal", "Format1bpp": "1 bit per pixel. Equal" } }, "ShapeType": { "type": "string", "description": "This enum represents shape type for the extracted images.", "x-enumNames": [ "None", "Landscape", "Portrait" ], "enum": [ "None", "Landscape", "Portrait" ], "x-enumDescriptions": { "None": "Original image shape.", "Landscape": "Landscape Shape.", "Portrait": "Portrait Shape." } }, "DisplayPropertiesResponse": { "type": "object", "description": "Represents response containing DisplayProperties", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing DisplayProperties", "additionalProperties": false, "properties": { "DisplayProperties": { "description": "DisplayProperties object", "allOf": [ {} ], "$ref": "#/definitions/DisplayProperties" } } } ] }, "DocumentConfig": { "type": "object", "description": "Provides link to DocumentConfig.", "additionalProperties": false, "required": [ "PagesCount" ], "properties": { "DisplayProperties": { "description": "Sets DisplayProperties of document", "allOf": [ {} ], "$ref": "#/definitions/DisplayProperties" }, "DocumentProperties": { "description": "Sets DocumentProperties of document", "allOf": [ {} ], "$ref": "#/definitions/DocumentProperties" }, "PagesCount": { "type": "integer", "description": "Sets count of pages for new document. From 1 to 100", "format": "int32" }, "DefaultPageConfig": { "description": "Sets default page config for new document", "allOf": [ {} ], "$ref": "#/definitions/DefaultPageConfig" } } }, "DefaultPageConfig": { "type": "object", "description": "Provides link to DefaultPageConfig.", "additionalProperties": false, "properties": { "Height": { "type": "number", "description": "Sets default page Height", "format": "double" }, "Width": { "type": "number", "description": "Sets default page Width", "format": "double" } } }, "Signature": { "type": "object", "description": "Represents signature.", "additionalProperties": false, "required": [ "SignaturePath", "SignatureType", "Visible", "ShowProperties" ], "properties": { "SignaturePath": { "type": "string", "description": "Gets or sets the signature path.", "minLength": 1 }, "SignatureType": { "description": "Gets or sets the type of the signature.", "allOf": [ {} ], "$ref": "#/definitions/SignatureType" }, "Password": { "type": "string", "description": "Gets or sets the signature password." }, "Appearance": { "type": "string", "description": "Sets or gets a graphic appearance for the signature. Property value represents an image file name." }, "Reason": { "type": "string", "description": "Gets or sets the reason of the signature." }, "Contact": { "type": "string", "description": "Gets or sets the contact of the signature." }, "Location": { "type": "string", "description": "Gets or sets the location of the signature." }, "Visible": { "type": "boolean", "description": "Gets or sets a value indicating whether this Signature is visible. Supports only when signing particular page." }, "Rectangle": { "description": "Gets or sets the visible rectangle of the signature. Supports only when signing particular page.", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" }, "FormFieldName": { "type": "string", "description": "Gets or sets the name of the signature field. Supports only when signing document with particular form field." }, "Authority": { "type": "string", "description": "Gets or sets the name of the person or authority signing the document.." }, "Date": { "type": "string", "description": "Gets or sets the time of signing." }, "ShowProperties": { "type": "boolean", "description": "Gets or sets the showproperties in signature field" }, "TimestampSettings": { "description": "Gets/sets timestamp settings.", "allOf": [ {} ], "$ref": "#/definitions/TimestampSettings" }, "IsValid": { "type": "boolean", "description": "Verify the document regarding this signature and return true if document is valid\nor otherwise false." }, "CustomAppearance": { "description": "Gets/sets the custom appearance.", "allOf": [ {} ], "$ref": "#/definitions/SignatureCustomAppearance" } } }, "SignatureType": { "type": "string", "description": "The type of signature.", "x-enumNames": [ "PKCS1", "PKCS7", "PKCS7Detached" ], "enum": [ "PKCS1", "PKCS7", "PKCS7Detached" ], "x-enumDescriptions": { "PKCS1": "Represents signature object regarding PKCS#1 standard. RSA encryption algorithm and SHA-1 digest method are used for signing.", "PKCS7": "Represents the PKCS#7 object that conform to the PKCS#7 specification in Internet RFC 2315, PKCS #7: Cryptographic Message Syntax, Version 1.5. The SHA1 digest of the document's byte range is encapsulated in the PKCS#7 SignedData field.", "PKCS7Detached": "Represents the PKCS#7 object that conform to the PKCS#7 specification in Internet RFC 2315, PKCS #7: Cryptographic Message Syntax, Version 1.5. The original signed message digest over the document's byte range is incorporated as the normal PKCS#7 SignedData field. No data shall is encapsulated in the PKCS#7 SignedData field." } }, "TimestampSettings": { "type": "object", "description": "Represents the ocsp settings using during signing process.", "additionalProperties": false, "properties": { "ServerUrl": { "type": "string", "description": "Gets/sets the timestamp server url." }, "BasicAuthCredentials": { "type": "string", "description": "Gets/sets the basic authentication credentials, Username and password are combined into a string \"username:password\"." } } }, "SignatureCustomAppearance": { "type": "object", "description": "An abstract class which represents signature custom appearance object.", "additionalProperties": false, "required": [ "Rotation", "ShowContactInfo", "ShowReason", "ShowLocation", "UseDigitalSubjectFormat" ], "properties": { "FontFamilyName": { "type": "string", "description": "Gets/sets font family name. It should be existed in the document. Default value: Arial." }, "FontSize": { "type": "number", "description": "Gets/sets font size. Default value: 10.", "format": "double" }, "Rotation": { "description": "Gets or sets signature rotation.", "allOf": [ {} ], "$ref": "#/definitions/Rotation" }, "ShowContactInfo": { "type": "boolean", "description": "Gets/sets contact info visibility. Default value: true." }, "ShowReason": { "type": "boolean", "description": "Gets/sets reason visibility. Default value: true." }, "ShowLocation": { "type": "boolean", "description": "Gets/sets location visibility. Default value: true." }, "ContactInfoLabel": { "type": "string", "description": "Gets/sets contact info label. Default value: \"Contact\"." }, "ReasonLabel": { "type": "string", "description": "Gets/sets reason label. Default value: \"Reason\"." }, "LocationLabel": { "type": "string", "description": "Gets/sets location label. Default value: \"Location\"." }, "DigitalSignedLabel": { "type": "string", "description": "Gets/sets digital signed label. Default value: \"Digitally signed by\"." }, "DateSignedAtLabel": { "type": "string", "description": "Gets/sets date signed label. Default value: \"Date\"." }, "DateTimeLocalFormat": { "type": "string", "description": "Gets/sets datetime local format. Default value: \"yyyy.MM.dd HH:mm:ss zzz\"." }, "DateTimeFormat": { "type": "string", "description": "Gets/sets datetime format. Default value: \"yyyy.MM.dd HH:mm:ss\"." }, "BackgroundColor": { "description": "Gets/sets background color.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "ForegroundColor": { "description": "Gets/sets foreground color.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "UseDigitalSubjectFormat": { "type": "boolean", "description": "Gets/sets subject format usage." }, "DigitalSubjectFormat": { "type": "array", "description": "Gets/sets subject format.", "items": { "$ref": "#/definitions/SignatureSubjectNameElements" } } } }, "SignatureSubjectNameElements": { "type": "string", "description": "Represents an enumeration of available SubjectNameElements.", "x-enumNames": [ "CN", "O", "L", "OU", "S", "C", "E" ], "enum": [ "CN", "O", "L", "OU", "S", "C", "E" ], "x-enumDescriptions": { "CN": "Common Name.", "O": "Organization.", "L": "Locality.", "OU": "Organizational Unit.", "S": "State or Province Name.", "C": "Common Name.", "E": "Email." } }, "SignatureVerifyResponse": { "type": "object", "description": "Represent responce containing signature verification result", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represent responce containing signature verification result", "additionalProperties": false, "required": [ "Valid" ], "properties": { "Valid": { "type": "boolean", "description": "True if signature is valid and false if not" } } } ] }, "DocumentPrivilege": { "type": "object", "description": "Represents the privileges for accessing Pdf file.", "additionalProperties": false, "properties": { "AllowPrint": { "type": "boolean", "description": "Sets the permission which allow print or not. \ntrue is allow and false or not set is forbidden." }, "AllowDegradedPrinting": { "type": "boolean", "description": "Sets the permission which allow degraded printing or not. \ntrue is allow and false or not set is forbidden." }, "AllowModifyContents": { "type": "boolean", "description": "Sets the permission which allow modify contents or not. \ntrue is allow and false or not set is forbidden." }, "AllowCopy": { "type": "boolean", "description": "Sets the permission which allow copy or not. \ntrue is allow and false or not set is forbidden." }, "AllowModifyAnnotations": { "type": "boolean", "description": "Sets the permission which allow modify annotations or not. \ntrue is allow and false or not set is forbidden." }, "AllowFillIn": { "type": "boolean", "description": "Sets the permission which allow fill in forms or not. \ntrue is allow and false or not set is forbidden." }, "AllowScreenReaders": { "type": "boolean", "description": "Sets the permission which allow screen readers or not. \ntrue is allow and false or not set is forbidden." }, "AllowAssembly": { "type": "boolean", "description": "Sets the permission which allow assembly or not. \ntrue is allow and false or not set is forbidden." }, "PrintAllowLevel": { "type": "integer", "description": "Sets the print level of document's privilege. Just as the Adobe Professional's Printing Allowed settings.\n0: None.\n1: Low Resolution (150 dpi).\n2: High Resolution.", "format": "int32" }, "ChangeAllowLevel": { "type": "integer", "description": "Sets the change level of document's privilege. Just as the Adobe Professional's Changes Allowed settings.\n0: None.\n1: Inserting, Deleting and Rotating pages.\n2: Filling in form fields and signing existing signature fields.\n3: Commenting, filling in form fields, and signing existing signature fields.\n4: Any except extracting pages.", "format": "int32" }, "CopyAllowLevel": { "type": "integer", "description": "Sets the copy level of document's privilege. Just as the Adobe Professional's permission settings.\n0: None.\n1: Enable text access for screen reader devices for the visually impaired.\n2: Enable copying of text, images and other content.", "format": "int32" } } }, "OptimizeOptions": { "type": "object", "description": "Represents Pdf optimize options.", "additionalProperties": false, "properties": { "Password": { "type": "string", "description": "Specifies document password (if any) encoded with base-64." }, "AllowReusePageContent": { "type": "boolean", "description": "If true page contents will be reused when document is optimized for equal pages. LinkDuplcateStreams option must be set to true." }, "CompressImages": { "type": "boolean", "description": "If this flag is set to true images will be compressed in the document. Compression level is specified with ImageQuality property." }, "ImageQuality": { "type": "integer", "description": "Specifies level of image compression when CompressImages flag is used.", "format": "int32" }, "LinkDuplcateStreams": { "type": "boolean", "description": "If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then thees streams will be stored as one object. \nThis allows to decrease document size in some cases (for example, when same document was concatenated multiple times)." }, "RemoveUnusedObjects": { "type": "boolean", "description": "If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document." }, "RemoveUnusedStreams": { "type": "boolean", "description": "If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed.\nThis may decrease document size for example when pages were extracted from document. " }, "UnembedFonts": { "type": "boolean", "description": "Make fonts not embedded if set to true. Unembedding a font means removing the embedded byte stream data of the font included in a PDF document." }, "ResizeImages": { "type": "boolean", "description": "If this flag set to true and CompressImages is true images will be resized if image resolution is greater then specified MaxResolution parameter." }, "MaxResolution": { "type": "integer", "description": "Specifies maximum resolution of images. If image has higher resolution it will be scaled.", "format": "int32" }, "SubsetFonts": { "type": "boolean", "description": "Fonts will be converted into subsets if set to true. Only those characters that are actually used in the layout are stored in the PDF. " }, "RemovePrivateInfo": { "type": "boolean", "description": "Remove private information (page piece info)." }, "ImageEncoding": { "description": "Image encode which will be used.", "allOf": [ {} ], "$ref": "#/definitions/ImageEncoding" }, "ImageCompressionVersion": { "description": "Version of compression algorithm. Possible values are: \"Standard\" - standard compression, \"Fast\" - fast (improved compression which is faster then standard but may be applicable not for all images), \"Mixed\" - mixed (standard compression is applied to images which can not be compressed by faster algorithm, this may give best compression but more slow then \"Fast\" algorithm. Version \"Fast\" is not applicable for resizing images (standard method will be used). Default is \"Standard\".", "allOf": [ {} ], "$ref": "#/definitions/ImageCompressionVersion" } } }, "ImageEncoding": { "type": "string", "description": "Image encoding type.", "x-enumNames": [ "Unchanged", "Jpeg", "Flate", "Jpeg2000" ], "enum": [ "Unchanged", "Jpeg", "Flate", "Jpeg2000" ], "x-enumDescriptions": { "Unchanged": "Don't change encoding.", "Jpeg": "JPEG (DCT) encoding.", "Flate": "Flate encoding.", "Jpeg2000": "JPEG2000 (JPX) encoding." } }, "ImageCompressionVersion": { "type": "string", "description": "Describes versions of image compression algorithm.", "x-enumNames": [ "Standard", "Fast", "Mixed" ], "enum": [ "Standard", "Fast", "Mixed" ], "x-enumDescriptions": { "Standard": "Standard algorithm. Default value.", "Fast": "Improved algorithm faster then standard but applicable not for all cases.", "Mixed": "Use fast algorithm when possible and standard for other cases. May be slower then \"Fast\" but may produce better compression." } }, "SplitResultResponse": { "type": "object", "description": "Represents responce containing split result.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents responce containing split result.", "additionalProperties": false, "properties": { "Result": { "description": "SplitResult object.", "allOf": [ {} ], "$ref": "#/definitions/SplitResult" } } } ] }, "SplitResult": { "type": "object", "description": "Represents split result object.", "additionalProperties": false, "properties": { "Documents": { "type": "array", "description": "Gets or sets the list of documents.", "items": { "$ref": "#/definitions/SplitResultDocument" } } } }, "SplitResultDocument": { "type": "object", "description": "Represents split result document,", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/Link" }, { "type": "object", "description": "Represents split result document,", "additionalProperties": false, "required": [ "Id" ], "properties": { "Id": { "type": "integer", "description": "Gets or sets the page number.", "format": "int32" } } } ] }, "SplitRangePdfOptions": { "type": "object", "description": "Represents Pdf split into ranges options.", "additionalProperties": false, "properties": { "PageRanges": { "type": "array", "items": { "$ref": "#/definitions/PageRange" } } } }, "PageRange": { "type": "object", "additionalProperties": false, "properties": { "From": { "type": "integer", "format": "int32" }, "To": { "type": "integer", "format": "int32" } } }, "CryptoAlgorithm": { "type": "string", "description": "Represent type of cryptographic algorithm that used in encryption/decryption\nroutines.", "x-enumNames": [ "RC4x40", "RC4x128", "AESx128", "AESx256" ], "enum": [ "RC4x40", "RC4x128", "AESx128", "AESx256" ], "x-enumDescriptions": { "RC4x40": "RC4 with key length 40.", "RC4x128": "RC4 with key length 128.", "AESx128": "AES with key length 128.", "AESx256": "AES with key length 256." } }, "PermissionsFlags": { "type": "string", "description": "This enum represents user's permissions for a pdf.", "x-enumNames": [ "PrintDocument", "ModifyContent", "ExtractContent", "ModifyTextAnnotations", "FillForm", "ExtractContentWithDisabilities", "AssembleDocument", "PrintingQuality" ], "enum": [ "PrintDocument", "ModifyContent", "ExtractContent", "ModifyTextAnnotations", "FillForm", "ExtractContentWithDisabilities", "AssembleDocument", "PrintingQuality" ], "x-enumDescriptions": { "PrintDocument": "(Security handlers of revision 2) Print the document. (Security handlers of revision 3 or greater) Print the document (possibly not at the highest quality level, depending on whether Aspose.Pdf.Permissions.PrintingQuality is also set).", "ModifyContent": "Modify the contents of the document by operations other than those controlled by Aspose.Pdf.Permissions.ModifyTextAnnotations, Aspose.Pdf.Permissions.FillForm, and 11.", "ExtractContent": "(Security handlers of revision 2) Copy or otherwise extract text and graphics from the document, including extracting text and graphics (in support of accessibility to users with disabilities or for other purposes). (Security handlers of revision 3 or greater) Copy or otherwise extract text and graphics from the document by operations other than that controlled by Aspose.Pdf.Permissions.ExtractContentWithDisabilities.", "ModifyTextAnnotations": "Add or modify text annotations, fill in interactive form fields, and, if Aspose.Pdf.Permissions.ModifyContent is also set, create or modify interactive form fields (including signature fields).", "FillForm": "(Security handlers of revision 3 or greater) Fill in existing interactive form fields (including signature fields), even if Aspose.Pdf.Permissions.ModifyTextAnnotations is clear.", "ExtractContentWithDisabilities": "(Security handlers of revision 3 or greater) Extract text and graphics (in support of accessibility to users with disabilities or for other purposes).", "AssembleDocument": "(Security handlers of revision 3 or greater) Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if Aspose.Pdf.Permissions.ModifyContent is clear.", "PrintingQuality": "(Security handlers of revision 3 or greater) Print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this bit is clear (and bit 3 is set), printing is limited to a low-level representation of the appearance, possibly of degraded quality." } }, "CheckBoxFieldsResponse": { "type": "object", "description": "Represents response containing multiple checkbox field objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple checkbox field objects", "additionalProperties": false, "properties": { "Fields": { "description": "Checkbox fields object", "allOf": [ {} ], "$ref": "#/definitions/CheckBoxFields" } } } ] }, "CheckBoxFields": { "type": "object", "description": "Object representing a list of checkbox fields.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of checkbox fields.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of checkbox fields.", "items": { "$ref": "#/definitions/CheckBoxField" } } } } ] }, "CheckBoxField": { "type": "object", "description": "Provides CheckBoxField.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/FormField" }, { "type": "object", "description": "Provides CheckBoxField.", "additionalProperties": false, "required": [ "Checked" ], "properties": { "AllowedStates": { "type": "array", "description": "Returns list of allowed states.", "items": { "type": "string" } }, "Style": { "description": "Gets or sets style of check box.", "allOf": [ {} ], "$ref": "#/definitions/BoxStyle" }, "ActiveState": { "type": "string", "description": "Gets or sets current annotation appearance state." }, "Checked": { "type": "boolean", "description": "Gets or sets state of check box." }, "ExportValue": { "type": "string", "description": "Gets or sets export value of CheckBox field." } } } ] }, "BoxStyle": { "type": "string", "description": "Represents an enumeration of available BoxStyle types.", "x-enumNames": [ "Circle", "Check", "Cross", "Diamond", "Square", "Star" ], "enum": [ "Circle", "Check", "Cross", "Diamond", "Square", "Star" ], "x-enumDescriptions": { "Circle": "Circle style.", "Check": "Check style.", "Cross": "Cross style.", "Diamond": "Diamond style.", "Square": "Square style.", "Star": "Star style." } }, "FormField": { "type": "object", "discriminator": "Type", "description": "Provides form field.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Provides form field.", "additionalProperties": false, "required": [ "PageIndex" ], "properties": { "PartialName": { "type": "string", "description": "Field name." }, "FullName": { "type": "string", "description": "Full Field name." }, "Rect": { "description": "Field rectangle.", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" }, "Value": { "type": "string", "description": "Field value." }, "PageIndex": { "type": "integer", "description": "Page index.", "format": "int32" }, "Height": { "type": "number", "description": "Gets or sets height of the field.", "format": "double" }, "Width": { "type": "number", "description": "Gets or sets width of the field.", "format": "double" }, "ZIndex": { "type": "integer", "description": "Z index.", "format": "int32" }, "IsGroup": { "type": "boolean", "description": "Is group." }, "Parent": { "description": "Gets field parent.", "allOf": [ {} ], "$ref": "#/definitions/FormField" }, "IsSharedField": { "type": "boolean", "description": "Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page." }, "Flags": { "type": "array", "description": "Gets Flags of the field.", "items": { "$ref": "#/definitions/AnnotationFlags" } }, "Color": { "description": "Color of the annotation.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "Contents": { "type": "string", "description": "Get the field content." }, "Margin": { "description": "Gets or sets a outer margin for paragraph (for pdf generation)", "allOf": [ {} ], "$ref": "#/definitions/MarginInfo" }, "Highlighting": { "description": "Field highlighting mode.", "allOf": [ {} ], "$ref": "#/definitions/LinkHighlightingMode" }, "HorizontalAlignment": { "description": "Gets HorizontalAlignment of the field.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "VerticalAlignment": { "description": "Gets VerticalAlignment of the field.", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" }, "Border": { "description": "Gets or sets annotation border characteristics.", "allOf": [ {} ], "$ref": "#/definitions/Border" } } } ] }, "LinkHighlightingMode": { "type": "string", "description": "Enumerates the annotation’s highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area.", "x-enumNames": [ "None", "Invert", "Outline", "Push", "Toggle" ], "enum": [ "None", "Invert", "Outline", "Push", "Toggle" ], "x-enumDescriptions": { "None": "No highlighting.", "Invert": "Invert the contents of the annotation rectangle.", "Outline": "Invert the annotation’s border.", "Push": "Display the annotation’s down appearance, if any. If no down appearance is defined, offset the contents of the annotation rectangle to appear as if it were being pushed below the surface of the page.", "Toggle": "Same as Push (which is preferred)." } }, "Border": { "type": "object", "description": "Class representing characteristics of annotation border.", "additionalProperties": false, "properties": { "Width": { "type": "integer", "description": "Gets or sets border width.", "format": "int32" }, "EffectIntensity": { "type": "integer", "description": "Gets or sets effect intencity. Valid range of value is [0..2].", "format": "int32" }, "Style": { "description": "Gets or sets border style.", "allOf": [ {} ], "$ref": "#/definitions/BorderStyle" }, "Effect": { "description": "Gets or sets border effect.", "allOf": [ {} ], "$ref": "#/definitions/BorderEffect" }, "Dash": { "description": "Gets or sets dash pattern.", "allOf": [ {} ], "$ref": "#/definitions/Dash" }, "Color": { "description": "Gets or sets border color.", "allOf": [ {} ], "$ref": "#/definitions/Color" } } }, "BorderStyle": { "type": "string", "description": "Describes style of the annotation border.", "x-enumNames": [ "Solid", "Dashed", "Beveled", "Inset", "Underline" ], "enum": [ "Solid", "Dashed", "Beveled", "Inset", "Underline" ], "x-enumDescriptions": { "Solid": "Solid border.", "Dashed": "Dashed border.", "Beveled": "Bevelled border.", "Inset": "Inset border.", "Underline": "Underlined border." } }, "BorderEffect": { "type": "string", "description": "Describes effect which should be applied to the border of the annotations.", "x-enumNames": [ "None", "Cloudy" ], "enum": [ "None", "Cloudy" ], "x-enumDescriptions": { "None": "No effect.", "Cloudy": "The border will appear \"cloudly\"." } }, "Dash": { "type": "object", "description": "Class representing line dash pattern.", "additionalProperties": false, "required": [ "On", "Off" ], "properties": { "On": { "type": "integer", "description": "Gets or sets length of dash.", "format": "int32" }, "Off": { "type": "integer", "description": "Gets or sets length of gap between dashes.", "format": "int32" } } }, "CheckBoxFieldResponse": { "type": "object", "description": "Represents response containing single checkbox field object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single checkbox field object", "additionalProperties": false, "properties": { "Field": { "description": "Checkbox field object", "allOf": [ {} ], "$ref": "#/definitions/CheckBoxField" } } } ] }, "ComboBoxFieldsResponse": { "type": "object", "description": "Represents response containing multiple combobox field objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple combobox field objects", "additionalProperties": false, "properties": { "Fields": { "description": "Combobox fields object", "allOf": [ {} ], "$ref": "#/definitions/ComboBoxFields" } } } ] }, "ComboBoxFields": { "type": "object", "description": "Object representing a list of combobox fields.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of combobox fields.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of combobox fields.", "items": { "$ref": "#/definitions/ComboBoxField" } } } } ] }, "ComboBoxField": { "type": "object", "description": "Provides ComboBoxField.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/ChoiceField" }, { "type": "object", "description": "Provides ComboBoxField.", "additionalProperties": false, "properties": { "Options": { "type": "array", "description": "Gets collection of options of the combobox.", "items": { "$ref": "#/definitions/Option" } }, "ActiveState": { "type": "string", "description": "Gets or sets current annotation appearance state." }, "Editable": { "type": "boolean", "description": "Gets or sets editable status of the field." }, "SpellCheck": { "type": "boolean", "description": "Gets or sets spellchaeck activiity status." } } } ] }, "Option": { "type": "object", "description": "Provides form option.", "additionalProperties": false, "properties": { "Value": { "type": "string", "description": "Gets or sets option export value." }, "Name": { "type": "string", "description": "Gets or sets name of option." }, "Selected": { "type": "boolean", "description": "Gets or sets selected status of option. Returns true if option is selected." }, "Index": { "type": "integer", "description": "Gets index of the option. ", "format": "int32" } } }, "ChoiceField": { "type": "object", "discriminator": "Type", "description": "Provides Choice field.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/FormField" }, { "type": "object", "description": "Provides Choice field.", "additionalProperties": false, "properties": { "MultiSelect": { "type": "boolean", "description": "Gets or sets multiselection flag." }, "Selected": { "type": "integer", "description": "Gets or sets index of selected item. Numbering of items is started from 1.", "format": "int32" } } } ] }, "ComboBoxFieldResponse": { "type": "object", "description": "Represents response containing single combobox field object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single combobox field object", "additionalProperties": false, "properties": { "Field": { "description": "Combobox field object", "allOf": [ {} ], "$ref": "#/definitions/ComboBoxField" } } } ] }, "ListBoxFieldsResponse": { "type": "object", "description": "Represents response containing multiple listbox field objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple listbox field objects", "additionalProperties": false, "properties": { "Fields": { "description": "Listbox fields object", "allOf": [ {} ], "$ref": "#/definitions/ListBoxFields" } } } ] }, "ListBoxFields": { "type": "object", "description": "Object representing a list of listbox fields.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of listbox fields.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of listbox fields.", "items": { "$ref": "#/definitions/ListBoxField" } } } } ] }, "ListBoxField": { "type": "object", "description": "Provides ListBoxField.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/ChoiceField" }, { "type": "object", "description": "Provides ListBoxField.", "additionalProperties": false, "properties": { "Options": { "type": "array", "description": "Gets collection of options of the listbox.", "items": { "$ref": "#/definitions/Option" } }, "ActiveState": { "type": "string", "description": "Gets or sets current annotation appearance state." }, "TopIndex": { "type": "integer", "description": "Gets or sets index of the top visible element of the list.", "format": "int32" }, "SelectedItems": { "type": "array", "description": "Gets or sets array of the selected items in the multiselect list. For single-select list returns array with single item.", "items": { "type": "integer", "format": "int32" } } } } ] }, "ListBoxFieldResponse": { "type": "object", "description": "Represents response containing single listbox field object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single listbox field object", "additionalProperties": false, "properties": { "Field": { "description": "Listbox field object", "allOf": [ {} ], "$ref": "#/definitions/ListBoxField" } } } ] }, "RadioButtonFieldsResponse": { "type": "object", "description": "Represents response containing multiple RadioButton field objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple RadioButton field objects", "additionalProperties": false, "properties": { "Fields": { "description": "Text box fields object", "allOf": [ {} ], "$ref": "#/definitions/RadioButtonFields" } } } ] }, "RadioButtonFields": { "type": "object", "description": "Object representing a list of radiobox fields.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of radiobox fields.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of radiobox fields.", "items": { "$ref": "#/definitions/RadioButtonField" } } } } ] }, "RadioButtonField": { "type": "object", "description": "Provides RadioButtonField.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/ChoiceField" }, { "type": "object", "description": "Provides RadioButtonField.", "additionalProperties": false, "properties": { "Options": { "type": "array", "description": "Gets collection of options of the radio button.", "items": { "$ref": "#/definitions/Option" } }, "RadioButtonOptionsField": { "type": "array", "description": "Gets collection of radio button options field.", "items": { "$ref": "#/definitions/RadioButtonOptionField" } }, "Style": { "description": "Style of field box.", "allOf": [ {} ], "$ref": "#/definitions/BoxStyle" } } } ] }, "RadioButtonOptionField": { "type": "object", "description": "Provides RadioButtonField.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/FormField" }, { "type": "object", "description": "Provides RadioButtonField.", "additionalProperties": false, "properties": { "OptionName": { "type": "string", "description": "Gets or sets name of the option." }, "Style": { "description": "Style of field box.", "allOf": [ {} ], "$ref": "#/definitions/BoxStyle" } } } ] }, "RadioButtonFieldResponse": { "type": "object", "description": "Represents response containing single RadioButton field object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single RadioButton field object", "additionalProperties": false, "properties": { "Field": { "description": "RadioButton field object", "allOf": [ {} ], "$ref": "#/definitions/RadioButtonField" } } } ] }, "SignatureFieldsResponse": { "type": "object", "description": "Represents response containing multiple signature field objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple signature field objects", "additionalProperties": false, "properties": { "Fields": { "description": "Signature fields object", "allOf": [ {} ], "$ref": "#/definitions/SignatureFields" } } } ] }, "SignatureFields": { "type": "object", "description": "Object representing a list of signature fields.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of signature fields.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of signature fields.", "items": { "$ref": "#/definitions/SignatureField" } } } } ] }, "SignatureField": { "type": "object", "description": "Provides SignatureField.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/FormField" }, { "type": "object", "description": "Provides SignatureField.", "additionalProperties": false, "properties": { "Signature": { "description": "Gets signature object.\nThis object contains signature data regarding public-key cryptographic standards.\nClasses PKCS1, PKCS7 and PKCS7Detached\nrepresent all supported types of signature objects.", "allOf": [ {} ], "$ref": "#/definitions/Signature" } } } ] }, "SignatureFieldResponse": { "type": "object", "description": "Represents response containing single signature field object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single signature field object", "additionalProperties": false, "properties": { "Field": { "description": "Signature field object", "allOf": [ {} ], "$ref": "#/definitions/SignatureField" } } } ] }, "TextBoxFieldsResponse": { "type": "object", "description": "Represents response containing multiple text box field objects", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple text box field objects", "additionalProperties": false, "properties": { "Fields": { "description": "Text box fields object", "allOf": [ {} ], "$ref": "#/definitions/TextBoxFields" } } } ] }, "TextBoxFields": { "type": "object", "description": "Object representing a list of text box fields.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of text box fields.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of text box fields.", "items": { "$ref": "#/definitions/TextBoxField" } } } } ] }, "TextBoxField": { "type": "object", "description": "Provides TextBoxField.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/FormField" }, { "type": "object", "description": "Provides TextBoxField.", "additionalProperties": false, "properties": { "Multiline": { "type": "boolean", "description": "Gets or sets multiline flag of the field. If Multiline is true field can contain multiple lines of text." }, "SpellCheck": { "type": "boolean", "description": "Gets or sets spellcheck flag for field. If true field shall be spell checked." }, "Scrollable": { "type": "boolean", "description": "Gets or sets scrollable flag of field. If true field can be scrolled." }, "ForceCombs": { "type": "boolean", "description": "Gets or sets flag which indicates is field divided into spaced positions." }, "MaxLen": { "type": "integer", "description": "Gets or sets maximum length of text in the field.", "format": "int32" }, "Barcode": { "type": "string", "description": "Adds barcode 128 into the field.\nField value will be changed onto the code and field become read only." } } } ] }, "TextBoxFieldResponse": { "type": "object", "description": "Represents response containing single text box field object", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single text box field object", "additionalProperties": false, "properties": { "Field": { "description": "Text box field object", "allOf": [ {} ], "$ref": "#/definitions/TextBoxField" } } } ] }, "FieldResponse": { "type": "object", "description": "Represents response containing single field info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single field info", "additionalProperties": false, "properties": { "Field": { "description": "Field object", "allOf": [ {} ], "$ref": "#/definitions/Field" } } } ] }, "Field": { "type": "object", "description": "Represents form field.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents form field.", "additionalProperties": false, "required": [ "Values" ], "properties": { "Name": { "type": "string", "description": "Field name." }, "MappingName": { "type": "string", "description": "Mapping name." }, "SelectedItems": { "type": "array", "description": "Selected items.", "items": { "type": "integer", "format": "int32" } }, "Type": { "description": "Field type.", "allOf": [ {} ], "$ref": "#/definitions/FieldType" }, "Rect": { "description": "Field rectangle.", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" }, "Values": { "type": "array", "description": "Field values.", "items": { "type": "string" } } } } ] }, "FieldType": { "type": "string", "description": "Represents an enumeration of available field types.", "x-enumNames": [ "Text", "Integer", "Boolean", "List" ], "enum": [ "Text", "Integer", "Boolean", "List" ], "x-enumDescriptions": { "Text": "Textbox field", "Integer": "Numeric textbox field", "Boolean": "Checkbox field", "List": "Listbox field" } }, "FieldsResponse": { "type": "object", "description": "Represents response containing multiple fields info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple fields info", "additionalProperties": false, "properties": { "Fields": { "description": "Fields object", "allOf": [ {} ], "$ref": "#/definitions/Fields" } } } ] }, "Fields": { "type": "object", "description": "Represents list of form fields.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents list of form fields.", "additionalProperties": false, "required": [ "List" ], "properties": { "List": { "type": "array", "description": "List of form fields.", "minItems": 1, "items": { "$ref": "#/definitions/Field" } } } } ] }, "FilesUploadResult": { "type": "object", "description": "File upload result", "additionalProperties": false, "properties": { "Uploaded": { "type": "array", "description": "List of uploaded file names", "items": { "type": "string" } }, "Errors": { "type": "array", "description": "List of errors.", "items": { "$ref": "#/definitions/Error" } } } }, "Error": { "type": "object", "description": "Error", "additionalProperties": false, "properties": { "Code": { "type": "string", "description": "Code\n " }, "Message": { "type": "string", "description": "Message\n " }, "Description": { "type": "string", "description": "Description\n " }, "InnerError": { "description": "Inner Error\n ", "allOf": [ {} ], "$ref": "#/definitions/ErrorDetails" } } }, "ErrorDetails": { "type": "object", "description": "The error details", "additionalProperties": false, "required": [ "Date" ], "properties": { "RequestId": { "type": "string", "description": "The request id" }, "Date": { "type": "string", "description": "Date", "format": "date-time" } } }, "FilesList": { "type": "object", "description": "Files list", "additionalProperties": false, "properties": { "Value": { "type": "array", "description": "Files and folders contained by folder StorageFile.", "items": { "$ref": "#/definitions/StorageFile" } } } }, "StorageFile": { "type": "object", "discriminator": "Type", "description": "File or folder information", "additionalProperties": false, "required": [ "IsFolder", "Size" ], "properties": { "Name": { "type": "string", "description": "File or folder name." }, "IsFolder": { "type": "boolean", "description": "True if it is a folder." }, "ModifiedDate": { "type": "string", "description": "File or folder last modified DateTime.", "format": "date-time" }, "Size": { "type": "integer", "description": "File or folder size.", "format": "int64" }, "Path": { "type": "string", "description": "File or folder path." } } }, "TextHeader": { "type": "object", "description": "Represents Pdf text header.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/StampBase" }, { "type": "object", "description": "Represents Pdf text header.", "additionalProperties": false, "properties": { "TextAlignment": { "description": "Alignment of the text inside the stamp.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "Value": { "type": "string", "description": "Gets or sets string value which is used as stamp on the page." }, "TextState": { "description": "Gets text properties of the stamp. See TextState for details.", "allOf": [ {} ], "$ref": "#/definitions/TextState" }, "LeftMargin": { "type": "number", "description": "Gets or sets left margin of stamp.", "format": "double" }, "TopMargin": { "type": "number", "description": "Gets or sets top margin of stamp.", "format": "double" }, "RightMargin": { "type": "number", "description": "Gets or sets right margin of stamp.", "format": "double" } } } ] }, "StampBase": { "type": "object", "discriminator": "Type", "description": "Represents Pdf stamps.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents Pdf stamps.", "x-abstract": true, "additionalProperties": false, "properties": { "Background": { "type": "boolean", "description": "Sets or gets a bool value that indicates the content is stamped as background.\nIf the value is true, the stamp content is layed at the bottom.\nBy defalt, the value is false, the stamp content is layed at the top." }, "HorizontalAlignment": { "description": "Gets or sets Horizontal alignment of stamp on the page. ", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "Opacity": { "type": "number", "description": "Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0.\nBy default the value is 1.0.", "format": "double" }, "Rotate": { "description": "Sets or gets the rotation of stamp content according Rotation values.\nNote. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees).\nTo set arbitrary angle use RotateAngle property. \nIf angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.", "allOf": [ {} ], "$ref": "#/definitions/Rotation" }, "RotateAngle": { "type": "number", "description": "Gets or sets rotate angle of stamp in degrees.\nThis property allows to set arbitrary rotate angle. ", "format": "double" }, "XIndent": { "type": "number", "description": "Horizontal stamp coordinate, starting from the left.", "format": "double" }, "YIndent": { "type": "number", "description": "Vertical stamp coordinate, starting from the bottom.", "format": "double" }, "Zoom": { "type": "number", "description": "Zooming factor of the stamp. Allows to scale stamp.", "format": "double" } } } ] }, "TextFooter": { "type": "object", "description": "Represents Pdf text header.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/StampBase" }, { "type": "object", "description": "Represents Pdf text header.", "additionalProperties": false, "properties": { "TextAlignment": { "description": "Alignment of the text inside the stamp.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "Value": { "type": "string", "description": "Gets or sets string value which is used as stamp on the page." }, "TextState": { "description": "Gets text properties of the stamp. See TextState for details.", "allOf": [ {} ], "$ref": "#/definitions/TextState" }, "BottomMargin": { "type": "number", "description": "Gets or sets bottom margin of stamp.", "format": "double" }, "LeftMargin": { "type": "number", "description": "Gets or sets left margin of stamp.", "format": "double" }, "RightMargin": { "type": "number", "description": "Gets or sets right margin of stamp.", "format": "double" } } } ] }, "ImageHeader": { "type": "object", "description": "Represents Pdf image header.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/StampBase" }, { "type": "object", "description": "Represents Pdf image header.", "additionalProperties": false, "properties": { "FileName": { "type": "string", "description": "Gets or sets the file name." }, "Width": { "type": "number", "description": "Gets or sets image width. Setting this property allos to scal image horizontally.", "format": "double" }, "Height": { "type": "number", "description": "Gets or sets image height. Setting this image allows to scale image vertically.", "format": "double" }, "LeftMargin": { "type": "number", "description": "Gets or sets left margin of stamp.", "format": "double" }, "TopMargin": { "type": "number", "description": "Gets or sets top margin of stamp.", "format": "double" }, "RightMargin": { "type": "number", "description": "Gets or sets right margin of stamp.", "format": "double" } } } ] }, "ImageFooter": { "type": "object", "description": "Represents Pdf image footer.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/StampBase" }, { "type": "object", "description": "Represents Pdf image footer.", "additionalProperties": false, "properties": { "FileName": { "type": "string", "description": "Gets or sets the file name." }, "Width": { "type": "number", "description": "Gets or sets image width. Setting this property allos to scal image horizontally.", "format": "double" }, "Height": { "type": "number", "description": "Gets or sets image height. Setting this image allows to scale image vertically.", "format": "double" }, "BottomMargin": { "type": "number", "description": "Gets or sets bottom margin of stamp.", "format": "double" }, "LeftMargin": { "type": "number", "description": "Gets or sets left margin of stamp.", "format": "double" }, "RightMargin": { "type": "number", "description": "Gets or sets right margin of stamp.", "format": "double" } } } ] }, "ImagesResponse": { "type": "object", "description": "Represents response containing multiple images info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple images info", "additionalProperties": false, "properties": { "Images": { "description": "Images object", "allOf": [ {} ], "$ref": "#/definitions/Images" } } } ] }, "Images": { "type": "object", "description": "Represents list of images.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents list of images.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of images.", "items": { "$ref": "#/definitions/Image" } } } } ] }, "Image": { "type": "object", "description": "Represents image DTO.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents image DTO.", "additionalProperties": false, "required": [ "Width", "Height", "PageNumber" ], "properties": { "Width": { "type": "integer", "description": "Gets width of the image.", "format": "int32" }, "Height": { "type": "integer", "description": "Gets height of the image.", "format": "int32" }, "Id": { "type": "string", "description": "Gets ID of the image." }, "Rectangle": { "description": "Gets rectangle of the image.", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" }, "PageNumber": { "type": "integer", "description": "Gets page number.", "format": "int32" } } } ] }, "ImageResponse": { "type": "object", "description": "Represents response containing single image info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single image info", "additionalProperties": false, "properties": { "Image": { "description": "Image object", "allOf": [ {} ], "$ref": "#/definitions/Image" } } } ] }, "SvgImages": { "type": "object", "description": "SvgImages class", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "SvgImages class", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of SVG images", "items": { "type": "string" } } } } ] }, "DocumentLayers": { "type": "object", "description": "DocumentLayers response class.", "additionalProperties": false, "properties": { "Layers": { "type": "array", "description": "List of document Layers.", "items": { "$ref": "#/definitions/LayerInfo" } } } }, "LayerInfo": { "type": "object", "additionalProperties": false, "required": [ "PageNumber", "Locked" ], "properties": { "PageNumber": { "type": "integer", "description": "Layer Page Number.", "format": "int32" }, "Id": { "type": "string", "description": "Layer Id." }, "Name": { "type": "string", "description": "Layer Name." }, "Locked": { "type": "boolean", "description": "Gets a value indicating whether the layer is locked." } } }, "LinkAnnotationsResponse": { "type": "object", "description": "Represents response containing multiple links info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple links info", "additionalProperties": false, "properties": { "Links": { "description": "LinkAnnotations object", "allOf": [ {} ], "$ref": "#/definitions/LinkAnnotations" } } } ] }, "LinkAnnotations": { "type": "object", "description": "Object representing a list of link annotations.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of link annotations.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of link annotations.", "items": { "$ref": "#/definitions/LinkAnnotation" } } } } ] }, "LinkAnnotation": { "type": "object", "description": "Provides link to linkAnnotation.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Provides link to linkAnnotation.", "additionalProperties": false, "required": [ "ActionType", "Action", "Highlighting", "Rect" ], "properties": { "ActionType": { "minLength": 1, "allOf": [ {} ], "$ref": "#/definitions/LinkActionType" }, "Action": { "type": "string", "minLength": 1 }, "Highlighting": { "$ref": "#/definitions/LinkHighlightingMode" }, "Color": { "$ref": "#/definitions/Color" }, "Rect": { "$ref": "#/definitions/Rectangle" }, "Id": { "type": "string" } } } ] }, "LinkActionType": { "type": "string", "description": "Represents list of link action types.", "x-enumNames": [ "GoToAction", "GoToURIAction", "JavascriptAction", "LaunchAction", "NamedAction", "SubmitFormAction" ], "enum": [ "GoToAction", "GoToURIAction", "JavascriptAction", "LaunchAction", "NamedAction", "SubmitFormAction" ], "x-enumDescriptions": { "GoToAction": "Represents a go-to action that changes the view to a specified destination (page, location, and magnification factor).", "GoToURIAction": "Represents a URI action causes a URI to be resolved.", "JavascriptAction": "Represents javascript action.", "LaunchAction": "Represents a launch action that launches an application or opens or prints a document.", "NamedAction": "Represents named actions that PDF viewer applications are expected to support.", "SubmitFormAction": "Represents submit-form action." } }, "LinkAnnotationResponse": { "type": "object", "description": "Represents response containing single link info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single link info", "additionalProperties": false, "properties": { "Link": { "description": "LinkAnnotation object", "allOf": [ {} ], "$ref": "#/definitions/LinkAnnotation" } } } ] }, "MergeDocuments": { "type": "object", "description": "Documents for merging.", "additionalProperties": false, "required": [ "List" ], "properties": { "List": { "type": "array", "description": "List of documents for merging.", "minItems": 2, "items": { "type": "string" } } } }, "OrganizeDocumentRequest": { "type": "object", "description": "Documents data for organizing.", "additionalProperties": false, "required": [ "List" ], "properties": { "List": { "type": "array", "description": "List of document data for organizing.", "minItems": 1, "items": { "$ref": "#/definitions/OrganizeDocumentData" } } } }, "OrganizeDocumentData": { "type": "object", "description": "Data for document organizing.", "additionalProperties": false, "required": [ "Path", "Pages" ], "properties": { "Path": { "type": "string", "description": "Full filename of the document for organizing.", "minLength": 1 }, "Pages": { "type": "string", "description": "1-based page numbers of the document that make up the resulting document.", "minLength": 1 } } }, "DocumentPagesResponse": { "type": "object", "description": "Represents response containing multiple pages info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple pages info", "additionalProperties": false, "properties": { "Pages": { "description": "Page object", "allOf": [ {} ], "$ref": "#/definitions/Pages" } } } ] }, "DocumentPageResponse": { "type": "object", "description": "Represents response containing single page info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single page info", "additionalProperties": false, "properties": { "Page": { "description": "Page object", "allOf": [ {} ], "$ref": "#/definitions/Page" } } } ] }, "DocMDPAccessPermissionType": { "type": "string", "description": "The access permissions granted for this document.\nValid values are:\n1 - No changes to the document are permitted; any change to the document invalidates the signature.\n2 - Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature.\n3 - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature.", "x-enumNames": [ "NoChanges", "FillingInForms", "AnnotationModification" ], "enum": [ "NoChanges", "FillingInForms", "AnnotationModification" ], "x-enumDescriptions": { "NoChanges": "No changes to the document are permitted; any change to the document invalidates the signature.", "FillingInForms": "Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature.", "AnnotationModification": "Permitted changes are the same as for FillingInForms, as well as annotation creation, deletion, and modification; other changes invalidate the signature." } }, "WordCountResponse": { "type": "object", "description": "Number of words per document pages.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Number of words per document pages.", "additionalProperties": false, "properties": { "WordsPerPage": { "description": "WordCount with words per page info.", "allOf": [ {} ], "$ref": "#/definitions/WordCount" } } } ] }, "WordCount": { "type": "object", "description": "Number of words per document pages.", "additionalProperties": false, "properties": { "List": { "type": "array", "items": { "$ref": "#/definitions/PageWordCount" } } } }, "PageWordCount": { "type": "object", "description": "Page words count.", "additionalProperties": false, "required": [ "PageNumber", "Count" ], "properties": { "PageNumber": { "type": "integer", "description": "Page number.", "format": "int32" }, "Count": { "type": "integer", "description": "Number of words at the page.", "format": "int32" } } }, "Stamp": { "type": "object", "description": "Represents Pdf stamps.", "additionalProperties": false, "required": [ "Type" ], "properties": { "Type": { "description": "Gets the stamp type.", "minLength": 1, "allOf": [ {} ], "$ref": "#/definitions/StampType" }, "Background": { "type": "boolean", "description": "Sets or gets a bool value that indicates the content is stamped as background.\nIf the value is true, the stamp content is layed at the bottom.\nBy defalt, the value is false, the stamp content is layed at the top." }, "BottomMargin": { "type": "number", "description": "Gets or sets bottom margin of stamp.", "format": "double" }, "HorizontalAlignment": { "description": "Gets or sets Horizontal alignment of stamp on the page. ", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "LeftMargin": { "type": "number", "description": "Gets or sets left margin of stamp.", "format": "double" }, "Opacity": { "type": "number", "description": "Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0.\nBy default the value is 1.0.", "format": "double" }, "RightMargin": { "type": "number", "description": "Gets or sets right margin of stamp.", "format": "double" }, "Rotate": { "description": "Sets or gets the rotation of stamp content according Rotation values.\nNote. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees).\nTo set arbitrary angle use RotateAngle property. \nIf angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.", "allOf": [ {} ], "$ref": "#/definitions/Rotation" }, "RotateAngle": { "type": "number", "description": "Gets or sets rotate angle of stamp in degrees.\nThis property allows to set arbitrary rotate angle. ", "format": "double" }, "TopMargin": { "type": "number", "description": "Gets or sets top margin of stamp.", "format": "double" }, "VerticalAlignment": { "description": "Gets or sets vertical alignment of stamp on page.", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" }, "XIndent": { "type": "number", "description": "Horizontal stamp coordinate, starting from the left.", "format": "double" }, "YIndent": { "type": "number", "description": "Vertical stamp coordinate, starting from the bottom.", "format": "double" }, "Zoom": { "type": "number", "description": "Zooming factor of the stamp. Allows to scale stamp.", "format": "double" }, "TextAlignment": { "description": "Alignment of the text inside the stamp.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "Value": { "type": "string", "description": "Gets or sets string value which is used as stamp on the page." }, "TextState": { "description": "Gets text properties of the stamp. See TextState for details.", "allOf": [ {} ], "$ref": "#/definitions/TextState" }, "FileName": { "type": "string", "description": "Gets or sets the file name." }, "Width": { "type": "number", "description": "Gets or sets image width. Setting this property allos to scal image horizontally.", "format": "double" }, "Height": { "type": "number", "description": "Gets or sets image height. Setting this image allows to scale image vertically.", "format": "double" }, "PageIndex": { "type": "integer", "description": "Gets or sets the index of the page.", "format": "int32" }, "StartingNumber": { "type": "integer", "description": "Gets or sets value of the number of starting page. Other pages will be numbered starting from this value.", "format": "int32" } } }, "StampType": { "type": "string", "description": "Represents enumeration of the stamp types.", "x-enumNames": [ "Text", "Image", "Page", "PageNumber" ], "enum": [ "Text", "Image", "Page", "PageNumber" ], "x-enumDescriptions": { "Text": "Text stamp", "Image": "Image stamp", "Page": "Page stamp", "PageNumber": "Page number stamp" } }, "DocumentPropertiesResponse": { "type": "object", "description": "Represents response containing multiple document properties info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple document properties info", "additionalProperties": false, "properties": { "DocumentProperties": { "description": "DocumentProperties object", "allOf": [ {} ], "$ref": "#/definitions/DocumentProperties" } } } ] }, "DocumentPropertyResponse": { "type": "object", "description": "Represents response containing single document property info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single document property info", "additionalProperties": false, "properties": { "DocumentProperty": { "description": "DocumentProperty object", "allOf": [ {} ], "$ref": "#/definitions/DocumentProperty" } } } ] }, "StampsInfoResponse": { "type": "object", "description": "Represents multiple stamps info reponse", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents multiple stamps info reponse", "additionalProperties": false, "properties": { "Stamps": { "description": "Stamps info", "allOf": [ {} ], "$ref": "#/definitions/StampsInfo" } } } ] }, "StampsInfo": { "type": "object", "description": "Object representing a list of stamps.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Object representing a list of stamps.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of stamps.", "items": { "$ref": "#/definitions/StampInfo" } } } } ] }, "StampInfo": { "type": "object", "description": "Provides stamp info.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Provides stamp info.", "additionalProperties": false, "required": [ "StampType" ], "properties": { "Id": { "type": "string", "description": "Gets ID of the stamp." }, "IndexOnPage": { "type": "integer", "description": "Gets index on page of the stamp.", "format": "int32" }, "PageIndex": { "type": "integer", "description": "Gets PageIndex of the annotation.", "format": "int32" }, "Rect": { "description": "Gets Rect of the annotation.", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" }, "Text": { "type": "string", "description": "Get the text content." }, "Visible": { "type": "boolean", "description": "Gets the stamp is visible." }, "StampType": { "description": "Gets stamp type.", "allOf": [ {} ], "$ref": "#/definitions/StampType" } } } ] }, "TextStamp": { "type": "object", "discriminator": "Type", "description": "Represents Pdf stamps.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/StampBase" }, { "type": "object", "description": "Represents Pdf stamps.", "additionalProperties": false, "properties": { "TextAlignment": { "description": "Alignment of the text inside the stamp.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "Value": { "type": "string", "description": "Gets or sets string value which is used as stamp on the page." }, "TextState": { "description": "Gets text properties of the stamp. See TextState for details.", "allOf": [ {} ], "$ref": "#/definitions/TextState" }, "VerticalAlignment": { "description": "Gets or sets vertical alignment of stamp on page.", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" }, "BottomMargin": { "type": "number", "description": "Gets or sets bottom margin of stamp.", "format": "double" }, "LeftMargin": { "type": "number", "description": "Gets or sets left margin of stamp.", "format": "double" }, "TopMargin": { "type": "number", "description": "Gets or sets top margin of stamp.", "format": "double" }, "RightMargin": { "type": "number", "description": "Gets or sets right margin of stamp.", "format": "double" } } } ] }, "TextStampPageSpecified": { "type": "object", "description": "Represents Pdf stamps.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/TextStamp" }, { "type": "object", "description": "Represents Pdf stamps.", "additionalProperties": false, "required": [ "PageNumber" ], "properties": { "PageNumber": { "type": "integer", "description": "Page number.", "format": "int32" } } } ] }, "ImageStamp": { "type": "object", "discriminator": "Type", "description": "Represents Pdf stamps.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/StampBase" }, { "type": "object", "description": "Represents Pdf stamps.", "additionalProperties": false, "properties": { "FileName": { "type": "string", "description": "Gets or sets the file name." }, "Width": { "type": "number", "description": "Gets or sets image width. Setting this property allos to scal image horizontally.", "format": "double" }, "Height": { "type": "number", "description": "Gets or sets image height. Setting this image allows to scale image vertically.", "format": "double" }, "VerticalAlignment": { "description": "Gets or sets vertical alignment of stamp on page.", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" }, "BottomMargin": { "type": "number", "description": "Gets or sets bottom margin of stamp.", "format": "double" }, "LeftMargin": { "type": "number", "description": "Gets or sets left margin of stamp.", "format": "double" }, "TopMargin": { "type": "number", "description": "Gets or sets top margin of stamp.", "format": "double" }, "RightMargin": { "type": "number", "description": "Gets or sets right margin of stamp.", "format": "double" } } } ] }, "ImageStampPageSpecified": { "type": "object", "description": "Represents Pdf stamps.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/ImageStamp" }, { "type": "object", "description": "Represents Pdf stamps.", "additionalProperties": false, "required": [ "PageNumber" ], "properties": { "PageNumber": { "type": "integer", "description": "Page number.", "format": "int32" } } } ] }, "PdfPageStamp": { "type": "object", "description": "Represents Pdf stamps.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/StampBase" }, { "type": "object", "description": "Represents Pdf stamps.", "additionalProperties": false, "properties": { "FileName": { "type": "string", "description": "Gets or sets the file name." }, "PageIndex": { "type": "integer", "description": "Gets or sets the index of the page.", "format": "int32" }, "VerticalAlignment": { "description": "Gets or sets vertical alignment of stamp on page.", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" }, "BottomMargin": { "type": "number", "description": "Gets or sets bottom margin of stamp.", "format": "double" }, "LeftMargin": { "type": "number", "description": "Gets or sets left margin of stamp.", "format": "double" }, "TopMargin": { "type": "number", "description": "Gets or sets top margin of stamp.", "format": "double" }, "RightMargin": { "type": "number", "description": "Gets or sets right margin of stamp.", "format": "double" } } } ] }, "PageNumberStamp": { "type": "object", "description": "Represents Pdf stamps.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/StampBase" }, { "type": "object", "description": "Represents Pdf stamps.", "additionalProperties": false, "properties": { "Value": { "type": "string", "description": "Gets or sets string value which is used as stamp on the page." }, "StartingNumber": { "type": "integer", "description": "Gets or sets value of the number of starting page. Other pages will be numbered starting from this value.", "format": "int32" }, "VerticalAlignment": { "description": "Gets or sets vertical alignment of stamp on page.", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" }, "BottomMargin": { "type": "number", "description": "Gets or sets bottom margin of stamp.", "format": "double" }, "LeftMargin": { "type": "number", "description": "Gets or sets left margin of stamp.", "format": "double" }, "TopMargin": { "type": "number", "description": "Gets or sets top margin of stamp.", "format": "double" }, "RightMargin": { "type": "number", "description": "Gets or sets right margin of stamp.", "format": "double" } } } ] }, "StorageExist": { "type": "object", "description": "Storage exists", "additionalProperties": false, "required": [ "Exists" ], "properties": { "Exists": { "type": "boolean", "description": "Shows that the storage exists.\n " } } }, "ObjectExist": { "type": "object", "description": "Object exists", "additionalProperties": false, "required": [ "Exists", "IsFolder" ], "properties": { "Exists": { "type": "boolean", "description": "Indicates that the file or folder exists." }, "IsFolder": { "type": "boolean", "description": "True if it is a folder, false if it is a file." } } }, "DiscUsage": { "type": "object", "description": "Class for disc space information.", "additionalProperties": false, "required": [ "UsedSize", "TotalSize" ], "properties": { "UsedSize": { "type": "integer", "description": "Application used disc space.", "format": "int64" }, "TotalSize": { "type": "integer", "description": "Total disc space.", "format": "int64" } } }, "FileVersions": { "type": "object", "description": "File versions FileVersion.", "additionalProperties": false, "properties": { "Value": { "type": "array", "description": "File versions FileVersion.", "items": { "$ref": "#/definitions/FileVersion" } } } }, "FileVersion": { "type": "object", "description": "File Version", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/StorageFile" }, { "type": "object", "description": "File Version", "additionalProperties": false, "required": [ "IsLatest" ], "properties": { "VersionId": { "type": "string", "description": "File Version ID." }, "IsLatest": { "type": "boolean", "description": "Specifies whether the file is (true) or is not (false) the latest version of an file." } } } ] }, "TablesRecognizedResponse": { "type": "object", "description": "Represents response containing multiple tables info", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing multiple tables info", "additionalProperties": false, "properties": { "Tables": { "description": "TablesRecognized object", "allOf": [ {} ], "$ref": "#/definitions/TablesRecognized" } } } ] }, "TablesRecognized": { "type": "object", "description": "Represents list of recognized tables.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents list of recognized tables.", "additionalProperties": false, "properties": { "List": { "type": "array", "description": "List of tables.", "items": { "$ref": "#/definitions/TableRecognized" } } } } ] }, "TableRecognized": { "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "additionalProperties": false, "properties": { "RowList": { "type": "array", "description": "Gets readonly IList containing rows of the table", "items": { "$ref": "#/definitions/RowRecognized" } }, "Rectangle": { "description": "Gets rectangle that describes position of the table on page", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" }, "PageNum": { "type": "integer", "description": "Gets number of the page containing this table", "format": "int32" }, "Id": { "type": "string", "description": "Gets ID of the table." } } } ] }, "RowRecognized": { "type": "object", "additionalProperties": false, "properties": { "CellList": { "type": "array", "description": "Gets readonly IList containing cells of the row", "items": { "$ref": "#/definitions/CellRecognized" } }, "Rectangle": { "description": "Gets rectangle that describes position of the row on page", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" } } }, "CellRecognized": { "type": "object", "additionalProperties": false, "properties": { "TextRects": { "description": "Gets collection of TextRect objects that describes text containing in the cell", "allOf": [ {} ], "$ref": "#/definitions/TextRects" }, "Rectangle": { "description": "Gets rectangle that describes position of the cell on page", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" } } }, "TableRecognizedResponse": { "type": "object", "description": "Represents response containing single recognized table", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing single recognized table", "additionalProperties": false, "properties": { "Table": { "description": "TableRecognized object", "allOf": [ {} ], "$ref": "#/definitions/TableRecognized" } } } ] }, "Table": { "type": "object", "description": "Represents a table that can be added to the page.", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/LinkElement" }, { "type": "object", "description": "Represents a table that can be added to the page.", "additionalProperties": false, "required": [ "Rows" ], "properties": { "Alignment": { "description": "Gets HorizontalAlignment of the table alignment.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "HorizontalAlignment": { "description": "Gets HorizontalAlignment of the table alignment.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "VerticalAlignment": { "description": "Gets VerticalAlignment of the annotation.", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" }, "Top": { "type": "number", "description": "Gets or sets the table top coordinate.", "format": "double" }, "Left": { "type": "number", "description": "Gets or sets the table left coordinate.", "format": "double" }, "DefaultCellTextState": { "description": "Gets or sets the default cell text state.", "allOf": [ {} ], "$ref": "#/definitions/TextState" }, "DefaultCellPadding": { "description": "Gets or sets the default cell padding.", "allOf": [ {} ], "$ref": "#/definitions/MarginInfo" }, "Border": { "description": "Gets or sets the border.", "allOf": [ {} ], "$ref": "#/definitions/BorderInfo" }, "Margin": { "description": "Gets or sets a outer margin for paragraph (for pdf generation)", "allOf": [ {} ], "$ref": "#/definitions/MarginInfo" }, "Rows": { "type": "array", "description": "Sets the rows of the table.", "minItems": 1, "items": { "$ref": "#/definitions/Row" } }, "DefaultColumnWidth": { "type": "string", "description": "Gets default cell border;" }, "DefaultCellBorder": { "description": "Gets default cell border;", "allOf": [ {} ], "$ref": "#/definitions/BorderInfo" }, "Broken": { "description": "Gets or sets table vertial broken;", "allOf": [ {} ], "$ref": "#/definitions/TableBroken" }, "ColumnWidths": { "type": "string", "description": "Gets the column widths of the table." }, "RepeatingRowsCount": { "type": "integer", "description": "Gets the first rows count repeated for several pages", "format": "int32" }, "RepeatingColumnsCount": { "type": "integer", "description": "Gets or sets the maximum columns count for table", "format": "int32" }, "RepeatingRowsStyle": { "description": "Gets the style for repeating rows", "allOf": [ {} ], "$ref": "#/definitions/TextState" }, "CornerStyle": { "description": "Gets or sets the styles of the border corners", "allOf": [ {} ], "$ref": "#/definitions/BorderCornerStyle" }, "BreakText": { "description": "Gets or sets break text for table", "allOf": [ {} ], "$ref": "#/definitions/TextRect" }, "BackgroundColor": { "description": "Gets or sets table background color", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "IsBordersIncluded": { "type": "boolean", "description": "Gets or sets border included in column widhts." }, "ColumnAdjustment": { "description": "Gets or sets the table column adjustment.", "allOf": [ {} ], "$ref": "#/definitions/ColumnAdjustment" }, "ZIndex": { "type": "integer", "description": "Gets ZIndex of the annotation.", "format": "int32" } } } ] }, "BorderInfo": { "type": "object", "description": "This class represents border for graphics elements.", "additionalProperties": false, "properties": { "Left": { "description": "Gets or sets a object that indicates left of the border.", "allOf": [ {} ], "$ref": "#/definitions/GraphInfo" }, "Right": { "description": "Gets or sets a object that indicates right of the border.", "allOf": [ {} ], "$ref": "#/definitions/GraphInfo" }, "Top": { "description": "Gets or sets a object that indicates the top border.", "allOf": [ {} ], "$ref": "#/definitions/GraphInfo" }, "Bottom": { "description": "Gets or sets a object that indicates bottom of the border.", "allOf": [ {} ], "$ref": "#/definitions/GraphInfo" }, "RoundedBorderRadius": { "type": "number", "description": "Gets or sets a rouded border radius", "format": "double" } } }, "GraphInfo": { "type": "object", "description": "Represents graphics info.", "additionalProperties": false, "properties": { "LineWidth": { "type": "number", "description": "Gets or sets a float value that indicates the line width of the graph.", "format": "double" }, "Color": { "description": "Gets or sets a Color object that indicates the color of the graph.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "DashArray": { "type": "array", "description": "Gets or sets a dash array.", "items": { "type": "integer", "format": "int32" } }, "DashPhase": { "type": "integer", "description": "Gets or sets a dash phase.", "format": "int32" }, "FillColor": { "description": "Gets or sets a Color object that indicates the fill color of the graph.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "IsDoubled": { "type": "boolean", "description": "Gets or sets is border doubled." }, "SkewAngleX": { "type": "number", "description": "Gets or sets a float value that indicates the skew angle of the x-coordinate when transforming a coordinate system.", "format": "double" }, "SkewAngleY": { "type": "number", "description": "Gets or sets a float value that indicates the skew angle of the y-coordinate when transforming a coordinate system.", "format": "double" }, "ScalingRateX": { "type": "number", "description": "Gets or sets a float value that indicates the scaling rate of the x-coordinate when transforming a coordinate system.", "format": "double" }, "ScalingRateY": { "type": "number", "description": "Gets or sets a float value that indicates the scaling rate of the y-coordinate when transforming a coordinate system.", "format": "double" }, "RotationAngle": { "type": "number", "description": "Gets or sets a float value that indicates the rotation angle of the coordinate system \nwhen transforming a coordinate system.", "format": "double" } } }, "Row": { "type": "object", "description": "Represents a row of the table.", "additionalProperties": false, "required": [ "Cells" ], "properties": { "BackgroundColor": { "description": "Gets or sets the background color.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "Border": { "description": "Gets or sets the border.", "allOf": [ {} ], "$ref": "#/definitions/BorderInfo" }, "Cells": { "type": "array", "description": "Sets the cells of the row.", "minItems": 1, "items": { "$ref": "#/definitions/Cell" } }, "DefaultCellBorder": { "description": "Gets default cell border;", "allOf": [ {} ], "$ref": "#/definitions/BorderInfo" }, "MinRowHeight": { "type": "number", "description": "Gets height for row;", "format": "double" }, "FixedRowHeight": { "type": "number", "description": "Gets fixed row height - row may have fixed height;", "format": "double" }, "IsInNewPage": { "type": "boolean", "description": "Gets fixed row is in new page - page with this property should be printed to next page Default false;" }, "IsRowBroken": { "type": "boolean", "description": "Gets is row can be broken between two pages" }, "DefaultCellTextState": { "description": "Gets or sets default text state for row cells", "allOf": [ {} ], "$ref": "#/definitions/TextState" }, "DefaultCellPadding": { "description": "Gets or sets default margin for row cells", "allOf": [ {} ], "$ref": "#/definitions/MarginInfo" }, "VerticalAlignment": { "description": "Gets or sets the vertical alignment.", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" } } }, "Cell": { "type": "object", "description": "Represents a cell of the table's row.", "additionalProperties": false, "properties": { "IsNoBorder": { "type": "boolean", "description": "Gets or sets the cell have border." }, "Margin": { "description": "Gets or sets the padding.", "allOf": [ {} ], "$ref": "#/definitions/MarginInfo" }, "Border": { "description": "Gets or sets the border.", "allOf": [ {} ], "$ref": "#/definitions/BorderInfo" }, "BackgroundColor": { "description": "Gets or sets the background color.", "allOf": [ {} ], "$ref": "#/definitions/Color" }, "BackgroundImageFile": { "type": "string", "description": "Gets or sets the background image file." }, "BackgroundImageStorageFile": { "type": "string", "description": "Gets or sets path of the background image file from storage." }, "Alignment": { "description": "Gets or sets the alignment.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "DefaultCellTextState": { "description": "Gets or sets the default cell text state.", "allOf": [ {} ], "$ref": "#/definitions/TextState" }, "Paragraphs": { "type": "array", "description": "Gets or sets the cell's formatted text.", "items": { "$ref": "#/definitions/TextRect" } }, "IsWordWrapped": { "type": "boolean", "description": "Gets or sets the cell's text word wrapped." }, "VerticalAlignment": { "description": "Gets or sets the vertical alignment.", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" }, "ColSpan": { "type": "integer", "description": "Gets or sets the column span.", "format": "int32" }, "RowSpan": { "type": "integer", "description": "Gets or sets the row span.", "format": "int32" }, "Width": { "type": "number", "description": "Gets or sets the column width.", "format": "double" }, "HtmlFragment": { "type": "string", "description": "Gets or sets Html fragment." }, "Images": { "type": "array", "description": "Gets or sets ImageFragment list.", "items": { "$ref": "#/definitions/ImageFragment" } } } }, "ImageFragment": { "type": "object", "description": "Represents Image Fragment DTO.", "additionalProperties": false, "required": [ "ImageFile" ], "properties": { "ImageFile": { "type": "string", "description": "Gets or sets full storage path of image.", "minLength": 1 }, "FixWidth": { "type": "number", "description": "Gets or sets fix width of the image.", "format": "double" }, "FixHeight": { "type": "number", "description": "Gets or sets fix height of the image.", "format": "double" }, "HorizontalAlignment": { "description": "Gets or sets horizontal alignment of the image.", "allOf": [ {} ], "$ref": "#/definitions/HorizontalAlignment" }, "VerticalAlignment": { "description": "Gets or sets vertical alignment of the image.", "allOf": [ {} ], "$ref": "#/definitions/VerticalAlignment" }, "ImageScale": { "type": "number", "description": "Gets or sets ImageScale of the image.", "format": "double" }, "Margin": { "description": "Gets or sets Margin of the image.", "allOf": [ {} ], "$ref": "#/definitions/MarginInfo" } } }, "TableBroken": { "type": "string", "description": "Enumerates the table broken.", "x-enumNames": [ "None", "Vertical", "VerticalInSamePage" ], "enum": [ "None", "Vertical", "VerticalInSamePage" ], "x-enumDescriptions": { "None": "No broken.", "Vertical": "Vertical broken.", "VerticalInSamePage": "Vertical broken in same page." } }, "BorderCornerStyle": { "type": "string", "description": "Enumerates the border corner styles for border.", "x-enumNames": [ "None", "Round" ], "enum": [ "None", "Round" ], "x-enumDescriptions": { "None": "None border style.", "Round": "Round border style." } }, "ColumnAdjustment": { "type": "string", "description": "Enumerates column adjustment types.", "x-enumNames": [ "Customized", "AutoFitToContent", "AutoFitToWindow" ], "enum": [ "Customized", "AutoFitToContent", "AutoFitToWindow" ], "x-enumDescriptions": { "Customized": "Customized.", "AutoFitToContent": "Auto fit to content.", "AutoFitToWindow": "Auto fit to window." } }, "TextReplaceResponse": { "type": "object", "description": "Represents response containing the result of text replacement", "additionalProperties": false, "allOf": [ { "$ref": "#/definitions/AsposeResponse" }, { "type": "object", "description": "Represents response containing the result of text replacement", "additionalProperties": false, "required": [ "Matches" ], "properties": { "Matches": { "type": "integer", "description": "Number of matches", "format": "int32" } } } ] }, "TextReplaceListRequest": { "type": "object", "description": "Multiple text replacements request.", "additionalProperties": false, "required": [ "TextReplaces" ], "properties": { "TextReplaces": { "type": "array", "description": "A list of text replacement settings.", "minItems": 1, "items": { "$ref": "#/definitions/TextReplace" } }, "DefaultFont": { "type": "string", "description": "Name of font to use if requested font is not embedded into document." }, "StartIndex": { "type": "integer", "description": "The index of first match to be replaced.", "format": "int32" }, "CountReplace": { "type": "integer", "description": "The number of matches to be replaced.", "format": "int32" } } }, "TextReplace": { "type": "object", "description": "Single text replacement setting.", "additionalProperties": false, "required": [ "OldValue", "Regex" ], "properties": { "OldValue": { "type": "string", "description": "Original text.", "minLength": 1 }, "NewValue": { "type": "string", "description": "New text." }, "Regex": { "type": "boolean", "description": "Gets or sets a value indicating whether search text is regular expression." }, "TextState": { "description": "Text properties of a new text.", "allOf": [ {} ], "$ref": "#/definitions/TextState" }, "Rect": { "description": "Rectangle area where searched original text.", "allOf": [ {} ], "$ref": "#/definitions/Rectangle" }, "CenterTextHorizontally": { "type": "boolean", "description": "The text after replacement is centered horizontally relative to the text being replaced." } } }, "XmpMetadata": { "type": "object", "description": "Document Xmp Metadata.", "additionalProperties": false, "properties": { "Properties": { "type": "array", "description": "List of document Xmp Metadata default properties.", "items": { "$ref": "#/definitions/XmpMetadataProperty" } } } }, "XmpMetadataProperty": { "type": "object", "description": "Xmp Metadata Property.", "additionalProperties": false, "required": [ "Key" ], "properties": { "Key": { "type": "string", "description": "Xmp Metadata Property Key. Can take the form for default keys: xmp:DefaultKeyName or DefaultKeyName.\nForm for user defined properties: customNamespace:UserPropertyName.", "minLength": 1 }, "Value": { "type": "string", "description": "Xmp Metadata Property Value. Null for delete property." }, "NamespaceUri": { "type": "string", "description": "Namespace Uri. For user defined properties only." } } } }, "securityDefinitions": { "JWT": { "type": "oauth2", "flow": "application", "tokenUrl": "https://api.aspose.cloud/connect/token" } } }