For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
  • Introduction
    • Overview
    • Retired adapters
      • Adapter source files
      • Adapter method reference
      • adapter.js
      • Adapter Utils
      • Examples
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • adapter.js
  • adapterBase.js
  • Adapter Utils
Customize

Adapter source files

Was this page helpful?
Previous

Adapter method reference

Next
Built with

adapter.js

This file contains the adapter code exposed to the rest of Itential Platform. Public methods in this file can be called from other parts of the platform, making adapter actions available to other systems. The Adapter Builder generates a method in this file for each action in the API.

adapter.js also extends adapterBase.js, giving it access to all base adapter methods and Adapter Utils. You are expected to modify the methods in this file as needed to use essential capabilities and add any required logic.

adapterBase.js

This file contains generic adapter methods and should not be modified directly. When an adapter is migrated, this file is replaced with a newer version and any changes you make will be overwritten.

adapterBase.js includes the connect and healthcheck methods, which should also not be modified. If you need to change this behavior, override the relevant methods in adapter.js instead.

If you find a bug in adapterBase.js or want to add a capability, open a ticket with the Itential Adapter Team. Itential will make the requested changes and migrate the fix to all adapters.

Adapter Utils

Most adapter logic lives here. Adapter Utils provide all essential capabilities, including translation, filtering, authentication, throttling, retries, redirects, and mock data results.