Cloudmersive Convert Data API

openapi: 3.2.0
info:
  version: v1
  title: convertapi Convert Data API
  description: Convert API lets you effortlessly convert file formats and types.
servers:
- url: http://localhost
tags:
- name: ConvertData
paths:
  /convert/csv/to/json:
    post:
      tags:
      - ConvertData
      summary: Convert CSV to JSON conversion
      description: Convert a CSV file to a JSON object array
      operationId: ConvertData_CsvToJson
      parameters:
      - name: columnNamesFromFirstRow
        in: header
        description: Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc.  Default is true.  Set to false if you are not using column headings, or have an irregular column structure.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      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
  /convert/csv/to/xml:
    post:
      tags:
      - ConvertData
      summary: Convert CSV to XML conversion
      description: Convert a CSV file to a XML file
      operationId: ConvertData_CsvToXml
      parameters:
      - name: columnNamesFromFirstRow
        in: header
        description: Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc.  Default is true.  Set to false if you are not using column headings, or have an irregular column structure.
        required: false
        schema:
          type: boolean
      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
  /convert/xlsx/to/json:
    post:
      tags:
      - ConvertData
      summary: Convert Excel XLSX to JSON conversion
      description: Convert an Excel XLSX file to a JSON object array
      operationId: ConvertData_XlsxToJson
      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
  /convert/xlsx/to/xml:
    post:
      tags:
      - ConvertData
      summary: Convert Excel XLSX to XML conversion
      description: Convert an Excel XLSX file to a XML file
      operationId: ConvertData_XlsxToXml
      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
  /convert/xls/to/json:
    post:
      tags:
      - ConvertData
      summary: Convert Excel (97-2003) XLS to JSON conversion
      description: Convert an Excel (97-2003) XLS file to a JSON object array
      operationId: ConvertData_XlsToJson
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      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
  /convert/xml/to/json:
    post:
      tags:
      - ConvertData
      summary: Convert XML to JSON conversion
      description: Convert an XML string or file into JSON
      operationId: ConvertData_XmlToJson
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      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
  /convert/xml/select/xpath:
    post:
      tags:
      - ConvertData
      summary: Filter, select XML nodes using XPath expression, get results
      description: Return the reuslts of filtering, selecting an XML document with an XPath expression
      operationId: ConvertData_XmlFilterWithXPath
      parameters:
      - name: XPathExpression
        in: header
        description: Valid XML XPath query expression
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XmlFilterWithXPathResult'
            text/json:
              schema:
                $ref: '#/components/schemas/XmlFilterWithXPathResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/XmlFilterWithXPathResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/XmlFilterWithXPathResult'
      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
  /convert/xml/query/xquery:
    post:
      tags:
      - ConvertData
      summary: Query an XML file using XQuery query, get results
      description: Return the reuslts of querying a single XML document with an XQuery expression. Supports XQuery 3.1 and earlier. This API is optimized for a single XML document as input. Provided XML document is automatically loaded as the default context; to access elements in the document, simply refer to them without a document reference, such as bookstore/book
      operationId: ConvertData_XmlQueryWithXQuery
      parameters:
      - name: XQuery
        in: header
        description: Valid XML XQuery 3.1 or earlier query expression; multi-line expressions are supported
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XmlQueryWithXQueryResult'
            text/json:
              schema:
                $ref: '#/components/schemas/XmlQueryWithXQueryResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/XmlQueryWithXQueryResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/XmlQueryWithXQueryResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: Input XML file to perform the operation on.
                  format: binary
              required:
              - inputFile
  /convert/xml/query/xquery/multi:
    post:
      tags:
      - ConvertData
      summary: Query multiple XML files using XQuery query, get results
      description: Return the reuslts of querying an XML document with an XQuery expression. Supports XQuery 3.1 and earlier. This API is optimized for multiple XML documents as input. You can refer to the contents of a given document by name, for example doc("books.xml") or doc("restaurants.xml") if you included two input files named books.xml and restaurants.xml. If input files contain no file name, they will default to file names input1.xml, input2.xml and so on.
      operationId: ConvertData_XmlQueryWithXQueryMulti
      parameters:
      - name: XQuery
        in: header
        description: Valid XML XQuery 3.1 or earlier query expression; multi-line expressions are supported
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XmlQueryWithXQueryMultiResult'
            text/json:
              schema:
                $ref: '#/components/schemas/XmlQueryWithXQueryMultiResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/XmlQueryWithXQueryMultiResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/XmlQueryWithXQueryMultiResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile1:
                  type: string
                  description: First input XML file to perform the operation on.
                  format: binary
                inputFile2:
                  type: string
                  description: Second input XML file to perform the operation on.
                  format: binary
                inputFile3:
                  type: string
                  description: Third input XML file to perform the operation on.
                  format: binary
                inputFile4:
                  type: string
                  description: Fourth input XML file to perform the operation on.
                  format: binary
                inputFile5:
                  type: string
                  description: Fifth input XML file to perform the operation on.
                  format: binary
                inputFile6:
                  type: string
                  description: Sixth input XML file to perform the operation on.
                  format: binary
                inputFile7:
                  type: string
                  description: Seventh input XML file to perform the operation on.
                  format: binary
                inputFile8:
                  type: string
                  description: Eighth input XML file to perform the operation on.
                  format: binary
                inputFile9:
                  type: string
                  description: Ninth input XML file to perform the operation on.
                  format: binary
                inputFile10:
                  type: string
                  description: Tenth input XML file to perform the operation on.
                  format: binary
              required:
              - inputFile1
  /convert/xml/edit/xpath/set-value:
    post:
      tags:
      - ConvertData
      summary: Sets the value contents of XML nodes matching XPath expression
      description: Return the reuslts of editing an XML document by setting the contents of all of the nodes that match an input XPath expression. Supports elements and attributes.
      operationId: ConvertData_XmlEditSetValueWithXPath
      parameters:
      - name: XPathExpression
        in: header
        description: Valid XML XPath query expression
        required: true
        schema:
          type: string
      - name: XmlValue
        in: header
        description: XML Value to set into the matching XML nodes
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XmlSetValueWithXPathResult'
            text/json:
              schema:
                $ref: '#/components/schemas/XmlSetValueWithXPathResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/XmlSetValueWithXPathResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/XmlSetValueWithXPathResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: Input XML file to perform the operation on.
                  format: binary
              required:
              - inputFile
  /convert/xml/edit/xpath/replace:
    post:
      tags:
      - ConvertData
      summary: Replaces XML nodes matching XPath expression with new node
      description: Return the reuslts of editing an XML document by replacing all of the nodes that match an input XPath expression with a new XML node expression.
      operationId: ConvertData_XmlEditReplaceWithXPath
      parameters:
      - name: XPathExpression
        in: header
        description: Valid XML XPath query expression
        required: true
        schema:
          type: string
      - name: XmlNodeReplacement
        in: header
        description: XML Node replacement content
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XmlReplaceWithXPathResult'
            text/json:
              schema:
                $ref: '#/components/schemas/XmlReplaceWithXPathResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/XmlReplaceWithXPathResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/XmlReplaceWithXPathResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: Input XML file to perform the operation on.
                  format: binary
              required:
              - inputFile
  /convert/xml/edit/xpath/add-child:
    post:
      tags:
      - ConvertData
      summary: Adds an XML node as a child to XML nodes matching XPath expression
      description: Return the reuslts of editing an XML document by adding an XML node as a child to all of the nodes that match an input XPath expression.
      operationId: ConvertData_XmlEditAddChildWithXPath
      parameters:
      - name: XPathExpression
        in: header
        description: Valid XML XPath query expression
        required: true
        schema:
          type: string
      - name: XmlNodeToAdd
        in: header
        description: XML Node to add as a child
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XmlAddChildWithXPathResult'
            text/json:
              schema:
                $ref: '#/components/schemas/XmlAddChildWithXPathResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/XmlAddChildWithXPathResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/XmlAddChildWithXPathResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: Input XML file to perform the operation on.
                  format: binary
              required:
              - inputFile
  /convert/xml/edit/xpath/add-attribute:
    post:
      tags:
      - ConvertData
      summary: Adds an attribute to all XML nodes matching XPath expression
      description: Return the reuslts of editing an XML document by adding an attribute to all of the nodes that match an input XPath expression.
      operationId: ConvertData_XmlEditAddAttributeWithXPath
      parameters:
      - name: XPathExpression
        in: header
        description: Valid XML XPath query expression
        required: true
        schema:
          type: string
      - name: XmlAttributeName
        in: header
        description: Name of the XML attribute to add
        required: true
        schema:
          type: string
      - name: XmlAttributeValue
        in: header
        description: Value of the XML attribute to add
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XmlAddAttributeWithXPathResult'
            text/json:
              schema:
                $ref: '#/components/schemas/XmlAddAttributeWithXPathResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/XmlAddAttributeWithXPathResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/XmlAddAttributeWithXPathResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: Input XML file to perform the operation on.
                  format: binary
              required:
              - inputFile
  /convert/xml/edit/xpath/remove:
    post:
      tags:
      - ConvertData
      summary: Remove, delete XML nodes and items matching XPath expression
      description: Return the reuslts of editing an XML document by removing all of the nodes that match an input XPath expression
      operationId: ConvertData_XmlRemoveWithXPath
      parameters:
      - name: XPathExpression
        in: header
        description: Valid XML XPath query expression
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XmlRemoveWithXPathResult'
            text/json:
              schema:
                $ref: '#/components/schemas/XmlRemoveWithXPathResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/XmlRemoveWithXPathResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/XmlRemoveWithXPathResult'
      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
  /convert/xml/edit/xpath/remove-all-children:
    post:
      tags:
      - ConvertData
      summary: Removes, deletes all children of nodes matching XPath expression, but does not…
      description: Return the reuslts of editing an XML document by removing all child nodes of the nodes that match an input XPath expression.
      operationId: ConvertData_XmlEditRemoveAllChildNodesWithXPath
      parameters:
      - name: XPathExpression
        in: header
        description: Valid XML XPath query expression
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XmlRemoveAllChildrenWithXPathResult'
            text/json:
              schema:
                $ref: '#/components/schemas/XmlRemoveAllChildrenWithXPathResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/XmlRemoveAllChildrenWithXPathResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/XmlRemoveAllChildrenWithXPathResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: Input XML file to perform the operation on.
                  format: binary
              required:
              - inputFile
  /convert/xml/transform/xslt/to/xml:
    post:
      tags:
      - ConvertData
      summary: Transform XML document file with XSLT into a new XML document
      description: Convert an XML string or file into JSON
      operationId: ConvertData_XmlTransformWithXsltToXml
      responses:
        '200':
          description: OK
          content:
            application/xml:
              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 XML file to perform the operation on.
                  format: binary
                transformFile:
                  type: string
                  description: Input XSLT file to use to transform the input XML file.
                  format: binary
              required:
              - inputFile
              - transformFile
  /convert/json/to/xml:
    post:
      tags:
      - ConvertData
      summary: Convert JSON Object to XML conversion
      description: Convert a JSON object into XML
      operationId: ConvertData_JsonToXml
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
          text/json:
            schema:
              type: object
          application/xml:
            schema:
              type: object
          text/xml:
            schema:
              type: object
          application/x-www-form-urlencoded:
            schema:
              type: object
        description: Input JSON Object to convert to XML
        required: true
  /convert/json-string/to/xml:
    post:
      tags:
      - ConvertData
      summary: Convert JSON String to XML conversion
      description: Convert a JSON object into XML
      operationId: ConvertData_JsonStringToXml
      parameters:
      - name: JsonString
        in: query
        description: Input JSON String to convert to XML
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                type: object
      security:
      - Apikey: []
