Coreworx Web API

Coreworx Web API


Integrate your Coreworx solutions with your other existing business and project systems.

Do more with project information by integrating your Coreworx solutions with your other existing business and project systems. The Coreworx API gives developers secure access to the data within your Coreworx system, allowing them to build tools that help to reduce data duplication and errors, ensure regulatory compliance, and improve processing and planning times.

Coreworx Web API Features

Improve Data Quality & Reduce Errors

By integrating systems and sharing data between them, human errors caused from re-entering information across multiple systems is drastically reduced. Through integration, data quality is improved and less effort is required to keep all systems synchronized with the same data.

Adhere to Existing Permissions

User authentication and authorization functions ensure existing access privileges are applied when performing any services.

Extract More Value

Integration across systems gives you access to more data, which offers users a bigger view of the data picture and allows for more informed decision making in a shorter time frame.

Increase Process Efficiencies

Integrating systems that use the same content reduces the manual process required to ensure all systems are updated with the data they need. Through integration, systems can be updated automatically, reducing time needed to perform these tasks while keeping content consistent and accurate across systems.

More Web API Features

  • Retrieve, add, and update document information within the Coreworx DMS

  • Support modern interface technologies, including JSON and XML

  • Coreworx information management integrity is upheld through revision control, validation, and audit RESTful web services

  • Action filters support selection of a subset of values

  • SSL configuration is optional

  • All activities are logged in Coreworx software

  • Sample application included for guidance

  • Complete Coreworx API documentation included

How It Works

Coreworx Web API provides RESTful web services that enable integration with other systems and applications. Version 1.0 of the Coreworx API focuses on services for retrieving and updating document profiles and associated documents within the Coreworx Document Management System (DMS).

These services include:

  • Retrieve a list of projects
  • Retrieve a list of archives in a project
  • Retrieve a list of attributes in an archive
  • Retrieve a list of document profiles in an archive
  • Retrieve attribute values for a document profile
  • Add a document profile to an archive
  • Update a document profile
  • Retrieve a list of revisions from a document profile
  • Retrieve a revision from a document profile
  • Add a revision to a document profile
  • Update a revision
  • Retrieve a list of files from a document profile
  • Retrieve a file from a document profile
  • Add a file to a document profile
  • Retrieve a list of files from a document profile revision
  • Retrieve a file from a document profile revision
  • Add a file to the current document profile revision

Each request returns JSON or XML as required. Action filters let you select a subset of values.

Coreworx Web Services include user authentication and authorization features to ensure granted access privileges are applied when performing these services.

Coreworx Web API