Table of Contents

Authentication

Token Authentication

For all REST endpoints, a user has to send a valid API token (see for here for a description how to get a token) to authenticate. Some endpoints can be used without a token when requesting public files. Below descriptions indicate when an endpoint can be used without a token. In general, there are two ways to send a token: as request parameter or as Authorization header (this is the recommended way).

...

Code Block
accessToken=your-api-token

Adding Data

Add files to Giles

Status

colour	Red
title	POST

In theory, you can add any file type you want to Giles. However, only file types supported by Digilib or file types that Giles knows how to convert really make sense. Currently, Giles knows how to convert PDFs to images. Giles is globally configurable in regards to what image type it uses and what DPI when converting PDFs to images (default is tiff/600 dpi). Giles will create one image per PDF page and put all images together into one folder so that you can use Digilib's paginator feature. The original PDF is stored separately outside of Digilib's image folder.

...

Code Block

language	js

{
	"msg":"Upload in progress. Please check back later.",
	"msgCode":"010"
}

Once uploading has finished, you will retrieve the complete information as listed below.

...

language	js
title	Upload Image Sample Response from Giles

...

Status


colour	Blue
title	v0.5

As of version v0.5, Giles will also supply the URL of the upload itself (see "Get info about upload" below). Keep in mind, however, that requests to this URL will return incomplete results as long as processing of a file is ongoing. Only the poll URL will indicate when processing has finished.

Once uploading has finished, you will retrieve the complete information as listed below.

Code Block

language	js
title	Upload Image Sample Response from Giles

