NOTE: THIS IS A PROPOSAL AND DOCUMENTS NON-IMPLEMENTED FUNCTIONALITY. IT'S MEANT FOR DISCUSSION ABOUT WHETHER OR NOT A RESTFUL INTERFACE FOR MAYA WOULD SERVE ANY USEFUL PURPOSE.
A RESTful interface for Maya.
The idea is to facilitate external control of Maya via standard REST commands for tools and user interfaces that operate outside the confines of the Maya GUI; such as Web Applications or QML interfaces.
Issue a GET request to the root endpoint to get a list of available endpoints supported by the API
GET http://127.0.0.1:6000| Endpoint | Description |
|---|---|
| /node | GET, POST, PUT and DELETE nodes |
| /command | POST command(s) to execute from within Maya |
| /polygon | GET information about polygonal data |
$ # Retrieve list of all available nodes
$ curl -X GET http://127.0.0.1:6000/node
$ # Create a new node
$ curl -X POST http://127.0.0.1:6000/node -d "{'type': 'mesh', 'name': 'MyMesh'}"
$ # Execute arbitrary command
$ curl -X POST http://127.0.0.1:6000/command -d "{'module': 'cmds', 'command': 'polyCube', 'kwargs': {'name': 'MyMesh'}}"Errors are returned as JSON with a single "message" field.
HTTP/1.1 400 Bad Request
Content-Length: 35
{"message":"Problems parsing JSON"}| Verb | Description |
|---|---|
| GET | Used for retrieving resources |
| POST | Used for creating resources, or performing custom actions |
| PUT | Used for replacing resources or collections |
| DELETE | Used for deleting resources |