CentraSite Documentation : Working with REST-based APIs : About CentraSite RESTful API Model : REST Parameters : Parameter Levels
Parameter Levels
 
API-Level Parameters
Resource-Level Parameters
Method-Level Parameters
A parameter can be set at different levels of an API. When you document a REST API in CentraSite, you define parameters at the API level, Resource level, or Method level to address the following scenarios:
*If you have the parameter applicable to all resources in the API, then you define this parameter at the API level. This indirectly implies that the parameter is propagated to all resources and methods under the particular API.
*If you have the parameter applicable to all methods in the API, then you define this parameter at the Resource level. This indirectly implies that the parameter is propagated to all methods under the particular resource.
*If you have the parameter applicable only to a method in the API, then you define this parameter at the Method level.
Copyright © 2005-2015 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback