Actions12
- File Actions
- Template Actions
- Job Actions
Overview
This node interacts with the Json2Doc API to list jobs related to document generation. It allows users to retrieve a list of jobs with options to filter by job status, sort by various date fields, and control the number of results returned. This is useful for monitoring and managing document generation jobs, such as checking pending, completed, or failed jobs.
Use Case Examples
- A user wants to retrieve all completed document generation jobs sorted by completion date in descending order.
- A user needs to fetch only the first 50 pending jobs to display in a dashboard.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all job results or limit the number of results. |
| Limit | Maximum number of job results to return when 'Return All' is false. |
| Additional Fields | Optional filters and sorting options for listing jobs, including status, sort field, and sort order. |
Output
JSON
jobs- Array of job objects returned by the API, each representing a document generation job with its details.
Dependencies
- Requires an API key credential for Json2Doc API authentication.
Troubleshooting
- Common issues include API authentication errors due to invalid or missing API key credentials.
- Errors may occur if the job ID or parameters are invalid or if the API service is unavailable.
- Timeout errors can happen if waiting for job completion exceeds the allowed time; increasing wait time or checking job status separately can help.
Links
- Json2Doc API Documentation - Official documentation for the Json2Doc API, detailing endpoints and usage.