Workflows
Number of APIs: 72
1. PrizmDoc API-Create a Viewing Session - 1) Create a Viewing Session
POST {{pas_base_url}}/ViewingSession
2. PrizmDoc API-Create a Work File - 1) Create a Work File
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
3. PrizmDoc API-Burn Markup - 2) Create a Work File for the Markup
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
4. PrizmDoc API-Burn Markup - 3) Start a Markup Burn
POST {{prizmdoc_server_base_url}}/PCCIS/V1/MarkupBurner
5. PrizmDoc API-Burn Markup - 4) Get the Status/Result of a Markup Burn
GET {{prizmdoc_server_base_url}}/PCCIS/V1/MarkupBurner/{{processId}}
6. PrizmDoc API-Burn Markup - 5) Download the final Document
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{documentFileId}}
7. PrizmDoc API-Convert to PDF - 1) Create a Work File for the Document
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
8. PrizmDoc API-Convert to PDF - 2) Start a Content Conversion
POST {{prizmdoc_server_base_url}}/v2/contentConverters
9. PrizmDoc API-Convert to PDF - 3) Get the Status of the conversion to PDF
GET {{prizmdoc_server_base_url}}/v2/contentConverters/{{processId}}
10. PrizmDoc API-Convert to PDF - 4) Download the final Document
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}
11. 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 Document
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
12. PrizmDoc API-Selecting Pages to Keep after Conversion (This call is dependent on a .docx file not included in this collection) - 2) Start a Content Conversion (Selecting Pages to Keep)
POST {{prizmdoc_server_base_url}}/v2/contentConverters
13. PrizmDoc API-Selecting Pages to Keep after Conversion (This call is dependent on a .docx file not included in this collection) - 3) Get the Status of the conversion to PDF
GET {{prizmdoc_server_base_url}}/v2/contentConverters/{{processId}}
14. PrizmDoc API-Selecting Pages to Keep after Conversion (This call is dependent on a .docx file not included in this collection) - 4) Download the final Document
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}
15. PrizmDoc API-Merging Documents Together - 2) Create a Work File for the Second Document
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
16. PrizmDoc API-Merging Documents Together - 3) Start a Content Conversion
POST {{prizmdoc_server_base_url}}/v2/contentConverters
17. PrizmDoc API-Merging Documents Together - 4) Get the Status of the conversion to PDF
GET {{prizmdoc_server_base_url}}/v2/contentConverters/{{processId}}
18. PrizmDoc API-Merging Documents Together - 5) Download the final Document
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}
19. PrizmDoc API-Convert to TIFF - 1) Create a Work File for the Document
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
20. PrizmDoc API-Convert to TIFF - 2) Start a Content Conversion
POST {{prizmdoc_server_base_url}}/v2/contentConverters
21. PrizmDoc API-Convert to TIFF - 3) Get the Status of the conversion to TIFF
GET {{prizmdoc_server_base_url}}/v2/contentConverters/{{processId}}
22. PrizmDoc API-Convert to TIFF - 4) Download the final Document
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}
23. 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 Document
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
24. PrizmDoc API-Securely Redact a PDF Document (This call is dependent on a .pdf file not included in this collection) - 4) Start a Content Conversion back to PDF
POST {{prizmdoc_server_base_url}}/v2/contentConverters
25. PrizmDoc API-Securely Redact a PDF Document (This call is dependent on a .pdf file not included in this collection) - 5) Get the Status of the conversion back to PDF
GET {{prizmdoc_server_base_url}}/v2/contentConverters/{{processId}}
26. PrizmDoc API-Securely Redact a PDF Document (This call is dependent on a .pdf file not included in this collection) - 6) Download the Final Document
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}
27. 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)
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
28. PrizmDoc API-Create a Searchable PDF via OCR (This call is dependent on a .tif file not included in this collection) - 2) Start a Content Conversion
POST {{prizmdoc_server_base_url}}/v2/contentConverters
29. PrizmDoc API-Create a Searchable PDF via OCR (This call is dependent on a .tif file not included in this collection) - 3) Get the Status of the conversion to PDF
GET {{prizmdoc_server_base_url}}/v2/contentConverters/{{processId}}
30. PrizmDoc API-Create a Searchable PDF via OCR (This call is dependent on a .tif file not included in this collection) - 4) Download the final Document
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}
31. PrizmDoc API-Perform Auto-Redaction - 1) Create a Work File for the Document
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
32. PrizmDoc API-Perform Auto-Redaction - 2) Create Markup JSON from a Regex pattern
POST {{prizmdoc_server_base_url}}/v2/redactionCreators
33. PrizmDoc API-Perform Auto-Redaction - 3) Get the status of the Markup Creation
GET {{prizmdoc_server_base_url}}/v2/redactionCreators/{{markupProcessId}}
34. PrizmDoc API-Perform Auto-Redaction - 4) Start a Markup Burn
POST {{prizmdoc_server_base_url}}/PCCIS/V1/MarkupBurner
35. PrizmDoc API-Perform Auto-Redaction - 5) Get the status/result of a Markup Burn
GET {{prizmdoc_server_base_url}}/PCCIS/V1/MarkupBurner/{{processId}}
36. PrizmDoc API-Perform Auto-Redaction - 6) Download the final Document
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{documentFileId}}
37. PrizmDoc API-Extracting Text from a Document (Search Context) - 1) Create a Work File for the Document
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
38. PrizmDoc API-Extracting Text from a Document (Search Context) - 2) Create a Search Context
POST {{prizmdoc_server_base_url}}/v2/searchContexts
39. PrizmDoc API-Extracting Text from a Document (Search Context) - 3) Get the status of the Search Context
GET {{prizmdoc_server_base_url}}/v2/searchContexts/{{contextId}}
40. PrizmDoc API-Extracting Text from a Document (Search Context) - 4) Get full-page text data (records)
GET {{prizmdoc_server_base_url}}/v2/searchContexts/{{contextId}}/records?pages=0-
41. PrizmDoc API-Searching Text of a Document (Search Tasks) - 1) Create a Work File for the Document
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
42. PrizmDoc API-Searching Text of a Document (Search Tasks) - 2) Create a Search Context
POST {{prizmdoc_server_base_url}}/v2/searchContexts
43. PrizmDoc API-Searching Text of a Document (Search Tasks) - 3) Get the status of the Search Context
GET {{prizmdoc_server_base_url}}/v2/searchContexts/{{contextId}}
44. PrizmDoc API-Searching Text of a Document (Search Tasks) - 4) Start a full-text search against a Search Context
POST {{prizmdoc_server_base_url}}/v2/searchTasks
45. PrizmDoc API-Searching Text of a Document (Search Tasks) - 5) Get the status of the full-text search
GET {{prizmdoc_server_base_url}}/v2/searchTasks/{{processId}}
46. PrizmDoc API-Searching Text of a Document (Search Tasks) - 6) Get available search results
GET {{prizmdoc_server_base_url}}/v2/searchTasks/{{processId}}/results
47. PrizmDoc API-Watermark Content for use in a Viewing Session - 1) Create a Viewing Session
POST {{prizmdoc_server_base_url}}/PCCIS/V1/ViewingSession
NOTE: The PrizmDoc Server viewing sessions REST API is used by PAS and is maintained for backwards compatibility. It should not be used for new application development. Please use the newer PAS viewing sessions REST API instead.
https://help.accusoft.com/PrizmDoc/latest/HTML/viewing-sessions.html#post-pccisv1viewingsession
48. PrizmDoc API-Watermark Content for use in a Viewing Session - 2) Upload a File to a Viewing Session
PUT {{prizmdoc_server_base_url}}/PCCIS/V1/ViewingSession/u{{viewingSessionId}}/SourceFile?FileExtension={{fileExtension}}&Accusoft-Affinity-Token={{affinityToken}}
NOTE: The PrizmDoc Server viewing sessions REST API is used by PAS and is maintained for backwards compatibility. It should not be used for new application development. Please use the newer PAS viewing sessions REST API instead.
49. PrizmDoc API-Watermark Content for use in a Viewing Session - 3) View the Watermark on the Document
GET {{pas_base_url}}/Page/q/0?DocumentID=u{{viewingSessionId}}
50. 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 File
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
51. Image Editor API-Flip Image (This call is dependent on a .png file not included in this collection) - 2) Start an Image Editor Process
POST {{imagegear_base_url}}/api/v1/imageEditors
52. Image Editor API-Flip Image (This call is dependent on a .png file not included in this collection) - 3) Get the Status of the Image Editor Process
GET {{imagegear_base_url}}/api/v1/imageEditors/{{processId}}
53. Image Editor API-Flip Image (This call is dependent on a .png file not included in this collection) - 4) Download the Resulting Image
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}
54. 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 File
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
55. Image Editor API-Crop Image (This call is dependent on a .png file not included in this collection) - 2) Start an Image Editor Process
POST {{imagegear_base_url}}/api/v1/imageEditors
56. Image Editor API-Crop Image (This call is dependent on a .png file not included in this collection) - 3) Get the Status of the Image Editor Process
GET {{imagegear_base_url}}/api/v1/imageEditors/{{processId}}
57. Image Editor API-Crop Image (This call is dependent on a .png file not included in this collection) - 4) Download the Resulting Image
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}
58. 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 File
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
59. Image Editor API-Resize Image (This call is dependent on a .png file not included in this collection) - 2) Start an Image Editor Process
POST {{imagegear_base_url}}/api/v1/imageEditors
60. Image Editor API-Resize Image (This call is dependent on a .png file not included in this collection) - 3) Get the Status of the Image Editor Process
GET {{imagegear_base_url}}/api/v1/imageEditors/{{processId}}
61. Image Editor API-Resize Image (This call is dependent on a .png file not included in this collection) - 4) Download the Resulting Image
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}
62. 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 File
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
63. Image Editor API-Rotate Image (This call is dependent on a .png file not included in this collection) - 2) Start an Image Editor Process
POST {{imagegear_base_url}}/api/v1/imageEditors
64. Image Editor API-Rotate Image (This call is dependent on a .png file not included in this collection) - 3) Get the Status of the Image Editor Process
GET {{imagegear_base_url}}/api/v1/imageEditors/{{processId}}
65. Image Editor API-Rotate Image (This call is dependent on a .png file not included in this collection) - 4) Download the Resulting Image
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}
66. 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 File
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
67. Image Editor API-Convert Color Space of an Image (This call is dependent on a .png file not included in this collection) - 2) Start an Image Editor Process
POST {{imagegear_base_url}}/api/v1/imageEditors
68. Image Editor API-Convert Color Space of an Image (This call is dependent on a .png file not included in this collection) - 3) Get the Status of the Image Editor Process
GET {{imagegear_base_url}}/api/v1/imageEditors/{{processId}}
69. Image Editor API-Convert Color Space of an Image (This call is dependent on a .png file not included in this collection) - 4) Download the Resulting Image
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}
70. 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 Image
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
71. Barcode Scanner API-Obtain Barcode Scanner Results (This call is dependent on a .png file not included in this collection) - 2) Start a Barcode Scanner Process
POST {{barcode_base_url}}/api/v1/scanners
72. Barcode Scanner API-Obtain Barcode Scanner Results (This call is dependent on a .png file not included in this collection) - 3) Get the Status and the Result of the Barcode Scanner Process
GET {{barcode_base_url}}/api/v1/scanners/{{processId}}
ENDPOINTS