Cancel the job

What it does

Cancels a job started by your AI:

• if the job is still waiting for its turn, it does not start;
• if it is running, it stops at Revit's next progress step. An opening canceled with Open a model leaves no model open and Revit stays usable;
• if it is a team action waiting for your approval, the request is withdrawn and nothing changes;
• if the job has already finished, nothing changes.

It answers even while Revit is busy.

How it works

1. Your AI calls the tool with the job's id; without an id it cancels the only running job (if there are several, it asks for the id).
2. BIMit records the cancellation request and waits, up to the time given (10 seconds by default, at most 120), for the job to finish.
3. Your AI tells you whether the job was canceled, whether it had already finished before the cancellation arrived, or whether the request was sent and the job will stop at Revit's next progress step (it checks with Job status).

Example requests

• "Stop opening the model, it's taking too long."
• "Cancel the synchronization request you sent me in Revit."
• "Cancel job j1-9c1e."

What changes and how to undo

The tool changes neither the model nor any file: it only stops a job. A canceled opening leaves no model open; if Revit had already finished opening it, BIMit closes it without saving (the active document, however, cannot be closed through the API: in that case close it yourself in Revit). A withdrawn approval request changes nothing.

A cancellation cannot be reversed: to repeat the job, your AI starts it again (for example by reopening the model with Open a model).

Limits

• A running job stops only at Revit's next progress step, not instantly.
• One call waits at most 120 seconds.

Parameters

Related tools

• Open a model
• Job status