Subscribe for intercepting APIs
Multiple subscriptions with different endpoints is allowed for the same type and apiId.
Multiple subscriptions with different endpoints of type ADAPT_ENTITY is allowed for the entityName.
If a subscription already exists, it will be overridden with the new executionOrder (if provided in the request).
If an interception is created or updated to have the same executionOrder as an existing interception (including existing ones with default executionOrder),
It will be set with that executionOrder and the existing interception's executionOrder will be incremented.
If that interception's new executionOrder clashes with another the other one will be incremented as well, and so forth.
Request Body Parameters:
| Parameter | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| type | string | true | Values:PRE_REQUEST,POST_REQUEST,ADAPT_ENTITY | |
| apiId | string | true | Should only be provided if type=PRE_REQUEST or type=POST_REQUEST | POST/device/v1/devices |
| entityName | string | true | Should only be provided if type=ADAPT_ENTITY | device |
| endpoint | string | true | https://api.dev.biot-med.com/device-plugin/v1/devices/create-device-pre-interception | |
| executionOrder | integer | false | If not provided, the default value will be taken from the environment variable: EXECUTIONORDER_DEFAULT. |
Subscription with the same executionOrder cannot exist simultaneously.
If an interception is created or updated to have the same executionOrder as an existing interception (including existing ones with default executionOrder),
It will be set with that executionOrder and the existing interception's executionOrder will be incremented.
If that interception's new executionOrder clashes with another the other one will be incremented as well, and so forth.|1|
This API requires HOOKS_INTERCEPTION_CREATE permission(s).