PrizmDoc Application Services (PAS) API
Number of APIs: 46
https://help.accusoft.com/PrizmDoc/latest/HTML/pas-dev-guide-overview.html
1. Administration (Self-Hosted) - Get Health
GET {{pas_base_url}}/health
NOTE: For a Kubernetes cluster, see Checking PrizmDoc Viewer Kubernetes Cluster Health.
https://help.accusoft.com/PrizmDoc/latest/HTML/health.html#get-health
2. Administration (Self-Hosted) - Get Info
GET {{pas_base_url}}/info
NOTE: We recommend using GET /health API when checking PAS health automatically.
https://help.accusoft.com/PrizmDoc/latest/HTML/health.html#get-info
3. Administration (Self-Hosted) - Get Services Connection
GET {{pas_base_url}}/servicesConnection
NOTE: A successful response only indicates whether PAS is able to communicate with PrizmDoc Server; it does not mean that PrizmDoc Server instances themselves are healthy. To check the health of PrizmDoc Server instances, use the PrizmDoc Server Health REST API.
https://help.accusoft.com/PrizmDoc/latest/HTML/health.html#get-servicesconnection
4. Document - Get Document Attributes
GET {{pas_base_url}}/Document/q/Attributes?DocumentID=u{{viewingSessionId}}
5. Document - Get Document Text
GET {{pas_base_url}}/Document/q/{{startPage}}-{{endPage}}/Text?DocumentID=u{{viewingSessionId}}
6. Form Definitions - Get all Form Definitions
GET {{pas_base_url}}/FormDefinitions
7. Form Definitions - Get a Form Definition
GET {{pas_base_url}}/FormDefinitions/{{formDefinitionId}}
8. Form Definitions - Create a Form Definition
POST {{pas_base_url}}/FormDefinitions
9. Form Definitions - Delete a Form Definition
DELETE {{pas_base_url}}/FormDefinitions/{{formDefinitionId}}
10. Form Extractors - Start a Form Extraction
POST {{pas_base_url}}/v2/viewingSessions/{{viewingSessionId}}/formExtractors
11. Form Extractors - Get the Status/Results of a Form Extraction
GET {{pas_base_url}}/v2/viewingSessions/{{viewingSessionId}}/formExtractors/{{processId}}
12. Image Stamp - Get all Image Stamps
GET {{pas_base_url}}/ImageStampList
13. Image Stamp - Get an Image Stamp
GET {{pas_base_url}}/ImageStamp/{{imageStampId}}/q?format=Base64
14. Markup Layers - Get all Markup Layers
GET {{pas_base_url}}/MarkupLayers/u{{viewingSessionId}}
15. Markup Layers - Create a Markup Layer
POST {{pas_base_url}}/MarkupLayers/u{{viewingSessionId}}
https://help.accusoft.com/PrizmDoc/latest/HTML/markup-layers.html#post-markuplayersuviewingsessionid
16. Markup Layers - Get a Markup Layer Record
GET {{pas_base_url}}/MarkupLayers/u{{viewingSessionId}}/{{layerRecordId}}
17. Markup Layers - Delete a Markup Layer Record
DELETE {{pas_base_url}}/MarkupLayers/u{{viewingSessionId}}/{{layerRecordId}}
18. Markup Layers - Update a Markup Layer Record
PUT {{pas_base_url}}/MarkupLayers/u{{viewingSessionId}}/{{layerRecordId}}
19. Page - Get Page
GET {{pas_base_url}}/Page/q/{{pageNumber}}?DocumentID=u{{viewingSessionId}}&ContentType={{contentType}}
20. Page - Get Page Thumbnail
GET {{pas_base_url}}/Page/q/{{pageNumber}}/{{width}}x{{height}}?DocumentID=u{{viewingSessionId}}
21. Page - Get Page Attributes
GET {{pas_base_url}}/Page/q/{{pageNumber}}/Attributes?DocumentID=u{{viewingSessionId}}
22. Page - Get Page Tile
GET {{pas_base_url}}/Page/q/{{pageNumber}}/Tile/{{x}}/{{y}}/{{width}}/{{height}}?DocumentID=u{{viewingSessionId}}
23. Viewing Package Creators (Requires the feature to be enabled) - Get a Viewing Package Creator (Requires the feature to be enabled)
GET {{pas_base_url}}/v2/viewingPackageCreators/{{processId}}
24. Viewing Package Creators (Requires the feature to be enabled) - Create a Viewing Package Creator (Requires the feature to be enabled)
POST {{pas_base_url}}/v2/viewingPackageCreators
25. Viewing Package Creators (Requires the feature to be enabled) - Update a Viewing Package Creator (Requires the feature to be enabled)
PUT {{pas_base_url}}/v2/viewingPackageCreators/{{processId}}/sourceFile
26. Viewing Packages (Requires the feature to be enabled) - Get a Viewing Package (Requires the feature to be enabled)
GET {{pas_base_url}}/v2/viewingPackages/{{documentId}}
27. Viewing Packages (Requires the feature to be enabled) - Delete a Viewing Package (Requires the feature to be enabled)
DELETE {{pas_base_url}}/v2/viewingPackages/{{documentId}}
28. Viewing Packages (Requires the feature to be enabled) - Get a Viewing Package's Viewing Package Creator (Requires the feature to be enabled)
GET {{pas_base_url}}/v2/viewingPackages/{{documentId}}/creator
29. Viewing Sessions-Attachments - Get Attachments
GET {{pas_base_url}}/ViewingSession/u{{viewingSessionId}}/Attachments
30. Viewing Sessions-Content Converters - Start a Content Conversion
POST {{pas_base_url}}/v2/viewingSessions/{{viewingSessionId}}/contentConverters
31. Viewing Sessions-Content Converters - Get the Status of a Content Conversion
GET {{pas_base_url}}/v2/viewingSessions/{{viewingSessionId}}/contentConverters/{{processId}}
32. Viewing Sessions-Content Converters - Get the Result of a Content Conversion
GET {{pas_base_url}}/v2/viewingSessions/{{viewingSessionId}}/contentConverters/{{processId}}/results/{{result}}/file?ContentDispositionFilename={{displayName}}
33. Viewing Sessions-Form Info - Get Form Info
GET {{pas_base_url}}/ViewingSession/u{{viewingSessionId}}/FormInfo
34. Viewing Sessions-Markup Burner - Start a Markup Burn
POST {{pas_base_url}}/ViewingSession/u{{viewingSessionId}}/MarkupBurner
35. Viewing Sessions-Markup Burner - Get the Status of a Markup Burn
GET {{pas_base_url}}/ViewingSession/u{{viewingSessionId}}/MarkupBurner/{{processId}}
36. Viewing Sessions-Markup Burner - Get the Result of a Markup Burn
GET {{pas_base_url}}/ViewingSession/u{{viewingSessionId}}/MarkupBurner/{{processId}}/Document?ContentDispositionFilename={{documentDisplayName}}
37. Viewing Sessions-Search Tasks - Start a Search Task
POST {{pas_base_url}}/v2/viewingSessions/{{viewingSessionId}}/searchTasks
38. Viewing Sessions-Search Tasks - Get a Search Task
GET {{pas_base_url}}/v2/searchTasks/{{processId}}/results?limit={{limit}}
39. Viewing Sessions-Search Tasks - Delete a Search Task
DELETE {{pas_base_url}}/v2/searchTasks/{{processId}}
40. 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)
PUT {{pas_base_url}}/v2/viewingSessions/{{viewingSessionId}}/sourceFile/original
41. Viewing Sessions-Comparison (Requires a Windows Server with Microsoft Office) - Get the Original File (This call is dependent on a .docx file not included in this collection)
GET {{pas_base_url}}/v2/viewingSessions/{{viewingSessionId}}/sourceFile/original
42. Viewing Sessions-Comparison (Requires a Windows Server with Microsoft Office) - Upload the Revised File (This call is dependent on a .docx file not included in this collection)
PUT {{pas_base_url}}/v2/viewingSessions/{{viewingSessionId}}/sourceFile/revised
43. Viewing Sessions-Comparison (Requires a Windows Server with Microsoft Office) - Get the Revised File (This call is dependent on a .docx file not included in this collection)
GET {{pas_base_url}}/v2/viewingSessions/{{viewingSessionId}}/sourceFile/revised
44. Viewing Sessions - Create a Viewing Session
POST {{pas_base_url}}/ViewingSession
45. Viewing Sessions - Upload a File to a Viewing Session
PUT {{pas_base_url}}/ViewingSession/u{{viewingSessionId}}/SourceFile
46. Viewing Sessions - Get the Viewing Session's Work File
GET {{pas_base_url}}/ViewingSession/u{{viewingSessionId}}/SourceFile?ContentDispositionFilename={{displayName}}
ENDPOINTS