IfcPipeline File Operations icon

IfcPipeline File Operations

Work with files in IFC Pipeline

Actions6

Get Job Status

AI-generated

Overview

This node operation retrieves the status of a specific job in the IFC Pipeline system. It is useful for monitoring the progress or completion state of background or asynchronous jobs identified by a unique job ID. For example, after submitting a file processing job to IFC Pipeline, you can use this operation to check if the job is still running, completed successfully, or failed.

Use Case Examples

  1. Check the status of a file conversion job by providing its job ID to track when the conversion is done.
  2. Monitor the progress of a large file upload or processing task by periodically querying the job status.

Properties

Name Meaning
Job ID The unique identifier of the job whose status you want to retrieve. This is a required string input.

Output

JSON

  • status - The current status of the job, such as running, completed, or failed.
  • jobId - The ID of the job queried.
  • additionalDetails - Any additional information returned by the IFC Pipeline about the job status.

Dependencies

  • An API key credential for IFC Pipeline API authentication

Troubleshooting

  • Ensure the provided Job ID is correct and exists in the IFC Pipeline system; otherwise, the API will return an error.
  • If the node throws an error about missing or invalid credentials, verify that the IFC Pipeline API key is correctly configured in the node credentials.
  • Network or API endpoint issues may cause request failures; check connectivity and IFC Pipeline service status.

Links

Discussion