Overview
The node provides integration with an ABMS (presumably a backend management system) web service via HTTP requests. It supports multiple operations such as creating, deleting, describing elements, listing types, logging in, querying, retrieving, and updating data within the ABMS system.
For the List Types operation specifically, the node fetches and returns a list of available element types from the ABMS system for a given session. This is useful when you want to dynamically discover what kinds of elements or entities can be managed or queried in the system.
Common scenarios include:
- Automating data synchronization or management tasks by interacting programmatically with ABMS.
- Dynamically populating UI dropdowns or workflows based on available element types.
- Integrating ABMS data into other systems or processes using n8n workflows.
Example: After logging in and obtaining a session name, use the List Types operation to retrieve all element types supported by the ABMS instance, then use those types in subsequent create, update, or query operations.
Properties
Name | Meaning |
---|---|
Session Name | The session identifier string obtained through a prior Login operation; required to authenticate and authorize the request. |
Note: For the List Types operation, only the "Session Name" property is relevant and required.
Output
The output is a JSON array containing the response from the ABMS web service's listtypes
operation. This typically includes a list of element types available in the system.
The structure depends on the ABMS API but generally will be an object or array describing each type's name and possibly additional metadata.
No binary data output is produced by this operation.
Dependencies
- Requires an active ABMS API credential configured in n8n that provides:
- Host URL of the ABMS web service.
- Username and access key for authentication.
- The node uses HTTP requests to communicate with the ABMS
/webservice.php
endpoint. - The login operation internally uses the
crypto-js
library to generate an MD5 hash for authentication.
Troubleshooting
- Missing or invalid session name: The session name must be obtained from a successful login operation. Using an incorrect or expired session name will cause errors.
- API connection errors: Ensure the ABMS host URL and credentials are correctly configured and reachable.
- Operation not implemented errors: Some operations like "extend_session", "logout", and "sync" are not implemented and will throw errors if used.
- Login failures: If login fails, the error message and code from the ABMS API will be thrown. Verify username and access key correctness.
- HTTP request errors: Network issues or incorrect parameters may cause HTTP errors. Check the node’s input parameters and network connectivity.
Links and References
- No direct external links provided in the source code.
- Refer to your ABMS system API documentation for details on the
/webservice.php
endpoints and expected responses.