[ {
  "documentId" : "DOC123edf",
  "uploadedDateuploadId" : "2016-"UPxx456",
  "uploadedDate" : "2016-09-20T14:03:00.152Z",
  "access" : "PRIVATE",
  "uploadedFile" : {
    "filename" : "uploadedFile.pdf",
    "id" : "FILE466tgh",
    "url" : "http://your-giles-host.net/giles/rest/files/FILE466tgh/content",
    "path" : "username/UPxx456/DOC123edf/uploadedFile.pdf",
    "content-type" : "application/pdf",
    "size" : 3852180
  },
  "extractedText" : {
    "filename" : "uploadedFile.pdf.txt",
    "id" : "FILE123cvb",
    "url" : "http://your-giles-host.net/giles/rest/files/FILE123cvb/content",
    "path" : "username/UPxx456/DOC123edf/uploadedFile.pdf.txt",
    "content-type" : "text/plain",
    "size" : 39773
  },
  "pages" : [ {
    "nr" : 0,
    "image" : {
      "filename" : "uploadedFile.pdf.0.tiff",
      "id" : "FILEYUI678",
      "url" : "http://your-giles-host.net/giles/rest/digilib?fn=username%FILEYUI678%2FDOC123edf0%2FuploadedFile.pdf.0.tiff",
      "path" : "username/UPxx456/DOC123edf/uploadedFile.pdf.0.tiff",
      "content-type" : "image/tiff",
      "size" : 2032405
    },
    "text" : {
      "filename" : "uploadedFile.pdf.0.txt",
      "id" : "FILE789UIO",
      "url" : "http://your-giles-host.net/giles/rest/files/FILE789UIO/content",
      "path" : "username/UPxx456/DOC123edf/uploadedFile.pdf.0.txt",
      "content-type" : "text/plain",
      "size" : 4658
    },
    "ocr" : {
      "filename" : "uploadedFile.pdf.0.tiff.txt",
      "id" : "FILE789U12",
      "url" : "http://your-giles-host.net/giles/rest/files/FILE789U12/content",
      "path" : "username/UPxx456/DOC123edf/uploadedFile.pdf.0.tiff.txt",
      "content-type" : "text/plain",
      "size" : 4658
    }
  }, {
    "nr" : 1,
    "image" : {
      "filename" : "uploadedFile.pdf.1.tiff",
      "id" : "FILE045tyhG",
      "url" : "http://your-giles-host.net/giles/rest/digilib?fn=username%2FFILE045tyhG%2FDOC123edf0%2FuploadedFile.pdf.1.tiff",
      "path" : "username/UPxx456/DOC123edf/uploadedFile.1.tiff",
      "content-type" : "image/tiff",
      "size" : 2512354
    },
    "text" : {
      "filename" : "uploadedFile.pdf.1.txt",
      "id" : "FILEMDSPfeVm",
      "url" : "http://your-giles-host.net/giles/rest/files/FILEMDSPfeVm/content",
      "path" : "username/UPxx456/DOC123edf/uploadedFile.pdf.1.txt",
      "content-type" : "text/plain",
      "size" : 5799
    },
    "ocr" : {
      "filename" : "uploadedFile.pdf.1.tiff.txt",
      "id" : "FILEMDSPfe12",
      "url" : "http://your-giles-host.net/giles/rest/files/FILEMDSPfe12/content",
      "path" : "username/UPxx456/DOC123edf/uploadedFile.pdf.1.tiff.txt",
      "content-type" : "text/plain",
      "size" : 5799
    }
  }

...

Code Block
{ "errorCode" : "404", "errorMsg" : "Upload does not exist." }

Retrieving Data

Get all uploads of user

Status

colour	Yellow
title	GET

...

Code Block

[
  {
    "UPMDG2ddX4bDKk": [
      {
        "id": "FILE0fPS2iO6Ev7g",
        "filename": "myfirstfile.pdf"
      }
    ]
  },
  {
    "UPVrMKIv": [
      {
        "id": "FILEkUcHBh",
        "filename": "file2.0.tiff"
      }
    ]
  },
  {
    "UP7R6GOs": [
      {
        "id": "FILEkUcHBh",
        "filename": "myfile2.tiff"
      }
    ]
  }
]

Get image from Digilib

Status

colour	Yellow
title	GET

...

accessToken: an API token that is used to authenticate the uploading user (if possible use the Authorization header instead of this parameter)
fn: path to image in digilib
dw or dh: you need at least one size parameter, either width (dw) or height (dh) or both
any other digilib parameter (optional)

Get public image from Digilib

Status

colour	Yellow
title	GET

...

If the requested image is set to public, Giles will return the image from Digilib. Otherwise, you will receive an http status 403 Forbidden.

Get info about upload

Status

colour	Yellow
title	GET

...

Code Block

language	js
title	Upload Info Sample Response from Giles

[ "documentId" : "DOCOhcqLGMXL8dC",
  "uploadId" : "UPMDG2ddX4bDKk",
  "uploadedDate" : "2016-10-04T17:40:15.254Z",
  "access" : "PUBLIC",
  "uploadedFile" : {
    "filename" : "your-file.pdf",
    "id" : "FILE0fPS2iO6Ev7g",
    "url" : "https://your.host/giles/rest/files/FILE0fPS2iO6Ev7g/content",
    "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf",
    "content-type" : "application/pdf",
    "size" : 1453836
  },
  "extractedText" : {
    "filename" : "your-file.pdf.txt",
    "id" : "FILEjXRK3MKDjcqx",
    "url" : "https://your.host/giles/rest/files/FILEjXRK3MKDjcqx/content",
    "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.txt",
    "content-type" : "text/plain",
    "size" : 84313
  },
  "pages" : [ {
    "nr" : 0,
    "image" : {
      "filename" : "your-file.pdf.0.tiff",
      "id" : "FILEgwyK2KjEiniN",
      "url" : "https://your.host/giles/rest/digilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.0.tiff",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.0.tiff",
      "content-type" : "image/tiff",
      "size" : 1938832
    },
    "text" : {
      "filename" : "your-file.pdf.0.txt",
      "id" : "FILEu3zp4FHaNBEz",
      "url" : "https://your.host/giles/rest/files/FILEu3zp4FHaNBEz/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.0.txt",
      "content-type" : "text/plain",
      "size" : 3461
    }
  }, {
    "nr" : 1,
    "image" : {
      "filename" : "your-file.pdf.1.tiff",
      "id" : "FILE1vgFj8feXHtG",
      "url" : "https://your.host/giles/rest/digilib?fn=username%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.1.tiff",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.1.tiff",
      "content-type" : "image/tiff",
      "size" : 1938382
    },
    "text" : {
      "filename" : "your-file.pdf.1.txt",
      "id" : "FILER0t8JQ1WuU94",
      "url" : "https://your.host/giles/rest/files/FILER0t8JQ1WuU94/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.1.txt",
      "content-type" : "text/plain",
      "size" : 3930
    }
  }, {
    "nr" : 2,
    "image" : {
      "filename" : "your-file.2.tiff",
      "id" : "FILEzQaVarnXZy52",
      "url" : "https://your.host/giles/rest/digilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.2.tiff",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.2.tiff",
      "content-type" : "image/tiff",
      "size" : 1809905
    },
    "text" : {
      "filename" : "your-file.pdf.2.txt",
      "id" : "FILEFlTXtknorFua",
      "url" : "https://your.host/giles/rest/files/FILEFlTXtknorFua/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.2.txt",
      "content-type" : "text/plain",
      "size" : 3563
    }
  } ]
} ]

Get info about document

Status

colour	Yellow
title	GET

Status

colour	Green
title	Public API

This endpoint can be used without an API token when requesting public files.

Status

colour	Blue
title	v0.8

Starting with version v0.8, the returned json contains lists of additional files for the uploaded document and each page (as shown in the example below). Before version v0.8, the additionalFiles sections are not included.

You can get information about a document by making a GET request to:

...

Code Block

{
  "documentId" : "DOCOhcqLGMXL8dC",
  "uploadId" : "UPMDG2ddX4bDKk",
  "uploadedDate" : "2016-10-04T17:40:15.254Z",
  "access" : "PUBLIC",
  "uploadedFile" : {
    "filename" : "your-file.pdf",
    "id" : "FILE0fPS2iO6Ev7g",
    "url" : "https://your.host/giles/rest/files/FILE0fPS2iO6Ev7g/content",
    "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf",
    "content-type" : "application/pdf",
    "size" : 1453836
  },
  "extractedText" : {
    "filename" : "your-file.pdf.txt",
    "id" : "FILEjXRK3MKDjcqx",
    "url" : "https://your.host/giles/rest/files/FILEjXRK3MKDjcqx/content",
    "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.txt",
    "content-type" : "text/plain",
    "size" : 84313
  },
  "pagesadditionalFiles" : [
{     "nr" : 0,{
        "image" : {
      "filename" : "your-file.pdf.0txt.species.tiffcsv",
        "id" : "FILEgwyK2KjEiniNFILEZGpnr7Keocfh",
        "url" : "httpshttp://your.host/giles/rest/digilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.0.tifffiles/FILEZGpnr7Keocfh/content",
        "path" : "other/youruser/UPMDG2ddX4bDKkUP0GCnEZg9l02y/DOCOhcqLGMXL8dCDOCGS1PfODiKbcx/your-file.pdf.txt.0species.tiffcsv",
        "content-type" : "imagetext/tiffcsv",
        "size" : 1938832237,
    },     "textprocessor" : "carolus"
     }
    ],
  "pages" : [ {
    "nr" : 0,
    "image" : {
      "filename" : "your-file.pdf.0.txttiff",
      "id" : "FILEu3zp4FHaNBEzFILEgwyK2KjEiniN",
      "url" : "https://your.host/giles/rest/files/FILEu3zp4FHaNBEz/contentdigilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.0.tiff",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.0.txttiff",
      "content-type" : "textimage/plaintiff",
      "size" : 34611938832
    },
    "ocrtext" : {
      "filename" : "your-file.pdf.0.tiff.txt",
      "id" : "FILEu3zp4FHaN567FILEu3zp4FHaNBEz",
      "url" : "https://your.host/giles/rest/files/FILEu3zp4FHaN567FILEu3zp4FHaNBEz/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.0.tiff.txt",
      "content-type" : "text/plain",
      "size" : 3461
    }
  }, {
    "nrocr" : 1,
    "image" : {
      "filename" : "your-file.pdf.10.tiff.txt",
      "id" : "FILE1vgFj8feXHtGFILEu3zp4FHaN567",
      "url" : "https://your.host/giles/rest/digilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.1.tifffiles/FILEu3zp4FHaN567/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.10.tiff.txt",
      "content-type" : "imagetext/tiffplain",
      "size" : 19383823461
    },
	"additionalFiles": [
    "text" : {
         "filename" : "your-file.pdf.0.1tiff.txt".species.csv",
         "id" : "FILER0t8JQ1WuU94FILE9K9XJuIrN28X",
         "url" : "httpshttp://your.host/giles/rest/files/FILER0t8JQ1WuU94FILE9K9XJuIrN28X/content",
         "path" : "other/youruser/UPMDG2ddX4bDKkUP0GCnEZg9l02y/DOCOhcqLGMXL8dCDOCGS1PfODiKbcx/your-file.pdf.10.tiff.txt.species.csv",
         "content-type" : "text/plaincsv",
         "size" : 393025,
    },     "ocrprocessor": :"carolus"
{      }
"filename" : "your-file.pdf.1.tiff.txt",  ]
  }, {
"id" : "FILER123JQ1WuU94   "nr" : 1,
    "image" : {
      "filename" : "your-file.pdf.1.tiff",
      "id" : "FILE1vgFj8feXHtG",
      "url" : "https://your.host/giles/rest/files/FILER123JQ1WuU94/contentdigilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.1.tiff",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.1.tiff.txt",
      "content-type" : "textimage/plaintiff",
      "size" : 39301938382
    }
  },
{     "nrtext" : 2,
    "image" : {
      "filename" : "your-file.pdf.21.tifftxt",
      "id" : "FILEzQaVarnXZy52FILER0t8JQ1WuU94",
      "url" : "https://your.host/giles/rest/digilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.2.tifffiles/FILER0t8JQ1WuU94/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.21.tifftxt",
      "content-type" : "imagetext/tiffplain",
      "size" : 18099053930
    },
    "textocr" : {
      "filename" : "your-file.pdf.21.tiff.txt",
      "id" : "FILEFlTXtknorFuaFILER123JQ1WuU94",
      "url" : "https://your.host/giles/rest/files/FILEFlTXtknorFuaFILER123JQ1WuU94/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.21.tiff.txt",
      "content-type" : "text/plain",
      "size" : 35633930
    },
    "ocr" 	"additionalFiles": {[
      {
         "filename" : "your-file.pdf.21.tiff.txt.species.csv",
         "id" : "FILEFlTXtkn345uaFILE9K9XJuIrN890",
         "url" : "httpshttp://your.host/giles/rest/files/FILEFlTXtkn345uaFILE9K9XJuIrN890/content",
         "path" : "other/youruser/UPMDG2ddX4bDKkUP0GCnEZg9l02y/DOCOhcqLGMXL8dCDOCGS1PfODiKbcx/your-file.pdf.21.tiff.txt.species.csv",
         "content-type" : "text/plaincsv",
         "size": 23,
         "processor": 3563"carolus"
      }
    ]
}

Change Document Access

Status

colour	Red
title	POST

Status

colour	Blue
title	v0.4.2

This features is available with version v0.4.2.

You can change the access type of a document (private or public) by making a POST request to:

/rest/documents/{documentId}/access/change

where {documentId} is the id of the document you want to change the access type.

Giles expects the following parameters:

accessToken: an API token that is used to authenticate the uploading user (if possible use the Authorization header instead of this parameter)
access: the new type of access for the specified document: private or public

Get full image from Giles

Status

colour	Yellow
title	GET

Status

colour	Green
title	Public API

This endpoint can be used without an API token when requesting public files.

You can get the original version of a file that you have uploaded through Giles by making a GET request to:

/rest/files/{fileId}/content

where {fileId} is the id of the file you are trying to download.

Giles expects the following parameters:

accessToken: an API token that is used to authenticate the uploading user (if possible use the Authorization header instead of this parameter)

...

  }, {
    "nr" : 2,
    "image" : {
      "filename" : "your-file.pdf.2.tiff",
      "id" : "FILEzQaVarnXZy52",
      "url" : "https://your.host/giles/rest/digilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.2.tiff",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.2.tiff",
      "content-type" : "image/tiff",
      "size" : 1809905
    },
    "text" : {
      "filename" : "your-file.pdf.2.txt",
      "id" : "FILEFlTXtknorFua",
      "url" : "https://your.host/giles/rest/files/FILEFlTXtknorFua/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.2.txt",
      "content-type" : "text/plain",
      "size" : 3563
    },
    "ocr" : {
      "filename" : "your-file.pdf.2.tiff.txt",
      "id" : "FILEFlTXtkn345ua",
      "url" : "https://your.host/giles/rest/files/FILEFlTXtkn345ua/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.2.tiff.txt",
      "content-type" : "text/plain",
      "size" : 3563
    },
	"additionalFiles": [
      {
         "filename": "your-file.pdf.2.tiff.txt.species.csv",
         "id": "FILE9K9XJuI78YUR",
         "url": "http://your.host/giles/rest/files/FILE9K9XJuI78YUR/content",
         "path": "other/youruser/UP0GCnEZg9l02y/DOCGS1PfODiKbcx/your-file.pdf.2.tiff.txt.species.csv",
         "content-type": "text/csv",
         "size": 30,
         "processor": "carolus"
      }
    ]
  }

Get full image from Giles

Status

colour	Yellow
title	GET

Status

colour	Green
title	Public API

This endpoint can be used without an API token when requesting public files.

You can get the original version of a file that you have uploaded through Giles by making a GET request to:

/rest/files/{fileId}/content

where {fileId} is the id of the file you are trying to download.

Giles expects the following parameters:

accessToken: an API token that is used to authenticate the uploading user (if possible use the Authorization header instead of this parameter)

Note: when requesting information about an upload, or after uploading a file, the path property of the JSON response will point here for PDF files.

Modifying Data

Change Document Access

Status

colour	Red
title	POST

Status

colour	Blue
title	v0.4.2

This features is available with version v0.4.2.

You can change the access type of a document (private or public) by making a POST request to:

/rest/documents/{documentId}/access/change

where {documentId} is the id of the document you want to change the access type.

Giles expects the following parameters:

accessToken: an API token that is used to authenticate the uploading user (if possible use the Authorization header instead of this parameter)
access: the new type of access for the specified document: private or public

Search

Search with Freddie

Status

colour	Yellow
title	GET

Status


colour	Blue
title	v0.5

Starting with version v0.5 documents submitted to Giles can be search if Freddie has been added to the ecosystem.

You can search all text documents of a user by making a GET request to:

/rest/search?q={querystring}

where {querystring} is a Solr query string.

Giles expects the following parameters:

q: the query string
accessToken: an API token that is used to authenticate the uploading user (if possible use the Authorization header instead of this parameter)

Giles will respond to a search request with a list of results, similar to:

Code Block

[{
    "id": "FILEqvXix777A6er",
    "uploadId": "UPsQY6W7CbBsl1",
    "filename": "GraceHopper.pdf.0.txt",
    "documentId": "DOC8uY40VmywRMe",
    "uploadDate": "2017-04-27T16:33:39.428Z",
    "access": "PRIVATE",
    "contentType": "text/plain",
    "size": 0,
    "url": "http://your.giles.host/giles/rest/files/FILEqvXix777A6er/content",
    "documentUrl": "http://your.giles.host/giles/rest/documents/DOC8uY40VmywRMe",
    "page": 0
  }
]

Versions Compared

Old Version 6

New Version Current

Key

Authentication

Token Authentication

Adding Data

Add files to Giles

Retrieving Data

Get all uploads of user

Get image from Digilib

Get public image from Digilib

Get info about upload

Get info about document

Change Document Access

Get full image from Giles

Get full image from Giles

Modifying Data

Change Document Access

Search

Search with Freddie

Page Comparison

Versions Compared

Old Version 6

New Version Current

Key

Authentication

Token Authentication

Adding Data

Add files to Giles

Retrieving Data

Get all uploads of user

Get image from Digilib

Get public image from Digilib

Get info about upload

Get info about document

Change Document Access

Get full image from Giles

Get full image from Giles

Modifying Data

Change Document Access

Search

Search with Freddie