Overview
This node integrates with the uSign API to perform various operations on entities within the uSign system. It supports listing, retrieving, deleting, and updating records of a specified entity type.
A common use case is automating document or user management workflows where you need to fetch lists of records, get details of a specific record, update existing records, or delete them programmatically.
For example:
- Listing all documents or users with optional pagination and filtering.
- Retrieving detailed information about a single document by its ID.
- Updating metadata or status of a document using JSON data.
- Deleting obsolete or unwanted records automatically.
Properties
| Name | Meaning |
|---|---|
| Load All Records | Whether to load all available records without limit (true/false). |
| Limit | Maximum number of results to return when not loading all records (minimum 1, default 50). |
| All Subdomains | Whether to include data from all subdomains in the query (true/false). |
| Entity Name or ID | The name or identifier of the entity to operate on (required). |
Note: These properties apply specifically to the "Listar" (List) operation.
Output
The node outputs an array of items, each containing a json field with the data returned from the uSign API:
- For the "Listar" operation, the output is a list of JSON objects representing the records retrieved from the specified entity.
- Each item corresponds to one record from the API response.
- The structure of each JSON object matches the entity's data schema as provided by the uSign API.
- No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the uSign API.
- The node makes HTTP requests to the uSign API endpoints using Axios.
- The base URL and authentication credentials must be configured in the node's credentials settings.
- The node performs a login request to obtain a bearer token before making further API calls.
Troubleshooting
- Authentication errors: If the node fails to authenticate, verify that the API credentials (username and password) are correct and have sufficient permissions.
- Invalid operation error: Selecting an unsupported operation will throw an error indicating an invalid operation.
- Request errors: Network issues or incorrect entity names/IDs may cause request failures. The node throws errors with messages from the API response.
- JSON parsing errors: When updating records, ensure the JSON data provided is valid; otherwise, parsing errors will occur.
- Pagination limits: When not loading all records, the node respects the limit property but caps page size at 100 per request internally.
Links and References
- uSign API Documentation (example link, replace with actual if available)
- Axios HTTP Client
- n8n Node Development Guide