Qodex.ai
Qodex.ai
Introduction
Barcode Xpress API
Start a Barcode ScannerGet the status of a Barcode Scanner
Cells API
Administration
Get Health
Documents
Delete WorkbookDownload WorkbookUpload Workbook
Sessions-Document
Download Workbook
Sessions
Create a Session
Editor API
Administration
Get Health
Documents-Comments
Add Document CommentsDelete Document CommentsGet Document CommentsUpdate Document Comments
Documents-Text
Find and Replace Text (Beta)Get Document Text (Beta)
Documents
Upload DocumentClone DocumentDelete DocumentDownload Document
Sessions-Document
Download DocumentDownload Session Document
Sessions
Create a SessionDelete SessionGet Default Session ConfigurationSet Default Session Configuration
ImageGear API
Start an Image Editor ProcessGet the status of an Image Editor Process
PrizmDoc Application Services (PAS) API
Administration (Self-Hosted)
Get HealthGet InfoGet Services Connection
Document
Get Document AttributesGet Document Text
Form Definitions
Get all Form DefinitionsGet a Form DefinitionCreate a Form DefinitionDelete a Form Definition
Form Extractors
Start a Form ExtractionGet the Status/Results of a Form Extraction
Image Stamp
Get all Image StampsGet an Image Stamp
Markup Layers
Get all Markup LayersCreate a Markup LayerGet a Markup Layer RecordDelete a Markup Layer RecordUpdate a Markup Layer Record
Page
Get PageGet Page ThumbnailGet Page AttributesGet Page Tile
Viewing Package Creators (Requires the feature to be enabled)
Get a Viewing Package Creator (Requires the feature to be enabled)Create a Viewing Package Creator (Requires the feature to be enabled)Update a Viewing Package Creator (Requires the feature to be enabled)
Viewing Packages (Requires the feature to be enabled)
Get a Viewing Package (Requires the feature to be enabled)Delete a Viewing Package (Requires the feature to be enabled)Get a Viewing Package's Viewing Package Creator (Requires the feature to be enabled)
Viewing Sessions-Attachments
Get Attachments
Viewing Sessions-Content Converters
Start a Content ConversionGet the Status of a Content ConversionGet the Result of a Content Conversion
Viewing Sessions-Form Info
Get Form Info
Viewing Sessions-Markup Burner
Start a Markup BurnGet the Status of a Markup BurnGet the Result of a Markup Burn
Viewing Sessions-Search Tasks
Start a Search TaskGet a Search TaskDelete a Search Task
Viewing Sessions-Comparison (Requires a Windows Server with Microsoft Office)
Upload the Original File (This call is dependent on a .docx file not included in this collection)Get the Original File (This call is dependent on a .docx file not included in this collection)Upload the Revised File (This call is dependent on a .docx file not included in this collection)Get the Revised File (This call is dependent on a .docx file not included in this collection)
Viewing Sessions
Create a Viewing SessionUpload a File to a Viewing SessionGet the Viewing Session's Work File
PrizmDoc Server API
Administration (Self-Hosted)
Get AdminGet HealthGet InfoGet ServersUpdate Servers
Content Converters
Start a Content ConversionGet the Status of a Content Conversion
Document
Get Document TextGet Document Attributes
Markup Burner
Start a Markup BurnGet the Status/Result of a Markup Burn
Page
Get PageGet Page ThumbnailGet Page AttributesGet Page Tile
Plain Text Redactors
Create a Plain Text RedactorGet the Status of a Plain Text Redactor
Redaction Creators
Create a Redaction CreatorGet the Status of a Redaction Creator
Search Contexts
Create a Search ContextGet a Search ContextDelete a Search ContextUpload Records to a Search ContextSignal That All Records Have Been UploadedGet the Records of a Search Context
Search Tasks
Start a Search TaskGet Search Task MetadataDelete a Search TaskGet the Results of a Search Task
Viewing Session-Markup Burner
Start a Markup BurnGet the Status of a Markup BurnGet the Result of a Markup Burn
Viewing Session-Comparison (Requires a Windows Server with Microsoft Office)
Upload the Original Document (This call is dependent on a .docx file not included in this collection)Get the Original Document (This call is dependent on a .docx file not included in this collection)Upload the Revised Document (This call is dependent on a .docx file not included in this collection)Get the Revised Document (This call is dependent on a .docx file not included in this collection)Get the Revision Data (This call is dependent on a .docx file not included in this collection)
Viewing Session-Search Tasks
Start a Search Task
Viewing Session
Create a Viewing SessionGet Viewing Session MetadataGet a Viewing Session's Work File IDUpload a File to a Viewing SessionAssociate a Work File with a Viewing SessionGet the Work File Associated with a Viewing SessionDelete a Viewing Session
Work File
Create a Work FileGet a Work FileGet a Work File's Metadata
Workflows
PrizmDoc API-Create a Viewing Session
1) Create a Viewing Session
PrizmDoc API-Create a Work File
1) Create a Work File
PrizmDoc API-Burn Markup
2) Create a Work File for the Markup3) Start a Markup Burn4) Get the Status/Result of a Markup Burn5) Download the final Document
PrizmDoc API-Convert to PDF
1) Create a Work File for the Document2) Start a Content Conversion3) Get the Status of the conversion to PDF4) Download the final Document
PrizmDoc API-Selecting Pages to Keep after Conversion (This call is dependent on a .docx file not included in this collection)
1) Create a Work File for the Document2) Start a Content Conversion (Selecting Pages to Keep)3) Get the Status of the conversion to PDF4) Download the final Document
PrizmDoc API-Merging Documents Together
2) Create a Work File for the Second Document3) Start a Content Conversion4) Get the Status of the conversion to PDF5) Download the final Document
PrizmDoc API-Convert to TIFF
1) Create a Work File for the Document2) Start a Content Conversion3) Get the Status of the conversion to TIFF4) Download the final Document
PrizmDoc API-Securely Redact a PDF Document (This call is dependent on a .pdf file not included in this collection)
1) Create a Work File for the Document4) Start a Content Conversion back to PDF5) Get the Status of the conversion back to PDF6) Download the Final Document
PrizmDoc API-Create a Searchable PDF via OCR (This call is dependent on a .tif file not included in this collection)
1) Create a Work File for the Raster Document (This call is dependent on a .tif file not included in this collection)2) Start a Content Conversion3) Get the Status of the conversion to PDF4) Download the final Document
PrizmDoc API-Perform Auto-Redaction
1) Create a Work File for the Document2) Create Markup JSON from a Regex pattern3) Get the status of the Markup Creation4) Start a Markup Burn5) Get the status/result of a Markup Burn6) Download the final Document
PrizmDoc API-Extracting Text from a Document (Search Context)
1) Create a Work File for the Document2) Create a Search Context3) Get the status of the Search Context4) Get full-page text data (records)
PrizmDoc API-Searching Text of a Document (Search Tasks)
1) Create a Work File for the Document2) Create a Search Context3) Get the status of the Search Context4) Start a full-text search against a Search Context5) Get the status of the full-text search6) Get available search results
PrizmDoc API-Watermark Content for use in a Viewing Session
1) Create a Viewing Session2) Upload a File to a Viewing Session3) View the Watermark on the Document
Image Editor API-Flip Image (This call is dependent on a .png file not included in this collection)
1) Create a Work File for the Image File2) Start an Image Editor Process3) Get the Status of the Image Editor Process4) Download the Resulting Image
Image Editor API-Crop Image (This call is dependent on a .png file not included in this collection)
1) Create a Work File for the Image File2) Start an Image Editor Process3) Get the Status of the Image Editor Process4) Download the Resulting Image
Image Editor API-Resize Image (This call is dependent on a .png file not included in this collection)
1) Create a Work File for the Image File2) Start an Image Editor Process3) Get the Status of the Image Editor Process4) Download the Resulting Image
Image Editor API-Rotate Image (This call is dependent on a .png file not included in this collection)
1) Create a Work File for the Image File2) Start an Image Editor Process3) Get the Status of the Image Editor Process4) Download the Resulting Image
Image Editor API-Convert Color Space of an Image (This call is dependent on a .png file not included in this collection)
1) Create a Work File for the Image File2) Start an Image Editor Process3) Get the Status of the Image Editor Process4) Download the Resulting Image
Barcode Scanner API-Obtain Barcode Scanner Results (This call is dependent on a .png file not included in this collection)
1) Create a Work File for the Barcode Image2) Start a Barcode Scanner Process3) Get the Status and the Result of the Barcode Scanner Process
Introduction
Barcode Xpress API
Start a Barcode ScannerGet the status of a Barcode Scanner
Cells API
Administration
Get Health
Documents
Delete WorkbookDownload WorkbookUpload Workbook
Sessions-Document
Download Workbook
Sessions
Create a Session
Editor API
Administration
Get Health
Documents-Comments
Add Document CommentsDelete Document CommentsGet Document CommentsUpdate Document Comments
Documents-Text
Find and Replace Text (Beta)Get Document Text (Beta)
Documents
Upload DocumentClone DocumentDelete DocumentDownload Document
Sessions-Document
Download DocumentDownload Session Document
Sessions
Create a SessionDelete SessionGet Default Session ConfigurationSet Default Session Configuration
ImageGear API
Start an Image Editor ProcessGet the status of an Image Editor Process
PrizmDoc Application Services (PAS) API
Administration (Self-Hosted)
Get HealthGet InfoGet Services Connection
Document
Get Document AttributesGet Document Text
Form Definitions
Get all Form DefinitionsGet a Form DefinitionCreate a Form DefinitionDelete a Form Definition
Form Extractors
Start a Form ExtractionGet the Status/Results of a Form Extraction
Image Stamp
Get all Image StampsGet an Image Stamp
Markup Layers
Get all Markup LayersCreate a Markup LayerGet a Markup Layer RecordDelete a Markup Layer RecordUpdate a Markup Layer Record
Page
Get PageGet Page ThumbnailGet Page AttributesGet Page Tile
Viewing Package Creators (Requires the feature to be enabled)
Get a Viewing Package Creator (Requires the feature to be enabled)Create a Viewing Package Creator (Requires the feature to be enabled)Update a Viewing Package Creator (Requires the feature to be enabled)
Viewing Packages (Requires the feature to be enabled)
Get a Viewing Package (Requires the feature to be enabled)Delete a Viewing Package (Requires the feature to be enabled)Get a Viewing Package's Viewing Package Creator (Requires the feature to be enabled)
Viewing Sessions-Attachments
Get Attachments
Viewing Sessions-Content Converters
Start a Content ConversionGet the Status of a Content ConversionGet the Result of a Content Conversion
Viewing Sessions-Form Info
Get Form Info
Viewing Sessions-Markup Burner
Start a Markup BurnGet the Status of a Markup BurnGet the Result of a Markup Burn
Viewing Sessions-Search Tasks
Start a Search TaskGet a Search TaskDelete a Search Task
Viewing Sessions-Comparison (Requires a Windows Server with Microsoft Office)
Upload the Original File (This call is dependent on a .docx file not included in this collection)Get the Original File (This call is dependent on a .docx file not included in this collection)Upload the Revised File (This call is dependent on a .docx file not included in this collection)Get the Revised File (This call is dependent on a .docx file not included in this collection)
Viewing Sessions
Create a Viewing SessionUpload a File to a Viewing SessionGet the Viewing Session's Work File
PrizmDoc Server API
Administration (Self-Hosted)
Get AdminGet HealthGet InfoGet ServersUpdate Servers
Content Converters
Start a Content ConversionGet the Status of a Content Conversion
Document
Get Document TextGet Document Attributes
Markup Burner
Start a Markup BurnGet the Status/Result of a Markup Burn
Page
Get PageGet Page ThumbnailGet Page AttributesGet Page Tile
Plain Text Redactors
Create a Plain Text RedactorGet the Status of a Plain Text Redactor
Redaction Creators
Create a Redaction CreatorGet the Status of a Redaction Creator
Search Contexts
Create a Search ContextGet a Search ContextDelete a Search ContextUpload Records to a Search ContextSignal That All Records Have Been UploadedGet the Records of a Search Context
Search Tasks
Start a Search TaskGet Search Task MetadataDelete a Search TaskGet the Results of a Search Task
Viewing Session-Markup Burner
Start a Markup BurnGet the Status of a Markup BurnGet the Result of a Markup Burn
Viewing Session-Comparison (Requires a Windows Server with Microsoft Office)
Upload the Original Document (This call is dependent on a .docx file not included in this collection)Get the Original Document (This call is dependent on a .docx file not included in this collection)Upload the Revised Document (This call is dependent on a .docx file not included in this collection)Get the Revised Document (This call is dependent on a .docx file not included in this collection)Get the Revision Data (This call is dependent on a .docx file not included in this collection)
Viewing Session-Search Tasks
Start a Search Task
Viewing Session
Create a Viewing SessionGet Viewing Session MetadataGet a Viewing Session's Work File IDUpload a File to a Viewing SessionAssociate a Work File with a Viewing SessionGet the Work File Associated with a Viewing SessionDelete a Viewing Session
Work File
Create a Work FileGet a Work FileGet a Work File's Metadata
Workflows
PrizmDoc API-Create a Viewing Session
1) Create a Viewing Session
PrizmDoc API-Create a Work File
1) Create a Work File
PrizmDoc API-Burn Markup
2) Create a Work File for the Markup3) Start a Markup Burn4) Get the Status/Result of a Markup Burn5) Download the final Document
PrizmDoc API-Convert to PDF
1) Create a Work File for the Document2) Start a Content Conversion3) Get the Status of the conversion to PDF4) Download the final Document
PrizmDoc API-Selecting Pages to Keep after Conversion (This call is dependent on a .docx file not included in this collection)
1) Create a Work File for the Document2) Start a Content Conversion (Selecting Pages to Keep)3) Get the Status of the conversion to PDF4) Download the final Document
PrizmDoc API-Merging Documents Together
2) Create a Work File for the Second Document3) Start a Content Conversion4) Get the Status of the conversion to PDF5) Download the final Document
PrizmDoc API-Convert to TIFF
1) Create a Work File for the Document2) Start a Content Conversion3) Get the Status of the conversion to TIFF4) Download the final Document
PrizmDoc API-Securely Redact a PDF Document (This call is dependent on a .pdf file not included in this collection)
1) Create a Work File for the Document4) Start a Content Conversion back to PDF5) Get the Status of the conversion back to PDF6) Download the Final Document
PrizmDoc API-Create a Searchable PDF via OCR (This call is dependent on a .tif file not included in this collection)
1) Create a Work File for the Raster Document (This call is dependent on a .tif file not included in this collection)2) Start a Content Conversion3) Get the Status of the conversion to PDF4) Download the final Document
PrizmDoc API-Perform Auto-Redaction
1) Create a Work File for the Document2) Create Markup JSON from a Regex pattern3) Get the status of the Markup Creation4) Start a Markup Burn5) Get the status/result of a Markup Burn6) Download the final Document
PrizmDoc API-Extracting Text from a Document (Search Context)
1) Create a Work File for the Document2) Create a Search Context3) Get the status of the Search Context4) Get full-page text data (records)
PrizmDoc API-Searching Text of a Document (Search Tasks)
1) Create a Work File for the Document2) Create a Search Context3) Get the status of the Search Context4) Start a full-text search against a Search Context5) Get the status of the full-text search6) Get available search results
PrizmDoc API-Watermark Content for use in a Viewing Session
1) Create a Viewing Session2) Upload a File to a Viewing Session3) View the Watermark on the Document
Image Editor API-Flip Image (This call is dependent on a .png file not included in this collection)
1) Create a Work File for the Image File2) Start an Image Editor Process3) Get the Status of the Image Editor Process4) Download the Resulting Image
Image Editor API-Crop Image (This call is dependent on a .png file not included in this collection)
1) Create a Work File for the Image File2) Start an Image Editor Process3) Get the Status of the Image Editor Process4) Download the Resulting Image
Image Editor API-Resize Image (This call is dependent on a .png file not included in this collection)
1) Create a Work File for the Image File2) Start an Image Editor Process3) Get the Status of the Image Editor Process4) Download the Resulting Image
Image Editor API-Rotate Image (This call is dependent on a .png file not included in this collection)
1) Create a Work File for the Image File2) Start an Image Editor Process3) Get the Status of the Image Editor Process4) Download the Resulting Image
Image Editor API-Convert Color Space of an Image (This call is dependent on a .png file not included in this collection)
1) Create a Work File for the Image File2) Start an Image Editor Process3) Get the Status of the Image Editor Process4) Download the Resulting Image
Barcode Scanner API-Obtain Barcode Scanner Results (This call is dependent on a .png file not included in this collection)
1) Create a Work File for the Barcode Image2) Start a Barcode Scanner Process3) Get the Status and the Result of the Barcode Scanner Process
HomePrizmDoc Server APISearch ContextsSignal That All Records Have Been Uploaded

Signal That All Records Have Been Uploaded

POST {{prizmdoc_server_base_url}}/v2/searchContexts/{{contextId}}/completed

https://help.accusoft.com/PrizmDoc/latest/HTML/search-contexts.html#post-v2searchcontextscontextidcompleted

HEADERS

KeyDatatypeRequiredDescription
Accusoft-Affinity-Tokenstring
Previous
Upload Records to a Search Context
Next
Get the Records of a Search Context