Connectors Reference

Muhimbi PDF

Convert, Merge, Watermark, Secure and OCR files.

 

Status: Preview

Tier: Standard

Version: 9.9

 

Actions:

Name

Summary

action_task (string task_id)

 

composite_watermark (composite_watermark_data input_data)

Add composite watermark

convert (convert_data input_data)

Convert document

convert_html (convert_html_data input_data)

Convert HTML to PDF

copy_metadata (copy_metadata_data input_data)

Copy metadata (SharePoint only)

ellipse_watermark (ellipse_watermark_data input_data)

Add ellipse watermark

image_watermark (image_watermark_data input_data)

Add image watermark

line_watermark (line_watermark_data input_data)

Add line watermark

merge_to_pdf (merge_to_pdf_data input_data)

Merge documents

ocr_pdf (ocr_pdf_data input_data)

Convert to OCRed PDF

ocr_text (ocr_text_data input_data)

Extract text using OCR

ocr_text_task (string task_id)

 

pdf_watermark (pdf_watermark_data input_data)

Add PDF watermark

qr_code_watermark (qr_code_watermark_data input_data)

Add QR Code watermark

rectangle_watermark (rectangle_watermark_data input_data)

Add rectangle watermark

rtf_watermark (rtf_watermark_data input_data)

Add RTF watermark

secure_pdf (secure_pdf_data input_data)

Secure PDF

split_pdf (split_pdf_data input_data)

Split PDF

split_pdf_task (string task_id)

 

text_watermark (text_watermark_data input_data)

Add text watermark

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

composite_watermark_data

 

convert_data

 

convert_html_data

 

copy_metadata_data

 

ellipse_watermark_data

 

image_watermark_data

 

line_watermark_data

 

merge_to_pdf_data

 

ocr_operation_response

 

ocr_pdf_data

 

ocr_text_data

 

operation_response

 

operation_response_common

 

pdf_watermark_data

 

processed_files

 

qr_code_watermark_data

 

rectangle_watermark_data

 

rtf_watermark_data

 

secure_pdf_data

 

sharepoint_file

 

split_operation_response

 

split_pdf_data

 

text_watermark_data

 

 

Actions:

action_task

Summary:

Description:

 

Syntax:

