Requesting Project Scan

3rd Party Modules
1

Im working on a third party tool that allows editing of files outside of the designer, after editing and saving I need to trigger a project scan (data/api/v1/scan/projects) so that the latest changes are picked up but this raises a few questions:

  • Do I have to acquire a project scan lock(data/api/v1/scan-lock/projects) before requesting a project scan?
  • Is project scanning asynchronous? The reason I ask this is because we have a module that will update the designer project after receiving a notification from the gateway but I don’t want to create a race condition where the designer project updates before the gateway is done with its project scan.
2

It's asynchronous.

The scan lock is optional.

1 Like
3

You can GET the same endpoint to check whether a scan is already running.

Note that no matter what you do, there's no (supported) way to force any open designers to pull the updated project from the gateway, so this may never get the user experience you really want.

1 Like