components:
  schemas:
    XmlRemoveAllChildrenWithXPathResult:
      description: Result of performing a remove all child nodes operation on XML input using XPath
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        ResultingXmlDocument:
          description: Resulting, modified XML document
          type: string
        NodesEditedCount:
          format: int32
          description: Count of the matching results
          type: integer
    XmlQueryWithXQueryResult:
      description: Result of performing an XQuery operation on an XML document.
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        ResultingXml:
          description: Resulting XML result output
          type: string
        ErrorMessage:
          description: If an error occurs, additional details on the error
          type: string
    XmlAddChildWithXPathResult:
      description: Result of performing a add child node operation on XML input using XPath
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        ResultingXmlDocument:
          description: Resulting, modified XML document
          type: string
        NodesEditedCount:
          format: int32
          description: Count of the matching results
          type: integer
    XmlQueryWithXQueryMultiResult:
      description: Result of performing an XQuery operation on multiple XML documents.
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        ResultingXml:
          description: Resulting XML result output
          type: string
        ErrorMessage:
          description: If an error occurs, additional details on the error
          type: string
    XmlFilterWithXPathResult:
      description: Result of performing a filter operation on XML input using XPath
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        XmlNodes:
          description: Matching selected XML nodes as strings
          type: array
          items:
            type: string
        ResultCount:
          format: int32
          description: Count of the matching results
          type: integer
    XmlSetValueWithXPathResult:
      description: Result of performing a set value operation on XML input using XPath
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        ResultingXmlDocument:
          description: Resulting, modified XML document
          type: string
        NodesEditedCount:
          format: int32
          description: Count of the matching results
          type: integer
    XmlReplaceWithXPathResult:
      description: Result of performing a replace node operation on XML input using XPath
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        ResultingXmlDocument:
          description: Resulting, modified XML document
          type: string
        NodesEditedCount:
          format: int32
          description: Count of the matching results
          type: integer
    XmlAddAttributeWithXPathResult:
      description: Result of performing a add attribute node operation on XML input using XPath
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        ResultingXmlDocument:
          description: Resulting, modified XML document
          type: string
        NodesEditedCount:
          format: int32
          description: Count of the matching results
          type: integer
    XmlRemoveWithXPathResult:
      description: Result of performing a filter operation on XML input using XPath
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        ResultingXmlDocument:
          description: Resulting, modified XML document with matching nodes removed as a string
          type: string
        XmlNodesRemoved:
          description: Matching selected XML nodes as strings
          type: array
          items:
            type: string
        NodesRemovedCount:
          format: int32
          description: Count of the matching results
          type: integer
  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)