Pdf

post/Api/Pdf/AddMarks

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /Api/Pdf/AddMarks
  • Auth: none declared

Request body

abortIfSignedboolean
measurementUnits'Centimeters' | 'PdfPoints'
forceBlobResultboolean
preserveSignaturesVisualRepresentationboolean

Example request

{
  "file": {
    "mimeType": "mimeType",
    "content": "content",
    "url": "url",
    "blobToken": "blobToken"
  },
  "preserveSignaturesVisualRepresentation": true,
  "forceBlobResult": true,
  "pageOptimization": {
    "pageOrientation": "Auto",
    "customPaperSize": {
      "width": 4.145608029883936,
      "height": 2.027123023002322
    },
    "paperSize": "Custom"
  },
  "marks": [
    {
      "container": {
        "top": 1.4658129805029452,
        "left": 6.027456183070403,
        "bottom": 5.637376656633329,
        "width": 2.3021358869347655,
        "right": 5.962133916683182,
        "height": 7.061401241503109
      },
      "borderColor": {
        "red": 1,
        "green": 1,
        "blue": 6,
        "alpha": 7.457744773683766
      },
      "backgroundColor": {
        "red": 1,
        "green": 1,
        "blue": 6,
        "alpha": 7.457744773683766
      },
      "pageOptionNumber": 9,
      "borderWidth": 1.2315135367772556,
      "elements": [
        {
          "image": {
            "resource": {
              "mimeType": "mimeType",
              "url": "url",
              "content": "content"
            },
            "opacity": 5.025004791520295
          },
          "verticalAlign": null,
          "qrCodeData": "qrCodeData",
          "qrCodeDrawQuietZones": true,
          "rotation": 1,
          "textSections": [
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            },
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            }
          ],
          "relativeContainer": {
            "top": 1.4658129805029452,
            "left": 6.027456183070403,
            "bottom": 5.637376656633329,
            "width": 2.3021358869347655,
            "right": 5.962133916683182,
            "height": 7.061401241503109
          },
          "align": null,
          "opacity": 9.965781217890562,
          "elementType": "Text"
        },
        {
          "image": {
            "resource": {
              "mimeType": "mimeType",
              "url": "url",
              "content": "content"
            },
            "opacity": 5.025004791520295
          },
          "verticalAlign": null,
          "qrCodeData": "qrCodeData",
          "qrCodeDrawQuietZones": true,
          "rotation": 1,
          "textSections": [
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            },
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            }
          ],
          "relativeContainer": {
            "top": 1.4658129805029452,
            "left": 6.027456183070403,
            "bottom": 5.637376656633329,
            "width": 2.3021358869347655,
            "right": 5.962133916683182,
            "height": 7.061401241503109
          },
          "align": null,
          "opacity": 9.965781217890562,
          "elementType": "Text"
        }
      ],
      "pageOption": "AllPages"
    },
    {
      "container": {
        "top": 1.4658129805029452,
        "left": 6.027456183070403,
        "bottom": 5.637376656633329,
        "width": 2.3021358869347655,
        "right": 5.962133916683182,
        "height": 7.061401241503109
      },
      "borderColor": {
        "red": 1,
        "green": 1,
        "blue": 6,
        "alpha": 7.457744773683766
      },
      "backgroundColor": {
        "red": 1,
        "green": 1,
        "blue": 6,
        "alpha": 7.457744773683766
      },
      "pageOptionNumber": 9,
      "borderWidth": 1.2315135367772556,
      "elements": [
        {
          "image": {
            "resource": {
              "mimeType": "mimeType",
              "url": "url",
              "content": "content"
            },
            "opacity": 5.025004791520295
          },
          "verticalAlign": null,
          "qrCodeData": "qrCodeData",
          "qrCodeDrawQuietZones": true,
          "rotation": 1,
          "textSections": [
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            },
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            }
          ],
          "relativeContainer": {
            "top": 1.4658129805029452,
            "left": 6.027456183070403,
            "bottom": 5.637376656633329,
            "width": 2.3021358869347655,
            "right": 5.962133916683182,
            "height": 7.061401241503109
          },
          "align": null,
          "opacity": 9.965781217890562,
          "elementType": "Text"
        },
        {
          "image": {
            "resource": {
              "mimeType": "mimeType",
              "url": "url",
              "content": "content"
            },
            "opacity": 5.025004791520295
          },
          "verticalAlign": null,
          "qrCodeData": "qrCodeData",
          "qrCodeDrawQuietZones": true,
          "rotation": 1,
          "textSections": [
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            },
            {
              "color": {
                "red": 1,
                "green": 1,
                "blue": 6,
                "alpha": 7.457744773683766
              },
              "style": "Normal",
              "fontSize": 4.965218492984954,
              "text": "text"
            }
          ],
          "relativeContainer": {
            "top": 1.4658129805029452,
            "left": 6.027456183070403,
            "bottom": 5.637376656633329,
            "width": 2.3021358869347655,
            "right": 5.962133916683182,
            "height": 7.061401241503109
          },
          "align": null,
          "opacity": 9.965781217890562,
          "elementType": "Text"
        }
      ],
      "pageOption": "AllPages"
    }
  ],
  "abortIfSigned": true,
  "measurementUnits": "Centimeters"
}

Response

Success

Example response

{
  "file": {
    "mimeType": "mimeType",
    "content": "content",
    "url": "url",
    "blobToken": "blobToken"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.