Actions8
Overview
This node interacts with the "Person Document" resource of the Pulse API, specifically supporting the operation to retrieve a list of person documents. It is designed to fetch documents associated with people, optionally including related resources and applying filters, pagination, sorting, and field selection.
Common scenarios where this node is beneficial include:
- Retrieving all documents linked to specific persons in an organization.
- Filtering documents by certain criteria such as person ID or document type.
- Paginating through large sets of documents for batch processing or reporting.
- Including related person data alongside documents for enriched context.
For example, you might use this node to get a paginated list of identity verification documents for employees, including their personal details, sorted by creation date.
Properties
| Name | Meaning |
|---|---|
| Include Related Resources | Select related resources to include in the response. Currently supports: Person. This allows fetching additional related data along with the person documents. |
| Additional Fields | A collection of optional parameters to customize the request: - Sort: Specify the sort order (e.g., by date or name). - Page Number: The page number for pagination (default 1). - Page Size: Number of items per page (default 10). - Filters: Apply one or more filters by specifying filter keys and comma-separated values (e.g., filter by person_id with values 1,2,3). - Fields: Specify which fields to return by providing field keys and comma-separated field names (e.g., id,name). |
Output
The node outputs JSON data representing the list of person documents retrieved from the API. The structure typically includes an array of document objects, each containing properties such as document identifiers, metadata, and any included related resources (like person details) if requested.
If binary data were involved (e.g., document files), it would be indicated here, but based on the provided code and properties, the output focuses on JSON metadata about person documents.
Dependencies
- Requires an API key credential for authenticating with the Pulse API.
- Depends on the Pulse API helper utility to make requests.
- No additional external services are explicitly required beyond the Pulse API.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Using unsupported filter keys or invalid pagination parameters may result in API errors.
- Requesting unsupported related resources or fields could lead to empty or partial responses.
Error messages:
"The operation "getPersonDocumentList" is not supported for resource "personDocument"!": Indicates a mismatch between selected operation and resource; ensure correct operation is chosen."The resource "..." is not supported!": Means the resource parameter is invalid or misspelled.- Network or authentication errors from the Pulse API should be checked by verifying API key validity and network connectivity.
To resolve these, verify input parameters, ensure valid credentials, and consult the Pulse API documentation for correct usage.
Links and References
- Pulse API Documentation (replace with actual URL)
- n8n Documentation on Creating Custom Nodes
- General API Pagination and Filtering Concepts: REST API Pagination