Add Components to Rest API

As a security measure, individual SAI360 components must be manually selected to be made available in the Rest API.

The exception to this rule is Users which will be available if the Rest API user account is assigned or inherits the security role Policy Role – Maintain Users.

If you want to ...

You need to ...

Include a Component for Rest API.

Navigate to the Component Management Form (Designer Component Management).

Open the required Component
Under the tab Rest API, select Include Component in Rest API

Navigate to Designer Configuration Management Rest API Components, and either select:

Components to ADD to Rest API (only shows components that are NOT already selected for Rest API), OR
Components to REMOVE from Rest API access (only shows components that ARE already selected for Rest API).

Trigger a Publish and the selected components will be available for the Rest API.

NOTE:

If you intend to include any "related component" in your API calls, you will have to do the same for each of these related components.

For example, if you intend to use the Rest API for Incidents, but also include Reported By and Department Responsible, you would have to mark all these components:

Incidents
Person
Department