Bridgeline Digital Logo
Menu

APIRequest

The APIRequest class provides the core framework for making an OrchestraCMS API call. All API requests made through Apex will return a JSON encoded string or a JSON object if made through JavaScript or via the OrchestraCMS REST API. There are four parameters, the usage requirements of which are determined by which supporting API request is made. The available OrchestraCMS API Request resources extend the APIRequest class. More information on these can be found in their respective API documentation and in the API Response documentation.

Properties

  • parameters Map<String, String>, Map containing request parameters that are single items. The Key is the parameter (ex. 'limit') and the Value is the corresponding value
  • listParameters Map<String, List<String>>, Map containing request parameters which include lists of items. The Key is the parameter (ex. 'contentLayouts') and the Value is the associated list.
  • mapParameters Map<String, Map<String, String>>, Map containing request parameters which include maps of items.
  • requestFlags Map<String, Boolean>, Indicators of data the API shoud refresh and/or return. If the request includes a bundle, and any flag other than noData is specified, that data will be re-queried from the database and then updated in the supplied bundle. The Key is the flag (ex. 'noData') and the Value should be TRUE or FALSE.