You are here

Governance Services APIs

Alfresco 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 Alfresco 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 Alfresco Governance Services API Explorer. You can download the API Explorer war file from:

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

You can read more about working with Alfresco APIs in the Alfresco API Guide.

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 Alfresco Governance Services. The REST API gives you access to core functionality. You can use it to manage the Alfresco 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 Alfresco Governance Services. You can use it to manage classification guides, reasons, values, and declassification exemptions, as well as security control settings.

Sending feedback to the Alfresco documentation team

You don't appear to have JavaScript enabled in your browser. With JavaScript enabled, you can provide feedback to us using our simple form. Here are some instructions on how to enable JavaScript in your web browser.