Skip to main content

Project Queue API

Eylon Sirotkin
  • Updated

PhotoMesh provides a REST API to create a project queue and then activate, monitor, and manage queue processing. The project queue is created using the add API method, in which a project queue JSON file is passed that lists all the tasks that should be performed for each of the projects in the project queue. 

The following resources are available:

To test out the Project Queue Editor and Queue Manager on your local PhotoMesh:

  • From the Start page, open the Automation Dashboard and in the Project Queue section, click Project Queue. 

To view documentation of the REST API:

  • From the Start page, open the Automation Dashboard and in the Project Queue section, click Reference Guide.

autodashqueue.png

Using the PhotoMesh Project Queue API with Python

You can streamline project queue management in PhotoMesh, including project creation, build triggers, and report retrieval, by integrating the Project Queue API with Python. Below is a step-by-step guide with sample data.

Step 1: Download and save the example files

  1. Download this example project, extract its files and save them in the following folder: C:\MyProject. Check that the Photos folder from the zip file is directly under the MyProject folder.
  2. Download the ExampleProjectPYTHON.py and ExampleProjectJSON.json files attached to this article, and save them in the same folder: C:\MyProject.

Step 2: Run the Python script

  1. Check that Python is installed on your computer. If it isn't, download it from python.org and install it.
  2. Navigate to your script's directory using the command prompt. E.g., if the script is saved in C:\MyProject, use: 
    cd C:\MyProject
  3. Run the script by typing the following command in the command prompt: 
    python ExampleProjectPYTHON.py
  4. After running the script, the project defined by ExampleProjectJSON.json is added to the build queue, and subsequently the build process automatically starts in PhotoMesh using the parameters defined in the JSON file. When the build is complete, its production report is automatically generated and certain basic build info, including total processing time and number of fusers used in the build is extracted from it and printed to the console.
  1.  

 

 

Related articles