Close

Governance Services APIs

Governance Services provides two APIs, the GS Core API and the GS Security Marks API.

Note: The GS Security Marks API isn’t available in Governance Services Community Edition.

The APIs are designed for you to create remote clients to manage the

File Plan
The File Plan is a container for records, folders, categories and retention schedules. It's effectively a virtual filing cabinet for storing records, and is the basic structure of Records Management. This structure lets you classify and group records with similar characteristics. The top level of the File Plan is created when you create a Records Management site.
. You can easily explore and test the endpoints using the Governance Services API Explorer.

You can download the API Explorer from:

The Governance Services distribution zip contains the alfresco-governance-services-enterprise-rest-api-explorer-23.x.x.xxx.war file.

Note: Contact Alfresco Support for log in credentials.

Deploy it on the same port as Governance Services and test the APIs with your server directly from the API Explorer.

The following table provides a brief overview of each API.

API Description
GS Core API This is the main public API for interfacing your client application with Governance Services. The REST API gives you access to core functionality. You can use it to manage the Governance Services site, record categories, record folders, unfiled containers and unfiled record folders, upload new records or declare an existing file as record, file records in the file plan and get information about transfers.
GS Security Marks API The Security Marks API gives you access to the classification and security controls features of Governance Services. You can use it to manage classification guides, reasons, values, and declassification exemptions, as well as security control settings.

Edit this page

Suggest an edit on GitHub
By clicking "Accept Cookies", you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. View Cookie Policy.