[rest_gateway] Allocation Management Endpoints

[ramonfigueiredo]

Describe the enhancement
Add REST endpoints for allocation operations including GET /allocations, GET /allocations/{id}, and PUT /hosts/{id}/allocation. CueGUI uses opencue.api.getAllocations() extensively in HostMonitor.py, CreateShowDialog.py, and MenuActions.py.

Version Number

• https://github.com/AcademySoftwareFoundation/OpenCue/releases/tag/v1.11.66

Additional context
Multiple CueGUI components require allocation data for host management and show creation. The REST Gateway currently lacks AllocationInterface handlers needed for dropdown population and allocation assignment operations that CueGUI performs.

[ramonfigueiredo]

The Academy Software Foundation (ASWF) Dev Days (https://www.aswf.io/dev-days/) is a fantastic way to contribute to the amazing and important #ASWF projects (https://www.aswf.io/projects/) that positively impact our industry. Whether you’re in #vfx, #animation, #softwareengineering, or #softwaredeveloper, this is a great opportunity to get involved.

📅 Next Dev Days: September 25, 2025 (fully virtual, open worldwide)

For this event, we are highlighting OpenCue project - https://docs.opencue.io/, a production-proven render management system originally developed at Sony Pictures Imageworks and part of the ASWF. We’ve prepared more than 40 easy issues and enhancements that are ideal for first-time contributors. These tasks are straightforward, designed to take less than a day to complete, and some can be finished in just a few hours. Everyone is invited to participate and contribute!

🔗 OpenCue codebase: https://github.com/AcademySoftwareFoundation/OpenCue
📘 OpenCue documentation: https://docs.opencue.io
📖 Developer guide: https://docs.opencue.io/docs/developer-guide/index/
🧪 Using the OpenCue Sandbox for Testing: https://docs.opencue.io/docs/developer-guide/sandbox-testing/
💬 OpenCue Slack channel: https://academysoftwarefdn.slack.com/archives/CMFPXV39Q
✅ Available tasks/issues and enhancements (good first issue + help wanted): https://github.com/AcademySoftwareFoundation/OpenCue/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22%20label%3A%22help%20wanted%22&page=2

---

✅ How to Contribute Effectively

• Focus on one issue at a time. Please don’t try to solve or implement all the main issues at once.
• When your work is complete, submit a full pull request (PR). We’ll review it as soon as possible.
• If your PR is not yet ready, submit it as a Draft Pull Request. Once you’re confident it’s ready, change the status to Open so maintainers know it can be reviewed.

How to create a Draft PR on GitHub:

1. When opening a pull request, click the dropdown on the green “Create pull request” button and select “Create draft pull request”.
2. Your PR will be clearly marked as Draft until you’re ready.
3. When it’s ready for review, click “Ready for review” at the top of the PR page - this changes the status to Open.

---

Thank you for your contribution!
Before we can move forward with the code review, please sign the CLA Authorization - EasyCLA

➡️ You only need to sign the CLA once, when you are submitting your first full request to the OpenCue project. After that, you’re all set for future contributions.

Everyone’s collaboration is very much appreciated. Thank you for helping grow OpenCue and for contributing to the software our industry relies on!

[harsh21234i]

“I’d like to take this issue. Please assign it to me.”

[ramonfigueiredo]

Assigned to you.
I appreciate your interest in helping to solve this issue, @harsh21234i

[ramonfigueiredo]

FYI ...

• [rest_gateway] Add comprehensive OpenCue REST Gateway documentation and testing infrastructure #1940

[ramonfigueiredo]

FYI ...

OpenCue Docs:

1. Getting Started: Deploying OpenCue REST Gateway

• https://docs.opencue.io/docs/getting-started/deploying-rest-gateway/

2. User Guides: Using the REST API

• https://docs.opencue.io/docs/user-guides/using-rest-api/

3. Other Guides: Deploying REST Gateway - Production deployment and configuration

• https://docs.opencue.io/docs/other-guides/deploying-rest-gateway/

4. Reference: REST API Reference

• https://docs.opencue.io/docs/reference/rest-api-reference/

5. Tutorials: REST API Tutorial

• https://docs.opencue.io/docs/tutorials/rest-api-tutorial/

6. Developer Guide: REST Gateway Development

• https://docs.opencue.io/docs/developer-guide/rest-gateway-development/

Opencue Rest Gateway README.md file:

• https://github.com/AcademySoftwareFoundation/OpenCue/blob/master/rest_gateway/README.md

[ramonfigueiredo]

FYI ...

The OpenCue sandbox provides a quick way to run Cuebot, RQD, CueGUI, and CueSubmit locally for testing. This environment is ideal for developers who want to test changes, experiment with features, or learn how OpenCue works without setting up a full production environment.

• Using the OpenCue Sandbox for Testing

[ramonfigueiredo]

I'm working on this issue. I will submit a PR soon.

[ramonfigueiredo]

Done. See PR:

• [rest_gateway] Add management interface endpoints and comprehensive testing #2015