Adapter method reference

Full API documentation for these methods is available through JSDoc. The following is a summary of available calls. Where possible, Itential-specific methods that add capabilities to the adapter have been prefixed with iap. In some cases this was not possible due to product constraints, which means potential naming conflicts with calls to the external system — getDevices is a common example.

Generic adapter methods

These methods are used by Itential Platform or by you directly. Additional internal methods exist that are not listed here.

Method signature	Description	Available in workflows
`connect()`	Runs when the adapter is first loaded by Itential Platform. Validates that properties have been provided correctly.	No
`healthCheck(callback)`	Ensures the adapter can communicate with the external system. The actual call used is defined in the adapter properties and `.system` entity `action.json` file.	No
`refreshProperties(properties)`	Allows the adapter to accept property changes without restarting.	No
`encryptProperty(property, technique, callback)`	Encrypts the provided property using the specified technique. Use this to store credential passwords in encrypted form in the `adapterProps` section. The adapter decrypts the property as needed for external system communication.	No
`iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)`	Updates adapter configuration from within Itential Platform, including actions, schemas, mock data, and other configuration files.	Yes
`iapFindAdapterPath(apiPath, callback)`	Returns whether a particular API path is supported by the adapter.	Yes
`iapSuspendAdapter(mode, callback)`	Suspends the adapter. Incoming requests are either rejected or queued depending on the mode selected.	Yes
`iapUnsuspendAdapter(callback)`	Resumes a suspended adapter. Queued requests are processed before new ones.	Yes
`iapGetAdapterQueue(callback)`	Returns the requests currently waiting in the queue when throttling is enabled.	Yes
`iapTroubleshootAdapter(props, persistFlag, adapter, callback)`	Checks adapter performance by running connectivity, health check, and basic GET call tests.	Yes
`iapRunAdapterHealthcheck(adapter, callback)`	Returns the results of a health check.	Yes
`iapRunAdapterConnectivity(callback)`	Returns the results of a connectivity check.	Yes
`iapRunAdapterBasicGet(callback)`	Returns the results of running basic GET API calls.	Yes
`iapMoveAdapterEntitiesToDB(callback)`	Pushes adapter configuration from the entities directory into the database defined in the adapter service instance configuration in Itential Platform Admin Essentials.	Yes
`iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)`	An expanded generic request method. The `metadata` object enables additional capabilities. You must know the endpoint and input format (body, query, etc.) specific to the action you want to perform, as different systems handle these differently. This is the preferred generic method to use.	Yes
`genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)`	Calls the provided path directly. Useful for incorporating API paths not yet built into the adapter. You must know the endpoint and input format specific to the action you want to perform.	Yes
`genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)`	Same as `genericAdapterRequest` but does not prepend a base path or version to the call. You must know the endpoint and input format specific to the action you want to perform.	Yes

Device Broker methods

These methods integrate the adapter with Itential Platform Device Broker.

Method signature	Description	Available in workflows
`hasEntities(entityType, entityList, callback)`	Used by the Itential Platform Device Broker to determine whether the adapter has a specific entity and item.	No
`getDevice(deviceName, callback)`	Returns the details of the requested device.	Yes
`getDevicesFiltered(options, callback)`	Returns the list of devices that match the criteria provided in the options filter.	Yes
`isAlive(deviceName, callback)`	Returns whether the device status is active.	Yes
`getConfig(deviceName, format, callback)`	Returns the configuration for the selected device.	Yes
`iapGetDeviceCount(callback)`	Returns the count of devices.	Yes