Overview
This node integrates with the ABMS web service API, allowing users to perform various operations such as creating, deleting, describing, querying, retrieving, and updating elements within the ABMS system. It also supports login and listing available element types. The node is useful for automating interactions with the ABMS platform, enabling workflows that manage data entities programmatically.
Common scenarios include:
- Automating data creation or updates in ABMS based on external triggers.
- Querying ABMS data to use in other systems or reports.
- Managing sessions by logging in and obtaining session tokens.
- Retrieving metadata about element types for dynamic workflow adjustments.
Example: A user can log in to ABMS, create a new element of a specified type with given JSON data, then query or retrieve elements later in the workflow.
Properties
| Name | Meaning |
|---|---|
| Session Name | The session identifier obtained through the Login operation; required for most operations except login. |
Note: The provided input properties JSON only includes "Session Name" because the Resource and Operation are both "Default". The node supports many other properties depending on the selected operation (e.g., Element, Element Type, Webservice ID, Query), but these are not included here per the user's request.
Output
The node outputs a JSON array containing the response from the ABMS web service API corresponding to the requested operation. The structure of the JSON depends on the operation performed:
- For login, it returns login success details including session information.
- For create, update, delete, retrieve, describe, query, and listtypes, it returns the respective API response data, typically including status, data elements, or metadata.
- No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authentication with the ABMS web service.
- Uses HTTP requests to communicate with the ABMS API endpoint (
/webservice.php). - Uses the
crypto-jslibrary internally to generate MD5 hashes during the login operation. - The node expects the ABMS API host URL and credentials to be configured in n8n.
Troubleshooting
- Unimplemented Operations: Some operations like "extend_session", "logout", and "sync" are not implemented and will throw errors if used.
- Login Failures: If the login challenge request fails, the node throws an error with the message and code returned by the ABMS API. Ensure correct username and access key are provided.
- Session Name Required: Most operations require a valid session name obtained from a successful login. Omitting or providing an invalid session name will cause API errors.
- HTTP Request Errors: Network issues or incorrect API host configuration may cause request failures. Verify connectivity and credential settings.
- JSON Input Format: For operations requiring JSON input (e.g., create, update), ensure the JSON is well-formed to avoid API rejections.
Links and References
- ABMS API Documentation (Assumed placeholder, replace with actual URL if known)
- crypto-js GitHub Repository - Used for MD5 hashing in login operation.