About Request Headers
This section lists request headers of POST request type that are part of the OpenAPI specifications. The list contains some mandatory and some optional request headers that are needed when accessing the TMF622 and TMF641 specifications.
| Request API Paths | Request Headers | Description | Mandatory? |
|
/productOrder /serviceOrder |
X-Version
|
This header is used to define order version. If not defined, the default value 1 is used. | No |
|
/productOrder /serviceOrder |
X-Fulfillment-Mode |
By default, a TMF cartridge has deliver fulfillment
mode. This header is mandatory if other than the default fulfillment
mode is used in the cartridge.
|
Yes (if other than deliver)
|
|
/cancelProductOrder /cancelServiceOrder |
X-Version |
This header is used to define order version. If not defined, existing order version will be incremented by 1. | No |
|
/reviseProductOrder /reviseServiceOrder |
X-Version |
This header is used to define order version. This value should be greater than the previous order version. | Yes |
|
/reviseProductOrder /reviseServiceOrder |
X-Fulfillment-Mode |
By default, a TMF cartridge has deliver fulfillment
mode. This header is mandatory if other than the default fulfillment
mode is used in the cartridge.
|
Yes (if other than deliver)
|
Note:
The /revise and /suspend APIs are not part of the canonical TMF622 and TMF641 API specifications.Request Headers for a System Interaction
When OSM automation plugins connect to an external system using REST (System
Interaction), the HTTP header 'X-Correlation-ID' is supplied automatically on the
request. This HTTP header is REQUIRED on synchronous responses back to OSM. If it is not
provided as an HTTP header, then it must be part of the event envelope.
Note:
More information about headers is provided with each API definition within this document.