PowerPlatformConnectors/certified-connectors/Document Merge/apiDefinition.swagger.json

{
  "swagger": "2.0",
  "info": {
    "version": "3.0",
    "title": "Document Merge",
    "description": "SharePoint Document and Mail Merge is the simple, fast and clean way to merge SharePoint list data into predefined Word, Excel and PowerPoint document templates with NO CODE!",
    "contact": {
      "name": "APPS 365 LTD",
      "url": "https://apps365ltd.com/support",
      "email": "support@apps365ltd.com"
    }
  },
  "x-ms-connector-metadata": [
    {
      "propertyName": "Website",
      "propertyValue": "https://sharepointdocumentmerge.com/"
    },
    {
      "propertyName": "Privacy Policy",
      "propertyValue": "https://sharepointdocumentmerge.com/privacy.php"
    },
    {
      "propertyName": "Categories",
      "propertyValue": "Content and Files;Productivity"
    }
  ],
  "host": "docmergewebapi.azurewebsites.net",
  "basePath": "/",
  "schemes": [
    "https"
  ],
  "consumes": [],
  "produces": [],
  "paths": {
    "/api/Values": {
      "post": {
        "tags": [
          "Values"
        ],
        "operationId": "ValuesDocumentMerge",
        "consumes": [],
        "produces": [],
        "parameters": [
          {
            "name": "LinkToItem",
            "in": "query",
            "required": true,
            "type": "string",
            "description": "Select the Link to item option from Dynamic content - see manual for help - www.documentmerge.com",
            "x-ms-summary": "Link To Item"
          },
          {
            "name": "PreConfigTemplate",
            "in": "query",
            "required": false,
            "type": "string",
            "description": "Available when the Document and Mail Merge Add-In is installed - www.documentmerge.com",
            "x-ms-summary": "Pre-Config Template"
          },
          {
            "name": "Source",
            "in": "query",
            "required": false,
            "type": "string",
            "description": "Set the path to the source document Template e.g. \"LibraryName\\TemaplateName.docx\"",
            "x-ms-summary": "Source"
          },
          {
            "name": "Destination",
            "in": "query",
            "required": false,
            "type": "string",
            "description": "The Library name to store generated document",
            "x-ms-summary": "Destination"
          },
          {
            "name": "SaveAsPDF",
            "in": "query",
            "required": false,
            "type": "boolean",
            "description": "Set to save an accompany PDF file",
            "x-ms-summary": "Save as PDF"
          },
          {
            "name": "SaveAsPDFOnly",
            "in": "query",
            "required": false,
            "type": "boolean",
            "description": "Set to save only a PDF file no accompanying document",
            "x-ms-summary": "Save as PDF only"
          },
          {
            "name": "SaveAsPDFA",
            "in": "query",
            "required": false,
            "type": "boolean",
            "description": "Set to save PDF file as PDF\\A format",
            "x-ms-summary": "Save as PDF/A"
          },
          {
            "name": "DisplayImage",
            "in": "query",
            "required": false,
            "type": "boolean",
            "description": "Will display Image instead of hyperlink of image",
            "x-ms-summary": "Display Image"
          },
          {
            "name": "OutputFileName",
            "in": "query",
            "required": false,
            "type": "string",
            "description": "The name to save the file - can include list internal column names - see manual www.documentmerge.com",
            "x-ms-summary": "Output file name"
          },
          {
            "name": "OverWrite",
            "in": "query",
            "required": false,
            "type": "boolean",
            "description": "Overwrite the document if same name",
            "x-ms-summary": "Overwrite"
          },
          {
            "name": "SendMail",
            "in": "query",
            "required": false,
            "type": "boolean",
            "description": "Available when the Document and Mail Merge Add-In is installed",
            "x-ms-summary": "Send mail"
          },
          {
            "name": "MailTemplate",
            "in": "query",
            "required": false,
            "type": "string",
            "description": "Specify if Send Mail Option selected e.g. \"TemplateTitleName\"",
            "x-ms-summary": "Mail template"
          }
        ],
        "responses": {
          "200": {
            "description": "default",
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "description": "message"
                },
                "URL": {
                  "type": "string",
                  "description": "URL"
                }
              }
            },
            "headers": {
              "200": {
                "description": "200",
                "type": "string"
              }
            }
          },
          "204": {
            "description": "No Content"
          }
        },
        "summary": "Document Merge",
        "description": "Document Merge"
      }
    }
  },
  "definitions": {},
  "parameters": {},
  "responses": {},
  "securityDefinitions": {
    "AAD": {
      "type": "oauth2",
      "flow": "accessCode",
      "authorizationUrl": "https://login.windows.net/common/oauth2/authorize",
      "tokenUrl": "https://login.windows.net/common/oauth2/token",
      "scopes": {}
    }
  },
  "security": [
    {
      "AAD": []
    }
  ],
  "tags": []
}