Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Status
colourBlue
titlev0.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.txt.0species.tiffcsv",
      "id" : "FILEgwyK2KjEiniN",  "id": "FILEZGpnr7Keocfh",
        "url": "http://your.host/giles/rest/files/FILEZGpnr7Keocfh/content",
        "path": "other/youruser/UP0GCnEZg9l02y/DOCGS1PfODiKbcx/your-file.pdf.txt.species.csv",
        "content-type": "text/csv",
        "size": 237,
        "processor": "carolus"
     }
    ],
  "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
    },
    "ocr" : {
      "filename" : "your-file.pdf.0.tiff.txt",
      "id" : "FILEu3zp4FHaN567",
      "url" : "https://your.host/giles/rest/files/FILEu3zp4FHaN567/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.0.tiff.txt",
      "content-type" : "text/plain",
      "size" : 3461
    }
	"additionalFiles": [
      {
         "filename": "your-file.pdf.0.tiff.txt.species.csv",
         "id": "FILE9K9XJuIrN28X",
         "url" : "httpshttp://your.host/giles/rest/digilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.0.tiff",files/FILE9K9XJuIrN28X/content",
         "path" : "other/youruser/UPMDG2ddX4bDKkUP0GCnEZg9l02y/DOCOhcqLGMXL8dCDOCGS1PfODiKbcx/your-file.pdf.0.tiff"tiff.txt.species.csv",
         "content-type": "text/csv",
         "size": 25,
      "content-type"    "processor": "image/tiffcarolus",
      }
"size" : 1938832  ]
  }, {
    "nr" : 1,
    "textimage" : {
      "filename" : "your-file.pdf.01.txttiff",
      "id" : "FILEu3zp4FHaNBEzFILE1vgFj8feXHtG",
      "url" : "https://your.host/giles/rest/files/FILEu3zp4FHaNBEz/contentdigilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.1.tiff",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.01.txttiff",
      "content-type" : "textimage/plaintiff",
      "size" : 34611938382
    },
    "ocrtext" : {
      "filename" : "your-file.pdf.0.tiff1.txt",
      "id" : "FILEu3zp4FHaN567FILER0t8JQ1WuU94",
      "url" : "https://your.host/giles/rest/files/FILEu3zp4FHaN567FILER0t8JQ1WuU94/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.0.tiff1.txt",
      "content-type" : "text/plain",
      "size" : 34613930
    }
  }, {
    "nr" : 1,
    "imageocr" : {
      "filename" : "your-file.pdf.1.tiff.txt",
      "id" : "FILE1vgFj8feXHtGFILER123JQ1WuU94",
      "url" : "https://your.host/giles/rest/digilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.1.tiff/files/FILER123JQ1WuU94/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.1.tiff.txt",
      "content-type" : "imagetext/tiffplain",
      "size" : 19383823930
    },
	"additionalFiles": [
  "text"   : {
         "filename" : "your-file.pdf.1.tiff.txt.species.csv",
         "id" : "FILER0t8JQ1WuU94",FILE9K9XJuIrN890",
         "url" : "httpshttp://your.host/giles/rest/files/FILER0t8JQ1WuU94FILE9K9XJuIrN890/content",
         "path" : "other/youruser/UPMDG2ddX4bDKkUP0GCnEZg9l02y/DOCOhcqLGMXL8dCDOCGS1PfODiKbcx/your-file.pdf.1.tiff.txt.species.csv",
         "content-type" : "text/plaincsv",
         "size": 23,
         "processor": 3930 "carolus"
      }
    ]
  }, {
   "ocr "nr" : 2,
    "image" : {
      "filename" : "your-file.pdf.12.tiff.txt",
      "id" : "FILER123JQ1WuU94FILEzQaVarnXZy52",
      "url" : "https://your.host/giles/rest/files/FILER123JQ1WuU94/contentdigilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.2.tiff",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.12.tiff.txt",
      "content-type" : "textimage/plaintiff",
      "size" : 39301809905
    }
  }, {
    "nrtext" : 2,
    "image" : {
      "filename" : "your-file.pdf.2.tifftxt",
      "id" : "FILEzQaVarnXZy52FILEFlTXtknorFua",
      "url" : "https://your.host/giles/rest/digilib?fn=youruser%2FUPMDG2ddX4bDKk%2FDOCOhcqLGMXL8dC%2Fyour-file.pdf.2.tiff/files/FILEFlTXtknorFua/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.2.tifftxt",
      "content-type" : "imagetext/tiffplain",
      "size" : 18099053563
    },
    "textocr" : {
      "filename" : "your-file.pdf.2.tiff.txt",
      "id" : "FILEFlTXtknorFuaFILEFlTXtkn345ua",
      "url" : "https://your.host/giles/rest/files/FILEFlTXtknorFuaFILEFlTXtkn345ua/content",
      "path" : "youruser/UPMDG2ddX4bDKk/DOCOhcqLGMXL8dC/your-file.pdf.2.tiff.txt",
      "content-type" : "text/plain",
      "size" : 3563
    },
	"additionalFiles": [
  "ocr"   : {
         "filename" : "your-file.pdf.2.tiff.txt.species.csv",
         "id" : "FILEFlTXtkn345uaFILE9K9XJuI78YUR",
         "url" : "httpshttp://your.host/giles/rest/files/FILEFlTXtkn345uaFILE9K9XJuI78YUR/content",
         "path" : "other/youruser/UPMDG2ddX4bDKkUP0GCnEZg9l02y/DOCOhcqLGMXL8dCDOCGS1PfODiKbcx/your-file.pdf.2.tiff.txt.species.csv",
         "content-type" : "text/plaincsv",
         "size": : 356330,
         "processor": "carolus"
      }
    ]
  }

Get full image from Giles

...