GPortal Entity API icon

GPortal Entity API

Interact with GPortal Entity API

Actions5

Entity → Delete

AI-generated

Overview

This node interacts with the GPortal Entity API to delete an entity by its ID. It is useful in scenarios where you need to programmatically remove specific entities from the GPortal system, such as cleaning up outdated or irrelevant data.

Use Case Examples

  1. Deleting a user entity by specifying its unique ID.
  2. Removing a product entity from the database when it is no longer available.

Properties

Name Meaning
Entity ID The unique identifier of the entity to be deleted.
Additional Fields Optional additional query parameters to customize the delete request.

Output

JSON

  • json - The JSON response from the GPortal API after deleting the entity, typically confirming the deletion or providing status information.

Dependencies

  • Requires an API key credential for GPortal API authentication.

Troubleshooting

  • Ensure the Entity ID is correct and exists in the system; otherwise, the API may return an error indicating the entity was not found.
  • Verify that the API credentials are valid and have sufficient permissions to delete entities.
  • If additional query parameters are used, ensure they are correctly formatted as name-value pairs.
  • Common error messages include JSON parsing errors if the input data is malformed, or HTTP errors if the API endpoint is unreachable or the request is unauthorized.

Discussion