Overview
This node integrates with the ABMS web service API to perform various operations such as creating, deleting, describing, querying, retrieving, and updating elements within a session. Specifically, the Delete operation allows users to delete an element identified by its Webservice ID from an active session.
Common scenarios for using the Delete operation include:
- Removing obsolete or incorrect records from the ABMS system.
- Cleaning up data after processing or synchronization tasks.
- Managing lifecycle of elements programmatically within workflows.
For example, after retrieving a list of elements via a query, you might want to delete certain entries based on specific criteria automatically.
Properties
Name | Meaning |
---|---|
Session Name | The name of the active session obtained through a prior Login operation; required to authenticate and authorize the request. |
Webservice ID | The unique identifier of the element to be deleted in the ABMS system. |
Output
The output is a JSON object representing the response from the ABMS web service after attempting the delete operation. This typically includes success status and any relevant messages or error details returned by the API.
No binary data is produced by this operation.
Example output structure (simplified):
{
"success": true,
"result": {
"id": "12345",
"message": "Element deleted successfully"
}
}
or in case of failure:
{
"success": false,
"error": {
"code": "ERROR_CODE",
"message": "Description of the error"
}
}
Dependencies
- Requires an API key credential configured in n8n to authenticate requests to the ABMS web service.
- The node makes HTTP POST requests to the
/webservice.php
endpoint of the ABMS host URL. - The
sessionName
parameter must be valid and active, typically obtained from a successful Login operation. - No additional external libraries are required beyond those bundled with n8n.
Troubleshooting
- Invalid Session Name: If the session name is missing, expired, or invalid, the API will reject the request. Ensure that you have performed a successful login and are passing the correct session name.
- Incorrect Webservice ID: Providing an invalid or non-existent Webservice ID will cause the delete operation to fail. Verify the ID before attempting deletion.
- API Errors: The node throws errors if the underlying HTTP request fails or if the API returns an error response. Check the error message for details.
- Unimplemented Operations: Some operations like "extend_session", "logout", and "sync" are not implemented and will throw errors if used.
- Credential Issues: Make sure the API credentials (host URL, username, access key) are correctly set up in n8n.
Links and References
- ABMS Web Service API Documentation (Replace with actual URL if available)
- n8n HTTP Request Node Documentation
- n8n Credential Management