{ "swagger": "2.0", "info": { "title": "Encodian - PowerPoint", "description": "The 'Encodian – PowerPoint' connector provides an extensive collection of actions which facilitate the manipulation and creation of Microsoft PowerPoint files covering all common formats. This connector is one of nine connectors which form 'Encodian Flowr'; a complete solution for end-to-end document automation used by over 75,000 organizations. 'Encodian Flowr' powers everything from templated document creation to complex document manipulation.", "termsOfService": "https://support.encodian.com/hc/en-gb/articles/360010642813-Terms-of-Service", "contact": { "name": "Encodian Support", "url": "https://support.encodian.com", "email": "support@encodian.com" }, "license": { "name": "Create an 'Encodian Flowr' subscription", "url": "https://www.encodian.com/apikey" }, "version": "v1.0" }, "host": "api.apps-encodian.com", "schemes": [ "https" ], "paths": { "/api/v1/PowerPoint/CompressPowerPoint": { "post": { "tags": [ "PowerPoint" ], "operationId": "PowerPoint_CompressPowerPoint", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoCompressPowerPoint", "schema": { "$ref": "#/definitions/DtoCompressPowerPoint" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseCompressPowerPoint" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseCompressPowerPoint" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseCompressPowerPoint" } } }, "x-ms-visibility": "important", "summary": "PowerPoint - Compress", "description": "Compress the PowerPoint file provided - https://support.encodian.com/hc/en-gb/articles/7621965500189" } }, "/api/v1/PowerPoint/PowerPointDeleteSlides": { "post": { "tags": [ "PowerPoint" ], "operationId": "PowerPoint_PowerPointDeleteSlides", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoResponsePowerPointDeleteSlides", "schema": { "$ref": "#/definitions/DtoPowerPointDeleteSlides" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePowerPointDeleteSlides" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePowerPointDeleteSlides" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePowerPointDeleteSlides" } } }, "x-ms-visibility": "important", "summary": "PowerPoint - Delete Slides", "description": "Delete specified slides from the Microsoft PowerPoint file provided - https://support.encodian.com/hc/en-gb/articles/16535770370844" } }, "/api/v1/PowerPoint/MergePresentations": { "post": { "tags": [ "PowerPoint" ], "operationId": "PowerPoint_MergePresentations", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoMergePresentations", "schema": { "$ref": "#/definitions/DtoMergePresentations" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseMergePresentations" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseMergePresentations" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseMergePresentations" } } }, "x-ms-visibility": "important", "summary": "PowerPoint - Merge Files", "description": "Merge an array of presentations to a single presentation - https://support.encodian.com/hc/en-gb/articles/4425652063761" } }, "/api/v1/PowerPoint/PopulatePowerPoint": { "post": { "tags": [ "PowerPoint" ], "operationId": "PowerPoint_PopulatePowerPoint", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPopulatePowerPoint", "schema": { "$ref": "#/definitions/DtoPopulatePowerPoint" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePopulatePowerPoint" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePopulatePowerPoint" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePopulatePowerPoint" } } }, "x-ms-visibility": "important", "summary": "PowerPoint - Populate", "description": "Populate a Microsoft PowerPoint file (PPTX) with the JSON data provided - https://support.encodian.com/hc/en-gb/articles/9715390966300" } }, "/api/v1/PowerPoint/PowerPointSearchAndReplaceText": { "post": { "tags": [ "PowerPoint" ], "operationId": "PowerPoint_PowerPointSearchAndReplaceText", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPowerPointSearchAndReplaceText", "schema": { "$ref": "#/definitions/DtoPowerPointSearchAndReplaceText" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePowerPointSearchAndReplaceText" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePowerPointSearchAndReplaceText" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePowerPointSearchAndReplaceText" } } }, "x-ms-visibility": "important", "summary": "PowerPoint - Replace Text", "description": "Find and replace text contained within a Microsoft PowerPoint file - https://support.encodian.com/hc/en-gb/articles/19804599079836" } }, "/api/v1/PowerPoint/PowerPointSplit": { "post": { "tags": [ "PowerPoint" ], "operationId": "PowerPoint_PowerPointSplit", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "operation", "description": "Request object, refer to schema definition: DtoPowerPointSplit", "schema": { "$ref": "#/definitions/DtoPowerPointSplit" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponsePowerPointSplit" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponsePowerPointSplit" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponsePowerPointSplit" } } }, "x-ms-visibility": "important", "summary": "PowerPoint - Split", "description": "Split a Microsoft PowerPoint Document into multiple seperate files - https://support.encodian.com/hc/en-gb/articles/16517600430620" } }, "/api/v1/PowerPoint/GetOperationStatusSplitDocument": { "get": { "tags": [ "PowerPoint" ], "operationId": "PowerPoint_GetOperationStatusSplitDocument", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of a SplitDocument operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseSplitDocument" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseSplitDocument" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseSplitDocument" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for SplitDocument", "description": "Get the operation status of the operation ID provided." } }, "/api/v1/PowerPoint/GetOperationStatus": { "get": { "tags": [ "PowerPoint" ], "operationId": "PowerPoint_GetOperationStatus", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponse" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponse" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status", "description": "Get the operation status for the operation ID provided." } }, "/api/v1/PowerPoint/GetOperationStatusChd": { "get": { "tags": [ "PowerPoint" ], "operationId": "PowerPoint_GetOperationStatusChd", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status for the CHD Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponse" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponse" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponse" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for CHD", "description": "Get the operation status of for the CHD operation ID provided." } }, "/api/v1/PowerPoint/GetOperationStatusFileOnly": { "get": { "tags": [ "PowerPoint" ], "operationId": "PowerPoint_GetOperationStatusFileOnly", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status for a file only operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponseFileOnly" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponseFileOnly" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoBaseMgmtResponseFileOnly" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for File Only", "description": "Retrieve the operation status for a file only operation for the Operation ID provided" } }, "/api/v1/PowerPoint/GetOperationStatusMultipleFiles": { "get": { "tags": [ "PowerPoint" ], "operationId": "PowerPoint_GetOperationStatusMultipleFiles", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "operationId", "description": "Retrieve the operation status of a MultipleFiles operation for the Operation ID provided.", "type": "string" }, { "in": "body", "name": "body", "schema": { } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/DtoResponseMultipleFiles" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DtoResponseMultipleFiles" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/DtoResponseMultipleFiles" } } }, "x-ms-visibility": "internal", "summary": "Get an Operation Status for Multiple Files", "description": "Get the operation status of the operation ID provided." } } }, "definitions": { "DocumentArray": { "type": "object", "properties": { "fileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the file" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the file" } } }, "DocumentArrayPresentation": { "required": [ "fileContent", "fileName" ], "type": "object", "properties": { "fileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source file, the file extension is mandatory: 'file.pptx' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source file" }, "sortPosition": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Sort Position", "description": "Set the sort position within the document array" }, "slidesToMerge": { "type": "array", "items": { "format": "int32", "type": "integer" }, "x-ms-visibility": "important", "x-ms-summary": "Slides", "description": "Specify which slides to include in the output" } } }, "DtoBaseMgmtResponse": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoBaseMgmtResponseFileOnly": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoCompressPowerPoint": { "required": [ "fileContent", "fileName" ], "type": "object", "properties": { "fileName": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the source file, the file extension is mandatory: 'file.pptx' and not 'file'" }, "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source file" }, "compressionRate": { "default": "Low", "enum": [ "None", "Low", "Medium", "High" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Image Compression Rate", "description": "Sets the compression rate for images. A higher compression rate generates smaller file sizes." }, "compressEmbeddedFonts": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Embedded Fonts", "description": "Compresses the file provided by removing unused characters from embedded fonts" }, "removeUnusedLayoutSlides": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Unused Layout Slides", "description": "Compresses the file provided by removing unused layout slides" }, "removeUnusedMasterSlides": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Unused Master Slides", "description": "Compresses the file provided by removing unused master slides" }, "resizeImagesToFrameSize": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Resize Images to Frame Size", "description": "Resizes the images to fit the frame in which they are displayed" }, "cultureName": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Culture Name", "description": "Change the thread culture used to process the request." } } }, "DtoMergePresentations": { "required": [ "documents", "mergePresentationOutputFormat" ], "type": "object", "properties": { "mergePresentationOutputFormat": { "default": "PPTX", "enum": [ "FODP", "GIF", "HTML", "ODP", "OTP", "PDF", "POT", "POTM", "POTX", "PPS", "PPSM", "PPSX", "PPT", "PPTM", "PPTX", "SWF", "TIFF", "XPS" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Format", "description": "The format of the output presentation file" }, "outputFilename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the output presentation file, set to 'presentation' by default" }, "documents": { "type": "array", "items": { "$ref": "#/definitions/DocumentArrayPresentation" }, "x-ms-visibility": "important", "x-ms-summary": "Documents", "description": "The array of presentations to be processed" }, "mergePresentationMasterStyle": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Master Style", "description": "Apply the style of the first provided presentation to all other presentations, set to 'false' by default" } } }, "DtoPopulatePowerPoint": { "required": [ "fileContent", "jsonData" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The Microsoft PowerPoint file (PPTX) to populate" }, "jsonData": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "JSON Data", "description": "The JSON data to populate the Microsoft PowerPoint file with" }, "jsonParseMode": { "default": "Standard", "enum": [ "Standard", "Strict" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "JSON Parse Mode", "description": "Sets the JSON parsing mode for simple values (null, boolean, number, integer, and string)" }, "allowMissingMembers": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Allow Missing Values", "description": "Sets the engine to allow missing values within the 'Document Data'" }, "inlineErrorMessages": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Inline Errors", "description": "Produces errors within the resultant document as opposed to rejecting the request with a HTTP 4** error" }, "removeEmptyParagraphs": { "default": true, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Remove Empty Paragraphs", "description": "Sets the engine to automatically removes any empty paragraphs upon execution" }, "dateTimeFormat": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Date Time Formats", "description": "Set one or more specfic formats for parsing DateTime values" }, "multipleSlides": { "default": false, "type": "boolean", "x-ms-visibility": "advanced", "x-ms-summary": "Multiple Slides", "description": "Instruct the population engine to create a slide for each item within the JSON array provided" }, "cultureName": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Culture Name", "description": "Change the thread culture used to process the request" } } }, "DtoPowerPointDeleteSlides": { "required": [ "fileContent" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the Microsoft PowerPoint file" }, "startSlide": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "Start Slide", "description": "Set the slide index to begin deleting slides from" }, "endSlide": { "format": "int32", "type": "integer", "x-ms-visibility": "important", "x-ms-summary": "End Slide", "description": "Set the slide index to stop deleting slides on. The default value is set to the last slide" }, "slideNumbers": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Slide Numbers", "description": "A comma separated list of slide indexes to delete: 1,3,4" }, "cultureName": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Culture Name", "description": "Change the thread culture used to process the request" } } }, "DtoPowerPointSearchAndReplaceText": { "required": [ "phrases" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the source file" }, "phrases": { "type": "array", "items": { "$ref": "#/definitions/PowerPointSearchAndReplaceTextPhrase" }, "x-ms-visibility": "important", "x-ms-summary": "Phrases", "description": "The collection of text phrases to search for and replace" }, "cultureName": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Culture Name", "description": "Change the thread culture used to process the request." } } }, "DtoPowerPointSplit": { "required": [ "fileContent", "splitType" ], "type": "object", "properties": { "fileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The file content of the Microsoft PowerPoint document" }, "splitType": { "enum": [ "All", "NumberOfSlides", "Array" ], "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Split Type", "description": "Select how to split the file" }, "splitConfiguration": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Split Configuration", "description": "Provide a split configuration" }, "cultureName": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Culture Name", "description": "Change the thread culture used to process the request" } } }, "DtoResponseCompressPowerPoint": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseMergePresentations": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponseMultipleFiles": { "required": [ "documents" ], "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/definitions/DocumentArray" }, "x-ms-visibility": "important", "x-ms-summary": "Documents", "description": "An array of files" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponsePopulatePowerPoint": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "Filename": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Filename", "description": "The filename of the document." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePowerPointDeleteSlides": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePowerPointSearchAndReplaceText": { "type": "object", "properties": { "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." }, "FileContent": { "format": "byte", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "File Content", "description": "The processed document." } } }, "DtoResponsePowerPointSplit": { "required": [ "documents" ], "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/definitions/DocumentArray" }, "x-ms-visibility": "important", "x-ms-summary": "Documents", "description": "The array of documents to be processed" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "DtoResponseSplitDocument": { "required": [ "documents" ], "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/definitions/DocumentArray" }, "x-ms-visibility": "important", "x-ms-summary": "Documents", "description": "The array of documents to be processed" }, "HttpStatusCode": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Code", "description": "The HTTP Status code for the response." }, "HttpStatusMessage": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "HTTP Status Message", "description": "The HTTP Status message for the response." }, "OperationId": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Operation ID", "description": "The unique ID assigned to this operation." }, "Errors": { "type": "array", "items": { "type": "string" }, "x-ms-visibility": "advanced", "x-ms-summary": "Errors", "description": "An array of error messages should an error occur." }, "OperationStatus": { "type": "string", "x-ms-summary": "Operation Status", "description": "Indicates whether the operation has completed, has been queued or has failed." } } }, "PowerPointSearchAndReplaceTextPhrase": { "required": [ "searchText" ], "type": "object", "properties": { "searchText": { "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Search Text", "description": "The text to locate and replace with the 'Replacement Text' value" }, "isExpression": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Is Expression", "description": "Set whether the 'Search Text' value should be evaluated as a regular expression, the default value is 'false'" }, "replacementText": { "default": "", "type": "string", "x-ms-visibility": "important", "x-ms-summary": "Replacement Text", "description": "The value to replace the 'Search Text' text with" }, "findWholeWordsOnly": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Find Whole Words Only", "description": "Set whether only entire words should be found" }, "caseSensitive": { "default": false, "type": "boolean", "x-ms-visibility": "important", "x-ms-summary": "Case Sensitive", "description": "Set if the 'Search Text' value should be evaluated as case sensitive" }, "font": { "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Font", "description": "The font name to be used on the 'Replacement Text'. If the 'Font' is not set, it will inherit the current font used in the presentation" }, "fontColour": { "default": "Inherit", "enum": [ "Inherit", "AliceBlue", "AntiqueWhite", "Aqua", "Aquamarine", "Azure", "Beige", "Bisque", "Black", "BlanchedAlmond", "Blue", "BlueViolet", "Brown", "BurlyWood", "CadetBlue", "Chartreuse", "Chocolate", "Coral", "CornflowerBlue", "Cornsilk", "Crimson", "Cyan", "DarkBlue", "DarkCyan", "DarkGoldenrod", "DarkGray", "DarkGreen", "DarkKhaki", "DarkMagenta", "DarkOliveGreen", "DarkOrange", "DarkOrchid", "DarkRed", "DarkSalmon", "DarkSeaGreen", "DarkSlateBlue", "DarkSlateGray", "DarkTurquoise", "DarkViolet", "DeepPink", "DeepSkyBlue", "DimGray", "DodgerBlue", "Firebrick", "FloralWhite", "ForestGreen", "Fuchsia", "Gainsboro", "GhostWhite", "Gold", "Goldenrod", "Gray", "Green", "GreenYellow", "Honeydew", "HotPink", "IndianRed", "Indigo", "Ivory", "Khaki", "Lavender", "LavenderBlush", "LawnGreen", "LemonChiffon", "LightBlue", "LightCoral", "LightCyan", "LightGoldenrodYellow", "LightGray", "LightGreen", "LightPink", "LightSalmon", "LightSeaGreen", "LightSkyBlue", "LightSlateGray", "LightSteelBlue", "LightYellow", "Lime", "LimeGreen", "Linen", "Magenta", "Maroon", "MediumAquamarine", "MediumBlue", "MediumOrchid", "MediumPurple", "MediumSeaGreen", "MediumSlateBlue", "MediumSpringGreen", "MediumTurquoise", "MediumVioletRed", "MidnightBlue", "MintCream", "MistyRose", "Moccasin", "NavajoWhite", "Navy", "OldLace", "Olive", "OliveDrab", "Orange", "OrangeRed", "Orchid", "PaleGoldenrod", "PaleGreen", "PaleTurquoise", "PaleVioletRed", "PapayaWhip", "PeachPuff", "Peru", "Pink", "Plum", "PowderBlue", "Purple", "Red", "RosyBrown", "RoyalBlue", "SaddleBrown", "Salmon", "SandyBrown", "SeaGreen", "SeaShell", "Sienna", "Silver", "SkyBlue", "SlateBlue", "SlateGray", "Snow", "SpringGreen", "SteelBlue", "Tan", "Teal", "Thistle", "Tomato", "Transparent", "Turquoise", "Violet", "Wheat", "White", "WhiteSmoke", "Yellow", "YellowGreen" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Font - Colour", "description": "The font colour to be used on the 'Replacement Text', the default setting is 'Inherit'" }, "fontSize": { "format": "int32", "type": "integer", "x-ms-visibility": "advanced", "x-ms-summary": "Font - Size", "description": "The size of the font to be used for the 'Replacement Text'. If font size is not set, it will inherit the current font size used in the presentation" }, "styleBackgroundColour": { "default": "Inherit", "enum": [ "Inherit", "AliceBlue", "AntiqueWhite", "Aqua", "Aquamarine", "Azure", "Beige", "Bisque", "Black", "BlanchedAlmond", "Blue", "BlueViolet", "Brown", "BurlyWood", "CadetBlue", "Chartreuse", "Chocolate", "Coral", "CornflowerBlue", "Cornsilk", "Crimson", "Cyan", "DarkBlue", "DarkCyan", "DarkGoldenrod", "DarkGray", "DarkGreen", "DarkKhaki", "DarkMagenta", "DarkOliveGreen", "DarkOrange", "DarkOrchid", "DarkRed", "DarkSalmon", "DarkSeaGreen", "DarkSlateBlue", "DarkSlateGray", "DarkTurquoise", "DarkViolet", "DeepPink", "DeepSkyBlue", "DimGray", "DodgerBlue", "Firebrick", "FloralWhite", "ForestGreen", "Fuchsia", "Gainsboro", "GhostWhite", "Gold", "Goldenrod", "Gray", "Green", "GreenYellow", "Honeydew", "HotPink", "IndianRed", "Indigo", "Ivory", "Khaki", "Lavender", "LavenderBlush", "LawnGreen", "LemonChiffon", "LightBlue", "LightCoral", "LightCyan", "LightGoldenrodYellow", "LightGray", "LightGreen", "LightPink", "LightSalmon", "LightSeaGreen", "LightSkyBlue", "LightSlateGray", "LightSteelBlue", "LightYellow", "Lime", "LimeGreen", "Linen", "Magenta", "Maroon", "MediumAquamarine", "MediumBlue", "MediumOrchid", "MediumPurple", "MediumSeaGreen", "MediumSlateBlue", "MediumSpringGreen", "MediumTurquoise", "MediumVioletRed", "MidnightBlue", "MintCream", "MistyRose", "Moccasin", "NavajoWhite", "Navy", "OldLace", "Olive", "OliveDrab", "Orange", "OrangeRed", "Orchid", "PaleGoldenrod", "PaleGreen", "PaleTurquoise", "PaleVioletRed", "PapayaWhip", "PeachPuff", "Peru", "Pink", "Plum", "PowderBlue", "Purple", "Red", "RosyBrown", "RoyalBlue", "SaddleBrown", "Salmon", "SandyBrown", "SeaGreen", "SeaShell", "Sienna", "Silver", "SkyBlue", "SlateBlue", "SlateGray", "Snow", "SpringGreen", "SteelBlue", "Tan", "Teal", "Thistle", "Tomato", "Transparent", "Turquoise", "Violet", "Wheat", "White", "WhiteSmoke", "Yellow", "YellowGreen" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Style - Background Colour", "description": "The background colour to be used on the 'Replacement Text', the default setting is 'Inherit'" }, "styleBold": { "default": "Inherit", "enum": [ "Inherit", "Apply", "Remove" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Style - Bold", "description": "Set whether the 'Replacement Text' is set to be 'Bold', the default is 'Inherit'" }, "styleItalic": { "default": "Inherit", "enum": [ "Inherit", "Apply", "Remove" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Style - Italic", "description": "Set whether the 'Replacement Text' is set to be 'Italic', the default is 'Inherit'" }, "styleScriptPosition": { "default": "Inherit", "enum": [ "Inherit", "Superscript", "Subscript", "Remove" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Style - Script Position", "description": "Set whether the 'Replacement Text' is 'Subscript', 'Superscript' or 'Baseline' , the default is 'Inherit'" }, "styleStrikethrough": { "default": "Inherit", "enum": [ "Inherit", "Single", "Double", "Remove" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Style - Strikethrough", "description": "Set whether the 'Replacement Text' is 'Struck Through', 'Double Struke Through' or 'Remove Strike Through', the default is 'Inherit'" }, "styleUnderline": { "default": "Inherit", "enum": [ "Inherit", "Dashed", "DotDash", "DotDotDash", "Dotted", "Double", "DoubleWavy", "Heavy", "HeavyDashed", "HeavyDotDash", "HeavyDotDotDash", "HeavyDotted", "HeavyLongDashed", "HeavyWavy", "LongDashed", "None", "Single", "Wavy", "Words" ], "type": "string", "x-ms-visibility": "advanced", "x-ms-summary": "Style - Underline", "description": "Set whether the 'Replacement Text' should be 'Underlined', the default value is 'Inherit'" }, "wordSpacing": { "format": "float", "type": "number", "x-ms-visibility": "advanced", "x-ms-summary": "Word Spacing", "description": "The word spacing to apply to the 'Replacement Text'. If 'Word Spacing' is not set, it will inherit the current word spacing used in the presentation" } } } }, "securityDefinitions": { "Bearer": { "type": "apiKey", "name": "X-ApiKey", "in": "header", "description": "API Key Authentication Header" } }, "security": [ { "defaultAuth": [ ] } ] }