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 an ABMS session. The "Create" operation specifically enables users to create a new element of a specified type in an active session.
Typical use cases include:
- Automating data entry by creating new records or elements in ABMS.
- Integrating ABMS data creation into workflows triggered by external events.
- Managing ABMS elements programmatically without manual intervention.
For example, after logging in and obtaining a session name, a user can create a new element by specifying its type and JSON representation, which the node sends to the ABMS API to create the element.
Properties
| Name | Meaning |
|---|---|
| Session Name | The identifier for the current ABMS session; required to authenticate and authorize requests. Typically obtained from a prior login operation. |
| Element | A JSON object representing the data of the element to be created in ABMS. |
| Element Type | The type/category of the element to create (e.g., contact, product). |
Output
The node outputs a JSON array containing the response from the ABMS API for the create operation. This typically includes details about the newly created element, such as its ID and any metadata returned by the API.
No binary data output is produced by this node.
Dependencies
- Requires an active ABMS API credential with host URL, username, and access key.
- Uses HTTP requests to communicate with the ABMS webservice endpoint
/webservice.php. - Relies on the
crypto-jslibrary internally for hashing during login (not directly relevant for create but part of overall node functionality).
Troubleshooting
- Invalid Session Name: If the session name is incorrect or expired, the API will reject the request. Ensure you have a valid session from a successful login.
- Malformed Element JSON: The element property must be valid JSON matching the expected schema for the element type. Invalid JSON or missing required fields may cause API errors.
- API Errors: The node throws errors if the ABMS API returns failure responses. Check the error message and code returned by the API for guidance.
- Unimplemented Operations: Some operations like "extend_session", "logout", and "sync" are not implemented and will throw errors if used.
Links and References
- ABMS Web Service API documentation (refer to your ABMS provider's official docs)
- n8n HTTP Request Node documentation for understanding underlying request mechanics
- Crypto-JS library: https://github.com/brix/crypto-js (used internally for hashing during login)