Working with Header Parameters

Header parameters are used for user-defined custom HTTP headers for a request, for example, the APIKey could be a HTTP Header parameter. Unlike query and path parameters, header parameters do not appear in the URL of the request, but if they exist in your API specification, they get passed into the request but are not visible to the user.

Note: Header parameters can be defined per operation which means that each operation in the API can have its own header parameters.

If you created your REST API from an imported Swagger file (for example, a Swagger file that was created in the API Modeler), the parameters will not be editable in TIBCO Business Studio. You cannot modify existing parameters or create new ones. You can only view the parameters. Any custom header parameters you create, will be visible in the Data Source tab of the TIBCO Business Studio as follows:

Note: If your Swagger file was created in the API Modeler in TIBCO Cloud Integration, you can add header parameters or modify existing header parameters in its operations from the API's page in API Modeler. For details to do so, see the "Adding and Editing Request Parameters" topic in the API Modeler section. However, the APIs created using a Swagger file that was imported from API Modeler into TIBCO Business Studio cannot be modified in TIBCO Business Studio.
You can view or add header parameters in the TIBCO Business Studio if the Swagger file for your project was auto-generated in the TIBCO Business Studio by implementing a REST service from XSD. To add a custom header parameter, follow these steps:
  1. Click Components under the Module Descriptors to open the Component Configurations page.
  2. Double-click the process name (with the green chevron next to it) to open its properties in the Properties view.
  3. Click the Bindings tab.
  4. Click an operation name in the Operations section.
  5. Click the Request tab in the Operation Details section.
  6. Click the red icon () to add a header parameter. To edit the parameter name click on the newly created parameter's default name and type in a new name. Be aware that these buttons will be disabled if you are viewing operations for an API that was created outside the TIBCO Business Studio and imported into the TIBCO Business Studio.
  7. You can also edit an existing header parameter to make it required or optional by clicking in the cell that corresponds to the parameter in the Required column. The value toggles from Yes to No or vice versa.
  8. To add a header parameter to the operation response, do so in the Response tab.