MuhimbiPDF.action_task (string task_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

task_id

string

 

 

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

composite_watermark

Summary: Add composite watermark

Description: Add a complex watermark to a PDF file.

 

Syntax:

MuhimbiPDF.composite_watermark (composite_watermark_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

composite_watermark_data

 

Parameters for CompositeWatermark operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

convert

Summary: Convert document

Description: Convert a file to PDF or other format.

 

Syntax:

MuhimbiPDF.convert (convert_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

convert_data

 

Parameters for Convert operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

convert_html

Summary: Convert HTML to PDF

Description: Convert URLs or HTML to PDF.

 

Syntax:

MuhimbiPDF.convert_html (convert_html_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

convert_html_data

 

Parameters for ConvertHtml operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

copy_metadata

Summary: Copy metadata (SharePoint only)

Description: Copy metadata and set content type.

 

Syntax:

MuhimbiPDF.copy_metadata (copy_metadata_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

copy_metadata_data

 

Parameters for CopyMetadata operation

True

 

Returns:

          Type:operation_response_common

          Description: Response data for all operations

 

ellipse_watermark

Summary: Add ellipse watermark

Description: Add an ellipse watermark to a PDF file.

 

Syntax:

MuhimbiPDF.ellipse_watermark (ellipse_watermark_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

ellipse_watermark_data

 

Parameters for EllipseWatermark operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

image_watermark

Summary: Add image watermark

Description: Add an image based watermark to a PDF file.

 

Syntax:

MuhimbiPDF.image_watermark (image_watermark_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

image_watermark_data

 

Parameters for ImageWatermark operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

line_watermark

Summary: Add line watermark

Description: Add a line watermark to a PDF file.

 

Syntax:

MuhimbiPDF.line_watermark (line_watermark_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

line_watermark_data

 

Parameters for LineWatermark operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

merge_to_pdf

Summary: Merge documents

Description: Merge multiple files into a single PDF.

 

Syntax:

MuhimbiPDF.merge_to_pdf (merge_to_pdf_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

merge_to_pdf_data

 

Parameters for MergeToPdf operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

ocr_pdf

Summary: Convert to OCRed PDF

Description: Convert a file to an OCRed PDF.

 

Syntax:

MuhimbiPDF.ocr_pdf (ocr_pdf_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

ocr_pdf_data

 

Parameters for OCRText operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

ocr_text

Summary: Extract text using OCR

Description: Extract text from a file using OCR.

 

Syntax:

MuhimbiPDF.ocr_text (ocr_text_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

ocr_text_data

 

Parameters for OCRText operation

True

 

Returns:

          Type:ocr_operation_response

          Description: Response data for OCRText operation

 

ocr_text_task

Summary:

Description:

 

Syntax:

MuhimbiPDF.ocr_text_task (string task_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

task_id

string

 

 

True

 

Returns:

          Type:ocr_operation_response

          Description: Response data for OCRText operation

 

pdf_watermark

Summary: Add PDF watermark

Description: Add a PDF based watermark to a PDF file.

 

Syntax:

MuhimbiPDF.pdf_watermark (pdf_watermark_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

pdf_watermark_data

 

Parameters for PDFWatermark operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

qr_code_watermark

Summary: Add QR Code watermark

Description: Add a QR Code watermark to a PDF file.

 

Syntax:

MuhimbiPDF.qr_code_watermark (qr_code_watermark_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

qr_code_watermark_data

 

Parameters for QRCodeWatermark operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

rectangle_watermark

Summary: Add rectangle watermark

Description: Add a rectangle watermark to a PDF file.

 

Syntax:

MuhimbiPDF.rectangle_watermark (rectangle_watermark_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

rectangle_watermark_data

 

Parameters for RectangleWatermark operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

rtf_watermark

Summary: Add RTF watermark

Description: Add a rich-text watermark to a PDF file.

 

Syntax:

MuhimbiPDF.rtf_watermark (rtf_watermark_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

rtf_watermark_data

 

Parameters for RTFWatermark operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

secure_pdf

Summary: Secure PDF

Description: Apply security and encryption settings.

 

Syntax:

MuhimbiPDF.secure_pdf (secure_pdf_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

secure_pdf_data

 

Parameters for SecurePdf operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 

split_pdf

Summary: Split PDF

Description: Split a PDF file into multiple PDFs.

 

Syntax:

MuhimbiPDF.split_pdf (split_pdf_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

split_pdf_data

 

Parameters for SplitPdf operation

True

 

Returns:

          Type:split_operation_response

          Description: Response data for split operation

 

split_pdf_task

Summary:

Description:

 

Syntax:

MuhimbiPDF.split_pdf_task (string task_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

task_id

string

 

 

True

 

Returns:

          Type:split_operation_response

          Description: Response data for split operation

 

text_watermark

Summary: Add text watermark

Description: Add a plain-text watermark to a PDF file.

 

Syntax:

MuhimbiPDF.text_watermark (text_watermark_data input_data)

 

Parameters:

Name

Type

Summary

Required

Related Action

input_data

text_watermark_data

 

Parameters for TextWatermark operation

True

 

Returns:

          Type:operation_response

          Description: Response data for all operations

 


 

composite_watermark_data

Summary:

Description: Parameters for CompositeWatermark operation

 

          Properties:

Name

Type

Summary

source_file_name

string

Source file name

Optional file name (for logging purposes)

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_content

string(byte)

Source file content

Content of the file to watermark

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

watermark_data

string

Watermark data

Watermark data in Muhimbi XML format

fail_on_error

boolean

Fail on error

Fail on error


 

convert_data

Summary:

Description: Parameters for Convert operation

 

          Properties:

Name

Type

Summary

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_name

string

Source file name

Name of the source file including extension

source_file_content

string(byte)

Source file content

Content of the file to convert

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

output_format

string(enum)

Output format

Output format  Values: [PDF, XPS, DOCX, DOC, ODT, RTF, TXT, MHT, HTML, XML, XLS, XLSX, CSV, ODS, PPT, PPTX, ODP, PPS, PPSX, TIFF, PNG, GIF, JPG, BMP, PS, PCL, EPS]

copy_metadata

boolean

Copy metadata

Copy metadata (Only for SharePoint operations)

override_settings

string

Override settings

Optional settings using Muhimbi's XML syntax

template_file_content

string(byte)

Template file content

Optional template file content (e.g. infopath XSN file)

fail_on_error

boolean

Fail on error

Fail on error


 

convert_html_data

Summary:

Description: Parameters for ConvertHtml operation

 

          Properties:

Name

Type

Summary

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_url_or_html

string

Source URL or HTML

HTML fragment or URL to convert

page_orientation

string(enum)

Page orientation

Page orientation  Values: [Portrait, Landscape]

media_type

string(enum)

Media type

Media type  Values: [Screen, Print]

authentication_type

string(enum)

Authentication type

Authentication type  Values: [Anonymous, SharePoint Online, Web]

username

string

User name

User name

password

string(password)

Password

Password

viewport_size

string

Viewport size

Optional width and height of the simulated browser (e.g. 1024x768)

conversion_delay

integer(int32)

Conversion delay

Conversion delay (in milliseconds)

fail_on_error

boolean

Fail on error

Fail on error


 

copy_metadata_data

Summary:

Description: Parameters for CopyMetadata operation

 

          Properties:

Name

Type

Summary

site_url

string

Site url

SharePoint site url (example: http://contoso.sharepoint.com/sites/mysite)

source_file_url

string

Source file url

Path to the source file

destination_file_url

string

Destination file path

Path to the destination file

username

string

User name

User name to log in to the SharePoint site

password

string

Password

Password to log in to the SharePoint site

copy_fields

string

Fields to copy

Optional comma separated list of fields

content_type

string

Destination content type

Optional content type for the destination file

fail_on_error

boolean

Fail on error

Fail on error


 

ellipse_watermark_data

Summary:

Description: Parameters for EllipseWatermark operation

 

          Properties:

Name

Type

Summary

source_file_name

string

Source file name

Optional file name (for logging purposes)

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_content

string(byte)

Source file content

Content of the file to watermark

position

string(enum)

Position

Watermark position on the page  Values: [Top Left, Top Center, Top Right, Middle Left, Middle Center, Middle Right, Bottom Left, Bottom Center, Bottom Right, Absolute, Random]

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

width

string

Width

Width of the watermark (in Pts, 1/72 of an inch)

height

string

Height

Height of the watermark (in Pts, 1/72 of an inch)

x

string

X Coordinate (When 'Position' is set to 'Absolute')

X Coordinate of the watermark (in Pts, 1/72 of an inch)

y

string

Y Coordinate (When 'Position' is set to 'Absolute')

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

layer

string(enum)

Layer

Watermark layer  Values: [Background, Foreground]

rotation

string

Rotation

Angle of rotation

opacity

string

Opacity

Opacity in % (100 is fully visible and 1 is barely visible)

fill_color

string

Fill color

Color in #RRGGBB notation

line_color

string

Line color

Color in #RRGGBB notation

line_width

string

Line width

Width of the line (in Pts, 1/72 of an inch)

start_page

integer(int32)

Watermark start page

Number of the first page the watermark applies to

end_page

integer(int32)

Watermark end page

Number of the last page the watermark applies to

page_interval

integer(int32)

Watermark page interval

Which pages to display the watermark on (1=every page, 2=every other, etc)

page_orientation

string(enum)

Watermark page orientation

Orientation of pages the watermark applies to.  Values: [Portrait, Landscape, Both]

fail_on_error

boolean

Fail on error

Fail on error


 

image_watermark_data

Summary:

Description: Parameters for ImageWatermark operation

 

          Properties:

Name

Type

Summary

source_file_name

string

Source file name

Optional file name (for logging purposes)

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_content

string(byte)

Source file content

Content of the file to watermark

image_file

string(byte)

Image

Image content or URL

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

position

string(enum)

Position

Watermark position on the page  Values: [Top Left, Top Center, Top Right, Middle Left, Middle Center, Middle Right, Bottom Left, Bottom Center, Bottom Right, Absolute, Random]

width

string

Width

Width of the watermark (in Pts, 1/72 of an inch)

height

string

Height

Height of the watermark (in Pts, 1/72 of an inch)

x

string

X Coordinate (When 'Position' is set to 'Absolute')

X Coordinate of the watermark (in Pts, 1/72 of an inch)

y

string

Y Coordinate (When 'Position' is set to 'Absolute')

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

layer

string(enum)

Layer

Watermark layer  Values: [Background, Foreground]

rotation

string

Rotation

Angle of rotation

opacity

string

Opacity

Opacity in % (100 is fully visible and 1 is barely visible)

fill_color

string

Watermark background color

Color in #RRGGBB notation

line_color

string

Watermark outline color

Color in #RRGGBB notation

line_width

string

Watermark outline width

Width of the watermark outline (in Pts, 1/72 of an inch)

start_page

integer(int32)

Watermark start page

Number of the first page the watermark applies to

end_page

integer(int32)

Watermark end page

Number of the last page the watermark applies to

page_interval

integer(int32)

Watermark page interval

Which pages to display the watermark on (1=every page, 2=every other, etc)

page_orientation

string(enum)

Watermark page orientation

Orientation of pages the watermark applies to.  Values: [Portrait, Landscape, Both]

fail_on_error

boolean

Fail on error

Fail on error


 

line_watermark_data

Summary:

Description: Parameters for LineWatermark operation

 

          Properties:

Name

Type

Summary

source_file_name

string

Source file name

Optional file name (for logging purposes)

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_content

string(byte)

Source file content

Content of the file to watermark

position

string(enum)

Position

Watermark position on the page  Values: [Top Left, Top Center, Top Right, Middle Left, Middle Center, Middle Right, Bottom Left, Bottom Center, Bottom Right, Absolute, Random]

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

x

string

X Coordinate (start)

Start X Coordinate of the line (in Pts, 1/72 of an inch)

y

string

Y Coordinate (start)

Start Y Coordinate of the line (in Pts, 1/72 of an inch)

end_x

string

X Coordinate (end)

End X Coordinate of the line (in Pts, 1/72 of an inch)

end_y

string

Y Coordinate (end)

End Y Coordinate of the line (in Pts, 1/72 of an inch)

layer

string(enum)

Layer

Watermark layer  Values: [Background, Foreground]

rotation

string

Rotation

Angle of rotation

opacity

string

Opacity

Opacity in % (100 is fully visible and 1 is barely visible)

line_color

string

Line color

Color in #RRGGBB notation

line_width

string

Line width

Width of the line (in Pts, 1/72 of an inch)

start_page

integer(int32)

Watermark start page

Number of the first page the watermark applies to

end_page

integer(int32)

Watermark end page

Number of the last page the watermark applies to

page_interval

integer(int32)

Watermark page interval

Which pages to display the watermark on (1=every page, 2=every other, etc)

page_orientation

string(enum)

Watermark page orientation

Orientation of pages the watermark applies to.  Values: [Portrait, Landscape, Both]

fail_on_error

boolean

Fail on error

Fail on error


 

merge_to_pdf_data

Summary:

Description: Parameters for MergeToPdf operation

 

          Properties:

Name

Type

Summary

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_name_1

string

Source file name - 1

Name of the source file including extension

source_file_content_1

string(byte)

Source file content - 1

Content of the file to merge

source_file_name_2

string

Source file name - 2

Name of the source file including extension

source_file_content_2

string(byte)

Source file content - 2

Content of the file to merge

source_file_name_3

string

Source file name - 3

Name of the source file including extension

source_file_content_3

string(byte)

Source file content - 3

Content of the file to merge

source_file_name_4

string

Source file name - 4

Name of the source file including extension

source_file_content_4

string(byte)

Source file content - 4

Content of the file to merge

source_file_name_5

string

Source file name - 5

Name of the source file including extension

source_file_content_5

string(byte)

Source file content - 5

Content of the file to merge

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

sharepoint_field_name

string

Field name

Bookmark field name (For SharePoint only)

document_start_page

string(enum)

Each document

Document start page  Values: [Starts on the default page, Starts on the next page, Starts on the next odd page, Starts on the next even page]

fail_on_error

boolean

Fail on error

Fail on error


 

ocr_operation_response

Summary:

Description: Response data for OCRText operation

 

          Properties:

Name

Type

Summary

out_text

string

Out text

Extracted OCRed text in plain text.

base_file_name

string

Base file name

Name of the input file without the extension.

result_code

string(enum)

Result code

Operation result code.  Values: [Success, ProcessingError, SubscriptionNotFound, SubscriptionExpired, ActivationPending, TrialExpired, OperationSizeExceeded, OperationsExceeded, InputFileTypeNotSupported, OutputFileTypeNotSupported, OperationNotSupported, Accepted, AccessDenied]

result_details

string

Result details

Operation result details.


 

ocr_pdf_data

Summary:

Description: Parameters for OCRText operation

 

          Properties:

Name

Type

Summary

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_name

string

Source file name

Name of the source file including extension

source_file_content

string(byte)

Source file content

Content of the file to OCR

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

copy_metadata

boolean

MetaData

Copy metadata (For SharePoint only)

language

string(enum)

Language

Language  Values: [English, Arabic, Danish, German, Dutch, Finnish, French, Hebrew, Hungarian, Italian, Norwegian, Portuguese, Spanish, Swedish]

performance

string(enum)

Performance

Performance  Values: [Slow but accurate, Faster and less accurate, Fastest and least accurate]

characters_option

string(enum)

Blacklist / whitelist

Characters option  Values: [None, Whitelist, Blacklist]

characters

string

Characters

Characters to blacklist or whitelist

paginate

boolean

Use pagination

Paginate

regions

string

Regions

Limit the area to OCR to one or more specific areas

fail_on_error

boolean

Fail on error

Fail on error


 

ocr_text_data

Summary:

Description: Parameters for OCRText operation

 

          Properties:

Name

Type

Summary

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_name

string

Source file name

Name of the source file including extension

source_file_content

string(byte)

Source file content

Content of the file to OCR

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

language

string(enum)

Language

Languate  Values: [English, Arabic, Danish, German, Dutch, Finnish, French, Hebrew, Hungarian, Italian, Norwegian, Portuguese, Spanish, Swedish]

x

string

X Coordinate

X Coordinate (in Pts, 1/72 of an inch)

y

string

Y Coordinate

Y Coordinate (in Pts, 1/72 of an inch)

width

string

Width

Width of the OCR area (in Pts, 1/72 of an inch)

height

string

Height

Height of the OCR area (in Pts, 1/72 of an inch)

page_number

string

Page number

Page number (leave blank to OCR all pages)

performance

string(enum)

Performance

Performance ()  Values: [Slow but accurate, Faster and less accurate, Fastest and least accurate]

characters_option

string(enum)

Blacklist / whitelist

Characters option  Values: [None, Whitelist, Blacklist]

characters

string

Characters

Characters to blacklist or whitelist

paginate

boolean

Use pagination

Paginate

fail_on_error

boolean

Fail on error

Fail on error


 

operation_response

Summary:

Description: Response data for all operations

 

          Properties:

Name

Type

Summary

processed_file_content

string(byte)

Processed file content

File generated by the Muhimbi converter.

base_file_name

string

Base file name

Name of the input file without the extension.

result_code

string(enum)

Result code

Operation result code.  Values: [Success, ProcessingError, SubscriptionNotFound, SubscriptionExpired, ActivationPending, TrialExpired, OperationSizeExceeded, OperationsExceeded, InputFileTypeNotSupported, OutputFileTypeNotSupported, OperationNotSupported, Accepted, AccessDenied]

result_details

string

Result details

Operation result details.


 

operation_response_common

Summary:

Description: Response data for all operations

 

          Properties:

Name

Type

Summary

base_file_name

string

Base file name

Name of the input file without the extension.

result_code

string(enum)

Result code

Operation result code.  Values: [Success, ProcessingError, SubscriptionNotFound, SubscriptionExpired, ActivationPending, TrialExpired, OperationSizeExceeded, OperationsExceeded, InputFileTypeNotSupported, OutputFileTypeNotSupported, OperationNotSupported, Accepted, AccessDenied]

result_details

string

Result details

Operation result details.


 

pdf_watermark_data

Summary:

Description: Parameters for PDFWatermark operation

 

          Properties:

Name

Type

Summary

source_file_name

string

Source file name

Optional file name (for logging purposes)

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_content

string(byte)

Source file content

Content of the file to watermark

pdf_file

string(byte)

PDF Watermark

PDF watermark content or URL

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

position

string(enum)

Position

Watermark position on the page  Values: [Top Left, Top Center, Top Right, Middle Left, Middle Center, Middle Right, Bottom Left, Bottom Center, Bottom Right, Absolute, Random]

width

string

Width

Width of the watermark (in Pts, 1/72 of an inch)

height

string

Height

Height of the watermark (in Pts, 1/72 of an inch)

x

string

X Coordinate (When 'Position' is set to 'Absolute')

X Coordinate of the watermark (in Pts, 1/72 of an inch)

y

string

Y Coordinate (When 'Position' is set to 'Absolute')

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

layer

string(enum)

Layer

Watermark layer  Values: [Background, Foreground]

rotation

string

Rotation

Angle of rotation

opacity

string

Opacity

Opacity in % (100 is fully visible and 1 is barely visible)

start_page

integer(int32)

Watermark start page

Number of the first page the watermark applies to

end_page

integer(int32)

Watermark end page

Number of the last page the watermark applies to

page_interval

integer(int32)

Watermark page interval

Which pages to display the watermark on (1=every page, 2=every other, etc)

page_orientation

string(enum)

Watermark page orientation

Orientation of pages the watermark applies to.  Values: [Portrait, Landscape, Both]

fail_on_error

boolean

Fail on error

Fail on error


 

processed_files

Summary:

Description: Individual files

 

          Properties:

Name

Type

Summary

processed_file_name

string

Processed file name

Name of the file with the extension.

processed_file_content

string(byte)

Processed file content

File generated by the Muhimbi converter.


 

qr_code_watermark_data

Summary:

Description: Parameters for QRCodeWatermark operation

 

          Properties:

Name

Type

Summary

source_file_name

string

Source file name

Optional file name (for logging purposes)

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_content

string(byte)

Source file content

Content of the file to watermark

content

string

Content

Data to embed in the QR Code

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

version

string(enum)

Version

Version  Values: [Auto, Version 1, Version 2, Version 3, Version 4, Version 5, Version 6, Version 7, Version 8, Version 9, Version 10, Version 11, Version 12, Version 13, Version 14, Version 15, Version 16, Version 17, Version 18, Version 19, Version 20, Version 21, Version 22, Version 23, Version 24, Version 25, Version 26, Version 27, Version 28, Version 29, Version 30, Version 31, Version 32, Version 33, Version 34, Version 35, Version 36, Version 37, Version 38, Version 39, Version 40]

input_mode

string(enum)

Input mode

Input mode  Values: [Binary, Alphanumeric, Numeric]

error_correction_level

string(enum)

Error correction level

Error correction level  Values: [Low, Medium, High, Quartile]

position

string(enum)

Position

Watermark position on the page  Values: [Top Left, Top Center, Top Right, Middle Left, Middle Center, Middle Right, Bottom Left, Bottom Center, Bottom Right, Absolute, Random]

width

string

Width

Width of the watermark (in Pts, 1/72 of an inch)

height

string

Height

Height of the watermark (in Pts, 1/72 of an inch)

x

string

X Coordinate (When 'Position' is set to 'Absolute')

X Coordinate of the watermark (in Pts, 1/72 of an inch)

y

string

Y Coordinate (When 'Position' is set to 'Absolute')

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

layer

string(enum)

Layer

Watermark layer  Values: [Background, Foreground]

rotation

string

Rotation

Angle of rotation

opacity

string

Opacity

Opacity in % (100 is fully visible and 1 is barely visible)

fill_color

string

Watermark background color

Color in #RRGGBB notation

line_color

string

Watermark foreground color

Color in #RRGGBB notation

start_page

integer(int32)

Watermark start page

Number of the first page the watermark applies to

end_page

integer(int32)

Watermark end page

Number of the last page the watermark applies to

page_interval

integer(int32)

Watermark page interval

Which pages to display the watermark on (1=every page, 2=every other, etc)

page_orientation

string(enum)

Watermark page orientation

Orientation of pages the watermark applies to.  Values: [Portrait, Landscape, Both]

fail_on_error

boolean

Fail on error

Fail on error


 

rectangle_watermark_data

Summary:

Description: Parameters for RectangleWatermark operation

 

          Properties:

Name

Type

Summary

source_file_name

string

Source file name

Optional file name (for logging purposes)

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_content

string(byte)

Source file content

Content of the file to watermark

position

string(enum)

Position

Watermark position on the page  Values: [Top Left, Top Center, Top Right, Middle Left, Middle Center, Middle Right, Bottom Left, Bottom Center, Bottom Right, Absolute, Random]

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

width

string

Width

Width of the watermark (in Pts, 1/72 of an inch)

height

string

Height

Height of the watermark (in Pts, 1/72 of an inch)

x

string

X Coordinate (When 'Position' is set to 'Absolute')

X Coordinate of the watermark (in Pts, 1/72 of an inch)

y

string

Y Coordinate (When 'Position' is set to 'Absolute')

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

layer

string(enum)

Layer

Watermark layer  Values: [Background, Foreground]

rotation

string

Rotation

Angle of rotation

opacity

string

Opacity

Opacity in % (100 is fully visible and 1 is barely visible)

fill_color

string

Watermark background color

Color in #RRGGBB notation

line_color

string

Watermark outline color

Color in #RRGGBB notation

line_width

string

Watermark outline width

Width of the watermark outline (in Pts, 1/72 of an inch)

start_page

integer(int32)

Watermark start page

Number of the first page the watermark applies to

end_page

integer(int32)

Watermark end page

Number of the last page the watermark applies to

page_interval

integer(int32)

Watermark page interval

Which pages to display the watermark on (1=every page, 2=every other, etc)

page_orientation

string(enum)

Watermark page orientation

Orientation of pages the watermark applies to.  Values: [Portrait, Landscape, Both]

fail_on_error

boolean

Fail on error

Fail on error


 

rtf_watermark_data

Summary:

Description: Parameters for RTFWatermark operation

 

          Properties:

Name

Type

Summary

source_file_name

string

Source file name

Optional file name (for logging purposes)

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_content

string(byte)

Source file content

Content of the file to watermark

rtf_data

string

Watermark content

Watermark text in RTF format

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

position

string(enum)

Position

Watermark position on the page  Values: [Top Left, Top Center, Top Right, Middle Left, Middle Center, Middle Right, Bottom Left, Bottom Center, Bottom Right, Absolute, Random]

width

string

Width

Width of the watermark (in Pts, 1/72 of an inch)

height

string

Height

Height of the watermark (in Pts, 1/72 of an inch)

x

string

X Coordinate (When 'Position' is set to 'Absolute')

X Coordinate of the watermark (in Pts, 1/72 of an inch)

y

string

Y Coordinate (When 'Position' is set to 'Absolute')

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

layer

string(enum)

Layer

Watermark layer  Values: [Background, Foreground]

rotation

string

Rotation

Angle of rotation

opacity

string

Opacity

Opacity in % (100 is fully visible and 1 is barely visible)

fill_color

string

Watermark background color

Color in #RRGGBB notation

line_color

string

Watermark outline color

Color in #RRGGBB notation

line_width

string

Watermark outline width

Width of the watermark outline (in Pts, 1/72 of an inch)

start_page

integer(int32)

Watermark start page

Number of the first page the watermark applies to

end_page

integer(int32)

Watermark end page

Number of the last page the watermark applies to

page_interval

integer(int32)

Watermark page interval

Which pages to display the watermark on (1=every page, 2=every other, etc)

page_orientation

string(enum)

Watermark page orientation

Orientation of pages the watermark applies to.  Values: [Portrait, Landscape, Both]

fail_on_error

boolean

Fail on error

Fail on error


 

secure_pdf_data

Summary:

Description: Parameters for SecurePdf operation

 

          Properties:

Name

Type

Summary

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_name

string

Source file name

Optional file name (for logging purposes)

source_file_content

string(byte)

Source file content

Content of the file to secure

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

open_password

string(password)

Open password

Password required to open the PDF

owner_password

string(password)

Owner password

Password for PDF restrictions defined below

security_options

string

PDF restrictions

Print|HighResolutionPrint|ContentCopy|Annotations|FormFields|ContentAccessibility|DocumentAssembly

fail_on_error

boolean

Fail on error

Fail on error


 

sharepoint_file

Summary:

Description: SharePoint file information for operation

 

          Properties:

Name

Type

Summary

site_url

string

Site url

SharePoint site url (example: http://contoso.sharepoint.com/sites/mysite)

source_file_url

string

Source file path

Path to the source file

destination_file_url

string

Destination file path

Path to the destination file

username

string

User name

User name to log in to the SharePoint site

password

string(password)

Password

Password to log in to the SharePoint site’


 

split_operation_response

Summary:

Description: Response data for split operation

 

          Properties:

Name

Type

Summary

processed_files

array of (processed_files)

Processed files

Files generated by the Muhimbi converter.

result_code

string(enum)

Result code

Operation result code.  Values: [Success, ProcessingError, SubscriptionNotFound, SubscriptionExpired, ActivationPending, TrialExpired, OperationSizeExceeded, OperationsExceeded, InputFileTypeNotSupported, OutputFileTypeNotSupported, OperationNotSupported, Accepted, AccessDenied]

result_details

string

Result details

Operation result details.


 

split_pdf_data

Summary:

Description: Parameters for SplitPdf operation

 

          Properties:

Name

Type

Summary

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_name

string

Source file name

Name of the source file including extension

source_file_content

string(byte)

Source file content

Content of the file to split

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

file_name_template

string

File name template

File name template for returned files

file_split_by

string(enum)

Split by

Split by option  Values: [Number of Pages, Bookmark Level]

split_parameter

integer(int32)

Split parameter

Split parameter (number of pages or level)

fail_on_error

boolean

Fail on error

Fail on error


 

text_watermark_data

Summary:

Description: Parameters for TextWatermark operation

 

          Properties:

Name

Type

Summary

source_file_name

string

Source file name

Optional file name (for logging purposes)

use_async_pattern

boolean

Use async pattern

Use async behaviour for API request

source_file_content

string(byte)

Source file content

Content of the file to watermark

content

string

Watermark content

Watermark text

sharepoint_file

sharepoint_file

 

SharePoint file information for operation

font_family_name

string

Font family name

Name of the font, e.g. Arial, Times New Roman, Calibri

font_size

string

Font size

Size of the font in Pt

fill_color

string

Font color

Color in #RRGGBB notation

alignment

string(enum)

Text alignment

Text alignment  Values: [Top Left, Top Center, Top Right, Top Justfiy, Middle Left, Middle Center, Middle Right, Middle Justfiy, Bottom Left, Bottom Center, Bottom Right, Bottom Justfiy]

word_wrap

string(enum)

Word wrap

Spcifies if wordwrap text  Values: [WordOnly, Character, None, Word]

position

string(enum)

Position

Watermark position on the page  Values: [Top Left, Top Center, Top Right, Middle Left, Middle Center, Middle Right, Bottom Left, Bottom Center, Bottom Right, Absolute, Random]

width

string

Width

Width of the watermark (in Pts, 1/72 of an inch)

height

string

Height

Height of the watermark (in Pts, 1/72 of an inch)

x

string

X Coordinate (When 'Position' is set to 'Absolute')

X Coordinate of the watermark (in Pts, 1/72 of an inch)

y

string

Y Coordinate (When 'Position' is set to 'Absolute')

Y Coordinate of the watermark (in Pts, 1/72 of an inch)

layer

string(enum)

Layer

Watermark layer  Values: [Background, Foreground]

rotation

string

Rotation

Angle of rotation

opacity

string

Opacity

Opacity in % (100 is fully visible and 1 is barely visible)

font_style

string

Font style

One or more styles, e.g. bold|italic|underline|strikeout

line_color

string

Font outline color

Color in #RRGGBB notation

line_width

string

Font outline width

Width of the font outline (in Pts, 1/72 of an inch)

start_page

integer(int32)

Watermark start page

Number of the first page the watermark applies to

end_page

integer(int32)

Watermark end page

Number of the last page the watermark applies to

page_interval

integer(int32)

Watermark page interval

Which pages to display the watermark on (1=every page, 2=every other, etc)

page_orientation

string(enum)

Watermark page orientation

Orientation of pages the watermark applies to.  Values: [Portrait, Landscape, Both]

fail_on_error

boolean

Fail on error

Fail on error