PrizmDoc Server API
Number of APIs: 48
1. Administration (Self-Hosted) - Get Admin
GET {{prizmdoc_server_base_url}}/admin
2. Administration (Self-Hosted) - Get Health
GET {{prizmdoc_server_base_url}}/PCCIS/V1/Service/Current/Health
3. Administration (Self-Hosted) - Get Info
GET {{prizmdoc_server_base_url}}/PCCIS/V1/Service/Current/Info
4. Administration (Self-Hosted) - Get Servers
GET {{prizmdoc_server_base_url}}/PCCIS/V1/Service/Properties/Servers
NOTE: The cluster management REST API is only available if 1) you are self-hosting PrizmDoc Server and 2) you have clustering enabled. If you are using PrizmDoc Cloud, or if you are self-hosting in single-server mode, the URLs discussed in this page will not be available.
5. Administration (Self-Hosted) - Update Servers
PUT {{prizmdoc_server_base_url}}/PCCIS/V1/Service/Properties/Servers
NOTE: The cluster management REST API is only available if 1) you are self-hosting PrizmDoc Server and 2) you have clustering enabled. If you are using PrizmDoc Cloud, or if you are self-hosting in single-server mode, the URLs discussed in this page will not be available.
6. Content Converters - Start a Content Conversion
POST {{prizmdoc_server_base_url}}/v2/contentConverters
7. Content Converters - Get the Status of a Content Conversion
GET {{prizmdoc_server_base_url}}/v2/contentConverters/{{processId}}
8. Document - Get Document Text
GET {{prizmdoc_server_base_url}}/PCCIS/V1/Document/q/{{pageStart}}-{{pageEnd}}/Text?DocumentID=u{{viewingSessionId}}
9. Document - Get Document Attributes
GET {{prizmdoc_server_base_url}}/PCCIS/V1/Document/q/Attributes?DocumentID=u{{viewingSessionId}}
10. Markup Burner - Start a Markup Burn
POST {{prizmdoc_server_base_url}}/PCCIS/V1/MarkupBurner
11. Markup Burner - Get the Status/Result of a Markup Burn
GET {{prizmdoc_server_base_url}}/PCCIS/V1/MarkupBurner/{{processId}}
12. Page - Get Page
GET {{prizmdoc_server_base_url}}/PCCIS/V1/Page/q/{{pageNumber}}?DocumentID=u{{viewingSessionId}}&ContentType={{contentType}}
13. Page - Get Page Thumbnail
GET {{prizmdoc_server_base_url}}/PCCIS/V1/Page/q/{{pageNumber}}/{{width}}x{{height}}?DocumentID=u{{viewingSessionId}}
14. Page - Get Page Attributes
GET {{prizmdoc_server_base_url}}/PCCIS/V1/Page/q/{{pageNumber}}/Attributes?DocumentID=u{{viewingSessionId}}&ContentType={{contentType}}
15. Page - Get Page Tile
GET {{prizmdoc_server_base_url}}/PCCIS/V1/Page/q/{{pageNumber}}/Tile/{{x}}/{{y}}/{{width}}/{{height}}?DocumentID=u{{viewingSessionId}}
16. Plain Text Redactors - Create a Plain Text Redactor
POST {{prizmdoc_server_base_url}}/v2/plainTextRedactors
17. Plain Text Redactors - Get the Status of a Plain Text Redactor
GET {{prizmdoc_server_base_url}}/v2/plainTextRedactors/{{processId}}
18. Redaction Creators - Create a Redaction Creator
POST {{prizmdoc_server_base_url}}/v2/redactionCreators
19. Redaction Creators - Get the Status of a Redaction Creator
GET {{prizmdoc_server_base_url}}/v2/redactionCreators/{{processId}}
20. Search Contexts - Create a Search Context
POST {{prizmdoc_server_base_url}}/v2/searchContexts
21. Search Contexts - Get a Search Context
GET {{prizmdoc_server_base_url}}/v2/searchContexts/{{contextId}}
22. Search Contexts - Delete a Search Context
DELETE {{prizmdoc_server_base_url}}/v2/searchContexts/{{contextId}}
https://help.accusoft.com/PrizmDoc/latest/HTML/search-contexts.html#delete-v2searchcontextscontextid
23. Search Contexts - Upload Records to a Search Context
PUT {{prizmdoc_server_base_url}}/v2/searchContexts/{{contextId}}/records
24. Search Contexts - Signal That All Records Have Been Uploaded
POST {{prizmdoc_server_base_url}}/v2/searchContexts/{{contextId}}/completed
25. Search Contexts - Get the Records of a Search Context
GET {{prizmdoc_server_base_url}}/v2/searchContexts/{{contextId}}/records?pages={{startPage}}-{{endPage}}
26. Search Tasks - Start a Search Task
POST {{prizmdoc_server_base_url}}/v2/searchTasks
27. Search Tasks - Get Search Task Metadata
GET {{prizmdoc_server_base_url}}/v2/searchTasks/{{processId}}
28. Search Tasks - Delete a Search Task
DELETE {{prizmdoc_server_base_url}}/v2/searchTasks/{{processId}}
29. Search Tasks - Get the Results of a Search Task
GET {{prizmdoc_server_base_url}}/v2/searchTasks/{{processId}}/results
30. Viewing Session-Markup Burner - Start a Markup Burn
POST {{prizmdoc_server_base_url}}/PCCIS/V1/ViewingSession/u{{viewingSessionId}}/MarkupBurner
31. Viewing Session-Markup Burner - Get the Status of a Markup Burn
GET {{prizmdoc_server_base_url}}/PCCIS/V1/ViewingSession/u{{viewingSessionId}}/MarkupBurner/{{processId}}
32. Viewing Session-Markup Burner - Get the Result of a Markup Burn
GET {{prizmdoc_server_base_url}}/PCCIS/V1/ViewingSession/u{{viewingSessionId}}/MarkupBurner/{{processId}}/Document
33. 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)
PUT {{prizmdoc_server_base_url}}/v2/viewingSessions/{{viewingSessionId}}/sourceFile/original
34. Viewing Session-Comparison (Requires a Windows Server with Microsoft Office) - Get the Original Document (This call is dependent on a .docx file not included in this collection)
GET {{prizmdoc_server_base_url}}/v2/viewingSessions/{{viewingSessionId}}/sourceFile/original?contentDispositionFilename={{documentDisplayName}}
35. Viewing Session-Comparison (Requires a Windows Server with Microsoft Office) - Upload the Revised Document (This call is dependent on a .docx file not included in this collection)
PUT {{prizmdoc_server_base_url}}/v2/viewingSessions/{{viewingSessionId}}/sourceFile/revised
36. Viewing Session-Comparison (Requires a Windows Server with Microsoft Office) - Get the Revised Document (This call is dependent on a .docx file not included in this collection)
GET {{prizmdoc_server_base_url}}/v2/viewingSessions/{{viewingSessionId}}/sourceFile/revised?contentDispositionFilename={{documentDisplayName}}
37. Viewing Session-Comparison (Requires a Windows Server with Microsoft Office) - Get the Revision Data (This call is dependent on a .docx file not included in this collection)
GET {{prizmdoc_server_base_url}}/v2/viewingSessions/{{viewingSessionId}}/revisionData?continueToken={{continueToken}}
38. Viewing Session-Search Tasks - Start a Search Task
POST {{prizmdoc_server_base_url}}/v2/searchTasks
39. Viewing Session - 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
40. Viewing Session - Get Viewing Session Metadata
GET {{prizmdoc_server_base_url}}/PCCIS/V1/ViewingSession/u{{viewingSessionId}}
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.
41. Viewing Session - Get a Viewing Session's Work File ID
GET {{prizmdoc_server_base_url}}/PCCIS/V1/ViewingSession/u{{viewingSessionId}}/FileId
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.
42. Viewing Session - Upload a File to a Viewing Session
PUT {{prizmdoc_server_base_url}}/PCCIS/V1/ViewingSession/u{{viewingSessionId}}/SourceFile?FileExtension={{fileExtension}}
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.
43. Viewing Session - Associate a Work File with a Viewing Session
PUT {{prizmdoc_server_base_url}}/PCCIS/V1/ViewingSession/u{{viewingSessionId}}/SourceRef
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.
44. Viewing Session - Get the Work File Associated with a Viewing Session
GET {{prizmdoc_server_base_url}}/PCCIS/V1/ViewingSession/u{{viewingSessionId}}/SourceFile?ContentDispositionFilename={{documentDisplayName}}
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.
45. Viewing Session - Delete a Viewing Session
DELETE {{prizmdoc_server_base_url}}/PCCIS/V1/ViewingSession/u{{viewingSessionId}}
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.
46. Work File - Create a Work File
POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}
47. Work File - Get a Work File
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}?ContentDispositionFilename={{documentDisplayName}}
48. Work File - Get a Work File's Metadata
GET {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile/{{fileId}}/Info
ENDPOINTS