Overview
The node provides integration with an ABMS (presumably a backend management system) via its webservice API. It supports multiple operations such as creating, deleting, describing elements, listing types, logging in/out, querying, retrieving, syncing, and updating data within the ABMS environment.
Specifically, the Extend Session operation is declared but not implemented in this node. Attempting to use it will result in an error indicating that the operation is not supported.
This node is useful for automating interactions with the ABMS platform, such as managing session lifecycles, manipulating data elements, and running queries programmatically. For example, you could automate data retrieval or updates without manual intervention by using the login, query, create, or update operations.
Properties
| Name | Meaning |
|---|---|
| Session Name | The name of the current session to be used for operations other than login. This value is typically obtained from a successful login operation. |
Note: The "Session Name" property is required for all operations except "login". It acts as an authentication context for subsequent requests.
Output
The node outputs the JSON response returned by the ABMS webservice API for the selected operation. The structure of the output depends on the operation performed and the API's response format.
- The output is always returned as a JSON array containing one element.
- No binary data output is produced by this node.
For example, after a successful query operation, the output JSON will contain the queried records. After a create operation, it will contain details about the created element.
Dependencies
- Requires an API host URL and credentials including username and access key to authenticate with the ABMS webservice.
- Uses HTTP requests to communicate with the ABMS API endpoint
/webservice.php. - Uses the
crypto-jslibrary internally for hashing during the login operation. - Requires configuration of an API key credential in n8n to provide the necessary authentication details.
Troubleshooting
Operation Not Implemented Errors:
The "extend_session", "logout", and "sync" operations are explicitly not implemented. Attempting to execute these will throw an error stating the operation is not implemented.Login Failures:
If the login operation fails, the node throws an error with the message and code returned by the ABMS API challenge request. Common causes include incorrect username or access key.Missing Session Name:
Operations other than login require a valid session name. Omitting this or providing an invalid session name will likely cause API errors.HTTP Request Issues:
Network connectivity problems or incorrect API host configuration can cause request failures. Verify the API host URL and network access.
Links and References
- No external documentation links are provided in the source code.
- Users should refer to their ABMS platform API documentation for detailed information on the supported operations and expected request/response formats.