Request properties

All request properties are defined within the request object in theItential Platform service instance configuration for the adapter.

Properties

Property	Type	Required	Description
`number_redirects`	integer	No → `0`	The maximum number of redirects to follow before returning an error. Set to `0` to disallow redirects.
`number_retries`	integer	Yes	The number of times to retry a failed request (for errors matching `limit_retry_error`) before returning an error.
`limit_retry_error`	integer or array	Yes	The error code or codes that should trigger a retry. Supports an array of integers or ranges. Example: `[401, "500-599"]`
`failover_codes`	array of integers	No	Error codes that cause the adapter to return a response instructingItential Platform to route the request through another adapter, if one is available.
`attempt_timeout`	integer	Yes	Time in milliseconds after which the adapter aborts a request. The request may be retried after a successful healthcheck.
`global_request`	object	No	Static data to include in every request the adapter makes. All values must be static — dynamic values should be handled in `adapter.js`. Sub-fields: `payload` (static body fields), `uriOptions` (static query parameters), `addlHeaders` (static headers), `authData` (static authentication data).
`healthcheck_on_timeout`	boolean	Yes	When `true`, the adapter runs a healthcheck after a request times out to verify the external system is still available.
`return_raw`	boolean	No	When `true`, returns the raw response alongside the processed result. Useful for collecting mock data.
`archiving`	boolean	No	Deprecated. Do not use except in lab environments for adapter testing.
`return_request`	boolean	No	When `true`, returns the outbound request data along with the response. Note that this may include authentication information.

Example

This example retries on 501 errors up to five times, aborts requests after 60 seconds, and adds a static SimonSays header to every call.

"request": {
  "number_redirects": 0,
  "number_retries": 5,
  "limit_retry_error": 501,
  "failover_codes": [],
  "attempt_timeout": 60000,
  "global_request": {
    "payload": {},
    "uriOptions": {},
    "addlHeaders": {
      "SimonSays": "Please"
    },
    "authData": {}
  },
  "healthcheck_on_timeout": true,
  "return_raw": false,
  "archiving": false
}