Overview

This node interacts with the Json2Doc API to manage document generation jobs. Specifically, for the 'Job' resource and 'Get' operation, it retrieves detailed information about a specific job by its ID. This is useful for tracking the status and results of document generation tasks, such as checking if a job is completed, failed, or still pending. Practical examples include fetching the output file ID or error messages related to a document generation job.

Use Case Examples

1. Retrieve the status and output details of a document generation job by providing its Job ID.
2. Use the job information to trigger subsequent workflow steps based on job completion or failure.

Properties

Output

JSON

• jobId - The unique identifier of the job.
• status - The current status of the job (e.g., PENDING, COMPLETED, FAILED).
• outputFileId - The ID of the output file generated by the job, if completed.
• errorMessage - Error message if the job failed or was cancelled.
• otherJobDetails - Additional job-related information returned by the API.

Dependencies

• Json2Doc API
• API key credential for authentication

Troubleshooting

• Common issues include invalid or missing Job ID, resulting in API errors.
• Job status may be PENDING for some time; repeated checks may be needed to confirm completion.
• If the job fails or is cancelled, the error message will be provided in the output for diagnosis.

Links

• Json2Doc API Documentation - Official API documentation for Json2Doc, useful for understanding job management endpoints and responses.