In this lesson, we will go through the most commonly used Parameter types in Cyclr.
A parameter is a variable which is defined to a particular endpoint. Parameters are used to send additional information, generally, outside of the Request Body.
Parameters can be used to define a number of different properties to be used in an HTTP Request or Response, such as HTTP headers, MergeFields and QueryString values.
You can define Parameters at the Connector level or Method level. Just remember that if a Parameter is defined at the Connector level, it will be available to all the Methods. This can be useful for determining domain addresses or other parameters that you know will be used in all methods across your Connector.
Parameter Types
Cyclr supports six types of parameters:
- HttpHeader: headers are attached to the request Cyclr sends to the API
- MergeField: used to insert data within an EndPoint
- QueryString: a parameter that is attached to the end of a request URL
- FilterField: Cyclr filter field (can set a date field as FilterField to filter new objects)
- ResponseField: automatically stores a value from a response body to use in the next request. Mainly useful for Paging.
- Script: Cyclr specific parameters which are used within the Script engine.
The most common ones are HttpHeaders, MergeFields, QueryStrings and ResponseFields, which we will be covering in more detail.