Agnostic Guides
Solution Guide

Custom API Usage

1min

Custom API usage is typically for use when only the base Gimmal Link Enterprise API product is installed. Usage of the Gimmal Link Enterprise (S)earch (C)reate (R)ead (U)pdate (D)elete API platform within SAP is outlined in detail the Gimmal Link Enterprise Developer Guide. 

When using the SCRUD API set in a custom scenario and you have DocManager installed on your system, this section is may not relevant as you are encouraged to leverage DocManager rules to control API usage.

In the scenario you have only the base CMS API installed, you may choose to utilized the creation of Custom API Rules to house relevant config, especially the mandatory input parameters for the SCRUD API set such as CMS Profile, CMS Use Tag, Repository ID, Location, etc, allowing you to leverage a unique "Label".

You are responsible for what you use the available fields for as well the retrieval of them, as the SCRUD API set will only log itself in the Gimmal Link Enterprise API Gateway by default in terms of functionality.   

To create a Custom API Rule when DocManager is not installed, enter transaction /dflow/sys and choose the menu path Configure->API Rules->Custom.

Please also consult the Gimmal Link Enterprise Developer Guide for more information.