Cloudmersive Convert Template API

openapi: 3.2.0
info:
  version: v1
  title: convertapi Convert Template API
  description: Convert API lets you effortlessly convert file formats and types.
servers:
- url: http://localhost
tags:
- name: ConvertTemplate
paths:
  /convert/template/html/apply:
    post:
      tags:
      - ConvertTemplate
      summary: Apply HTML template
      description: Apply operations to fill in an HTML template, generating a final HTML result
      operationId: ConvertTemplate_ApplyHtmlTemplate
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HtmlTemplateApplicationResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/HtmlTemplateApplicationResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/HtmlTemplateApplicationResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/HtmlTemplateApplicationResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HtmlTemplateApplicationRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/HtmlTemplateApplicationRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/HtmlTemplateApplicationRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/HtmlTemplateApplicationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/HtmlTemplateApplicationRequest'
        description: Operations to apply to template
        required: true
  /convert/template/docx/apply:
    post:
      tags:
      - ConvertTemplate
      summary: Apply Word DOCX template
      description: Apply operations to fill in a Word DOCX template by replacing target template/placeholder strings in the DOCX with values, generating a final Word DOCX result. For example, you could create a Word Document invoice containing strings such as "{FirstName}" and "{LastName}" and then replace these values with "John" and "Smith".
      operationId: ConvertTemplate_ApplyDocxTemplate
      parameters:
      - name: templateDefinition
        in: header
        description: Template definition for the document, including what values to replace
        required: false
        schema:
          $ref: '#/components/schemas/DocxTemplateApplicationRequest'
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: Input file to perform the operation on.
                  format: binary
              required:
              - inputFile
components:
  schemas:
    DocxTemplateApplicationRequest:
      description: Word DOCX template application request
      type: object
      properties:
        Operations:
          description: Operations to apply to this template
          type: array
          items:
            $ref: '#/components/schemas/DocxTemplateOperation'
    HtmlTemplateApplicationRequest:
      description: HTML template application request
      type: object
      properties:
        HtmlTemplate:
          description: HTML template input as a string
          type: string
        HtmlTemplateUrl:
          description: URL to HTML template input
          type: string
        Operations:
          description: Operations to apply to this template
          type: array
          items:
            $ref: '#/components/schemas/HtmlTemplateOperation'
    HtmlTemplateOperation:
      type: object
      properties:
        Action:
          format: int32
          description: Operation action to take; possible values are "Replace"
          enum:
          - 1
          type: integer
        MatchAgsint:
          description: For Replace operations, the string to match against (to be replaced with ReplaceWith string)
          type: string
        ReplaceWith:
          description: For Replace operations, the string to Replace the original string with
          type: string
    DocxTemplateOperation:
      type: object
      properties:
        Action:
          format: int32
          description: Operation action to take; possible values are "Replace"
          enum:
          - 1
          type: integer
        MatchAgainst:
          description: For Replace operations, the string to match against (to be replaced with ReplaceWith string)
          type: string
        ReplaceWith:
          description: For Replace operations, the string to Replace the original string with
          type: string
    HtmlTemplateApplicationResponse:
      description: Response from an HTML template application
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        FinalHtml:
          description: Final HTML result of all operations on input
          type: string
  securitySchemes:
    Apikey:
      type: apiKey
      description: API Key Authentication
      name: Apikey
      in: header
x-provenance:
  method: harvested
  publisher: Cloudmersive
  source: https://api.cloudmersive.com/convert/docs/v1/swagger
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)