Defining Headers

Optionally headers can be assigned for the Request or Response. These headers will be part of the Open API documentation for the 3rd party to set (Request) or read (Response).

Select the Headers link for the URI method on the Root Resources page.

This example illustrates the fields and controls on the HTTP Headers page. You can find definitions for the fields and controls later on this page.

HTTP Headers page

Field or Control

Description

Header Type

Indicate if this is a Request or Response header.

Property Name

Name of the header.

Value

Optional value for the header.

Description

Description of the header.

Edit button

Select to edit the header.

Add icon

Select to add a new header.

Delete icon

Select to delete a row.

See Defining Routing Header Properties for Provider REST Service Operations