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. You can easily explore and test the endpoints using the Governance Services API Explorer.

You can download the API Explorer from:

  • Alfresco Nexus

    Note: Contact Alfresco Support for log in credentials. Once you’re logged in search for alfresco-governance-services-enterprise-rest-api-explorer-3.4.x.war.

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
This website uses cookies in order to offer you the most relevant information. Please accept cookies for optimal performance. This documentation is subject to the Alfresco documentation terms.