Web UI API

Get the document UUID

To obtain a UUID that will be used to load your document, you must use the following GET call:

{arender-web-ui_host}/arendergwt/openExternalDocument?url=https://arender.io/docs/demo/ARender-doc-demo.pdf

You get the UUID in response. The HTTP response must be 200 for a valid response.

Response example :

b64_dXJsPWh0dHBzOi8vYXJlbmRlci5pby9kb2NzL2RlbW8vQVJlbmRlci1kb2MtZGVtby5wZGY=

To obtain an encrypted UUID, you need the following property :

arender.documentid.generator.beanName=encryptedDocumentIdGenerator

Response example of encrypted UUID :

bXX_IRwGhKdg4ij~wR~jcpA7NssSfEETwzMM338XuQBixdQbaJtFApJV5IPGEklglZXjDcDGQck1Rog_

Generating an image

To generate a png image, use the following URL:

{arender-web-ui_host}/arendergwt/imageServlet?uuid=[UUID]&pagePosition=0&desc=IM_1632_0

Impression

To start printing from the browser, use the following URL:

{arender-web-ui_host}/arendergwt/printServlet?uuid=[UUID]&desc=IM_1200_0&imagePrintStyle=width:800px;&pages=1-19,&asPDF=true

Document layout

Description

Get the document layout

URL

{ARender_web-ui_host}/arendergwt/documentLayout?uuid=[UUID]

Request Method

• GET

Parameters

Return value

Data representing the layout in JSON format.

Example :

{
    "type":"com.arondor.viewer.client.api.document.DocumentPageLayout",
    "documentId":
    {
      "id":"b64_I2RlZmF1bHQ="
    },
    "documentTitle":"ARender.pdf",
    "mimeType":"application/pdf",
    "pageDimensionsList":
    [{
        "width":612,
        "height":792,
        "rotation":0,
        "dpi":72,
        "pageLayers":null
    },
    {
        "width":612,
        "height":792,
        "rotation":0,
        "dpi":72,
        "pageLayers":null
    }]
}

Upload

Description

• POST

Used when uploading the document. Generates the provided document in cache. Use Apache’s ServletFileUpload package to upload documents.

• GET

Check if the document is cached. Return status is 200 if cached, 404 otherwise.

URL

{ARender_web-ui_host}/arendergwt/uploadServlet?uuid=[UUID]

Request Method

• GET
• POST

Parameters

Return value

The document Id in ARender.

Download

Description

Downloads the document represented by the ID given in parameter.

URL

{ARender_web-ui_host}/arendergwt/downloadServlet?uuid=[UUID]&sourceId=[SRCID]&title=[TITLE]

Request Method

• GET

Parameters

Return value

The content of the document.

Download with compare

Description

Compares two documents passed in parameter then downloads the document representing the difference of the documents.

URL

{ARender_web-ui_host}/arendergwt/downloadServlet/mergedWithCompareResult?left=[LEFT]&right[RIGHT]

Request Method

• GET

Parameters

Return value

The content of the document representing the difference of the documents.

XFDF Annotations

Description

• GET

Retrieves document-related annotations in XFDF format.

• POST

Saves a given annotation file and associates it with the document. Use Apache’s ServletFileUpload package to upload documents.

URL

{ARender_web-ui_host}/arendergwt/servletXFDFAnnotations?uuid=[UUID]&type=[TYPE]

Request Method

• GET
• POST

Parameters

• GET

• POST

Return value

The contents of the file representing the annotations.

CSV Annotations

Description

Retrieves document-related annotations in CSV format.

URL

{ARender_web-ui_host}/arendergwt/servletCSVAnnotations?uuid=[UUID]

Request Method

• GET

Parameters

Return value

The contents of the file representing the annotations.

Weather

Description

Retrieves and displays reachability test information for addresses matching the renditions services (like the broker). Default address: http://localhost:8761/ The -1 return code means an address reachability failure.

The different addresses in the body of the request are separated by commas ‘,’.

URL

{ARender_web-ui_host}/arendergwt/weather?format=[FORM]

Request Method

• GET

Parameters

Return value

The list of tested addresses. -1.0 if address unreachable.

Health record

Retrieves and displays the accessibility information of the micro services associated with the target addresses to be tested. These target addresses can be defined by the previous call to the weather via the PUT and POST methods. Accessibility information for micro services and their associated services is displayed. Information statuses are represented by these possible values: UP, COMPLETE, NONE, PARTIAL.

Description

URL

{ARender_web-ui_host}/arendergwt/health/records

Request Method

• GET

Parameters

Return value

Accessibility information for micro services and their associated services is displayed. Return status is 200 if at least one service is available, 503 otherwise.

Download with annotations

Downloads the current document with its annotations.

Description

URL

{ARender_web-ui_host}/arendergwt/downloadDocumentWithAnnotations

Request Method

• GET

Parameters

Return value

The contents of the document as well as its annotations.

Download base 64 encoded

Description

Downloads the current document encoded in base 64.

URL

{ARender_web-ui_host}/arendergwt/downloadBase64EncodedDocument

Request Method

• GET

Parameters

No parameters.

Return value

The contents of the base 64 encoded file.

Evict

Description

Evicts the document from the ARender cache.

URL

{ARender_web-ui_host}/arendergwt/evictDocument?uuid=[UUID]

Request Method

• GET

Parameters

Return value

No Return value.