Giles provides REST endpoints to specific functionality such as uploading or retrieving images. The following sections describe all so far available endpoints, their parameters, and what they return.

Add files to Giles

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.

You can add files to Giles by making a POST request to:

/rest/files/upload

You request should be made with a content-type header of:

multipart/form-data

Giles expects the following parameters:

accessToken: a github access token that is used to authenticate the uploading user
access (optional): access policy for uploaded files; possible values are PRIVATE or PUBLIC; default is PRIVATE.
document_type (optional): specifies if uploaded files are several pages of the same document (MULTI_PAGE) or if they should be uploaded as separate documents (SINGLE_PAGE); default is SINGLE_PAGE.
files: the files to be uploaded

v0.6 and newer

POST

Giles will respond with an progress id and a url to check the progress of the upload:

{
	"id":"PROGQ3Fm2J",
	"checkUrl":"http://your-giles-org.net/giles/rest/files/upload/PROGQ3Fm2J"
}

You can now poll the url provided as 'checkUrl'. As long as the upload hasn't finished yet, you will get a 202 Accepted response with the following response body:

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

Once uploading has finished, you will retrieve the complete information:

Upload Image Sample Response from Giles

[ {
  "documentId" : "DOC123edf",
  "uploadId" : "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.tiff.txt",
      "id" : "FILE789UIO",
      "url" : "http://your-giles-host.net/giles/rest/files/FILE789UIO/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.tiff.txt",
      "id" : "FILEMDSPfeVm",
      "url" : "http://your-giles-host.net/giles/rest/files/FILEMDSPfeVm/content",
      "path" : "username/UPxx456/DOC123edf/uploadedFile.pdf.1.tiff.txt",
      "content-type" : "text/plain",
      "size" : 5799
    }
  }

Uploads expire after 24 hours or after a server restart. If you request an expired upload or an upload that doesn't exist you will get a 404 response with the following response body:

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

v0.5 and older

POST

For each uploaded file, Giles responds with either "success": 0 (upload was successful), or "success": 1 (upload failed).

Upload Image Sample Response from Giles

[ {
  "documentId" : "DOCnbxbFU",
  "uploadId" : "UP50N1AV",
  "uploadedDate" : "2016-07-26T21:38:34.398Z",
  "access" : "PRIVATE",
  "files" : [ {
    "filename" : "IMG_2836.jpeg",
    "path" : "http://diging-dev.asu.edu:8081/giles-review/rest/digilib?fn=jdamerow/UP50N1AV/FILEz7JQFu/IMG_2836.jpeg",
    "content-type" : "image/jpeg",
    "size" : 120830,
    "success" : 0,
	"id" : "FILE2FGTtG"
  }, {
    "filename" : "IMG_0306.jpg",
    "path" : "http://diging-dev.asu.edu:8081/giles-review/rest/digilib?fn=jdamerow/UP50N1AV/FILETAW3KI/IMG_0306.jpg",
    "content-type" : "image/jpeg",
    "size" : 270769,
    "success" : 0,
	"id" : "FILE23rtG"
  } ]
} ]

Get image from Digilib

GET

You can get images from Digilib through Giles by making a GET request to:

/rest/digilib

Giles expects the following parameters:

accessToken: a github access token that is used to authenticate the uploading user
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

GET

You can get public images from Digilib without a GitHub access token by making a GET request to:

/rest/digilib/public

Giles expects the following parameters:

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)

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

GET

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

/rest/files/upload/{uploadId}

where {uploadId} refers to an id of a previous upload.

Giles expects the following parameters:

accessToken: a github access token that is used to authenticate the uploading user

A user has only access to upload he initiated himself.

Upload Info Sample Response from Giles

[ {
  "documentId" : "DOCDdXVqo",
  "uploadId" : "UPR8QVBL",
  "uploadedDate" : "2016-07-25T17:17:04.944Z",
  "access" : "PRIVATE",
  "files" : [ {
    "filename" : "IMG_2836.jpeg",
    "path" : "http://diging-dev.asu.edu:8081/giles-review/rest/digilib?fn=jdamerow/UPR8QVBL/FILExedxqn/IMG_2836.jpeg",
    "content-type" : "image/jpeg",
    "size" : 120830,
	"id" : "FILE23rtG"
  } ]
} ]

Get full image from Giles

GET

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: a github access token that is used to authenticate the uploading user

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.

REST API

Add files to Giles

v0.6 and newer

v0.5 and older

Get image from Digilib

Get public image from Digilib

Get info about upload

Get full image from Giles