Overview
This node integrates with the uSign API to perform CRUD operations on specified entities. It supports listing multiple records, retrieving a single record by ID, deleting a record, and updating a record with new JSON data. This node is useful for automating document management workflows, such as fetching contract details, updating document metadata, or removing obsolete entries in uSign.
Practical examples:
- Retrieve a specific document's details by its ID.
- List all documents under a certain entity, optionally including subdomain data.
- Update a document's information by providing new JSON content.
- Delete a document that is no longer needed.
Properties
| Name | Meaning |
|---|---|
| Operation | The action to perform: Listar (list), Resgatar (get), Apagar (delete), Alterar (put). |
| Load All Records | Whether to load all records when listing (only for Listar operation). |
| Limit | Maximum number of results to return when listing (only for Listar operation). |
| All Subdomains | Whether to include all subdomains in the listing (only for Listar operation). |
| Entity Name or ID | The name or identifier of the entity to operate on (required). |
| ID | The resource ID to get, delete, or update (required for get, delete, put operations). |
| JSON Data | New JSON data for updating the resource (required for put operation). |
Output
The node outputs an array of items where each item contains a json field representing the response data from the uSign API:
- For Listar (find) operation: Outputs multiple items, each containing one record's JSON data.
- For Resgatar (get) operation: Outputs a single item with the JSON data of the requested resource.
- For Apagar (delete) operation: Outputs a single item with the JSON response confirming deletion.
- For Alterar (put) operation: Outputs a single item with the updated resource's JSON data.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the uSign API.
- Uses Axios HTTP client for making REST API calls.
- Needs proper configuration of the base URL and user credentials for uSign API access.
Troubleshooting
- Authentication errors: If login fails, verify that the provided username and password are correct and that the API endpoint URL is reachable.
- Invalid operation error: Occurs if an unsupported operation is selected; ensure the operation property is set to one of the supported values.
- Request errors: Network issues or invalid parameters may cause request failures. Check the error message for details and validate input properties like entity name and ID.
- JSON parsing errors: When updating (put operation), ensure the JSON data provided is valid JSON format.
Links and References
- uSign API Documentation (example link, replace with actual)
- Axios GitHub Repository
- n8n Node Development Docs