Proarc Web API

Actions

• Retrieve a list of documents based on specified criteria
• Create new documents or update document metadata
• Create new revisions
• Modify a revision, set revision status, etc.
• Import files to a document
• Retrieve files from a document
• Check-out and check-in files
• Create users or modify users 
• Add users to groups or assign permissions
• Create or modify contact persons
• Add or modify values in look-up tables, such as projects
• Create workflows

• Retrieve workflow activities
• Modify planning data
• Retrieve progress on documents
• Each request returns JSON or XML as required
• Action filters let you select a subset of values
  
  

Security

• For each integration, a security token is issued based on a Client ID and a secret
• Authentication and authorization for the Client ID are managed by the same protocols for Proarc users 

Logging

• Activity is logged in the same way as the action would be logged if they were performed using the Proarc EDMS
• When the Web API receives a security token, it records the user log in audit event
   

Sample Application

Proarc includes a sample application that uses a range of methods to illustrate functionality and provide guidance to application developers.

Documentation

Complete API reference documentation with information about methods, parameters, error conditions, and JSON response descriptions.