Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

name path methods description
BatchStreamSetService
  • /streamset
  • /streamset/{id}
  • /streamset/{id}/document
  • /streamset/{id}/fields
  • /streamset/{id}/utf8
  • /streamset/{id}/file/cbm
  • /streamset/{id}/file/ptb
  • /streamset/{id}/file/zip
  • PUT
  • DELETE HEAD
  • POST
  • GET POST
  • GET PUT
  • GET HEAD POST
  • GET HEAD POST
  • GET HEAD
Creation and management of batch stream sets
FieldExtractorService
  • /extractor
  • /extractor/{id}
  • /extractor/{id}/extract
  • /extractor/{id}/fields
  • /extractor/{id}/fieldtargets
  • /extractor/{id}/learn
  • /extractor/{id}/relearn
  • /extractor/{id}/usePositionalInformation
  • /extractor/{id}/utf8
  • /extractor/{id}/file/extractor
  • /extractor/{id}/streamset/{streamSetId}/learn
  • /extractor/{id}/streamset/{streamSetId}/extract/{docNum}
  • PUT
  • DELETE HEAD
  • POST
  • GET POST
  • POST
  • POST
  • POST
  • GET PUT
  • GET PUT
  • GET HEAD POST
  • GET
  • GET
Training of field extractors and extraction of fields.
LearnSetManagerService
  • /learnset/project
  • /learnset/ocr/available
  • /learnset/project/{projectId}
  • /learnset/project/{projectId}/check
  • /learnset/project/{projectId}/class
  • /learnset/project/{projectId}/classfields
  • /learnset/project/{projectId}/docs
  • /learnset/project/{projectId}/fields
  • /learnset/project/{projectId}/isLearnable
  • /learnset/project/{projectId}/learn
  • /learnset/project/{projectId}/numDocs
  • /learnset/project/{projectId}/testset
  • /learnset/project/{projectId}/updateStreamSet
  • /learnset/project/{projectId}/upload
  • /learnset/project/{projectId}/check/extraction
  • /learnset/project/{projectId}/check/fieldtargets
  • /learnset/project/{projectId}/class/{classId}
  • /learnset/project/{projectId}/fields/statistics
  • /learnset/project/{projectId}/testset/{testSetId}
  • /learnset/project/{projectId}/upload/{uploadId}
  • /learnset/project/{projectId}/class/{classId}/doc
  • /learnset/project/{projectId}/class/{classId}/fields
  • /learnset/project/{projectId}/class/{classId}/doc/{docId}
  • /learnset/project/{projectId}/class/{classId}/doc/{docId}/check
  • /learnset/project/{projectId}/class/{classId}/doc/{docId}/class
  • /learnset/project/{projectId}/class/{classId}/doc/{docId}/fields
  • /learnset/project/{projectId}/class/{classId}/doc/{docId}/image
  • /learnset/project/{projectId}/class/{classId}/doc/{docId}/meta
  • /learnset/project/{projectId}/class/{classId}/doc/{docId}/pageCnt
  • /learnset/project/{projectId}/class/{classId}/doc/{docId}/pos
  • /learnset/project/{projectId}/testset/{testSetId}/doc/{docId}/class
  • /learnset/project/{projectId}/testset/{testSetId}/doc/{docId}/extract
  • /learnset/project/{projectId}/testset/{testSetId}/doc/{docId}/image
  • /learnset/project/{projectId}/testset/{testSetId}/doc/{docId}/meta
  • /learnset/project/{projectId}/testset/{testSetId}/doc/{docId}/pos
  • /learnset/project/{projectId}/class/{classId}/doc/{docId}/check/extraction
  • /learnset/project/{projectId}/class/{classId}/doc/{docId}/check/fieldtargets
  • /learnset/project/{projectId}/class/{classId}/doc/{docId}/locations/fields
  • /learnset/project/{projectId}/class/{classId}/doc/{docId}/locations/value
  • /learnset/project/{projectId}/testset/{testSetId}/doc/{docId}/locations/value
  • GET PUT
  • GET
  • DELETE GET PUT
  • GET
  • GET PUT
  • GET
  • GET POST
  • GET POST
  • GET
  • GET
  • GET
  • POST PUT
  • HEAD
  • POST
  • GET
  • GET
  • DELETE GET PUT
  • GET
  • DELETE GET HEAD POST
  • DELETE GET
  • GET POST
  • GET POST
  • DELETE GET
  • GET
  • PUT
  • GET POST
  • GET POST
  • GET
  • GET
  • GET POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET