META

Queries for managing projects

createProject

http://your.server/ramses/?createProject

Creates a new project in the database.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "createProject",
    "success": true,
    "message": "Project \"Mytho\" created.",
    "content": { }
}

getProject

http://your.server/ramses/?getProject

Retrieves a single project.

Query attributes:

Reply content:

The server replies with a project object with the following attributes:

Reply body:

{
    "accepted": true,
    "query": "getProject",
    "success": true,
    "message": "Project retrieved",
    "content": {
            "name": "Mythomen",
            "shortName": "Mytho",
            "comment": "A comment",
            "publishSettings": "- A YAML-formatted setting list",
            "uuid": "2d7d7e01-671c-11e7-a78f-4ccc6a288527",
            "folderPath": "PROJECTS/MYTHO",
            "framerate": 25.0,
            "width": 1920,
            "height": 1080,
            "aspectRatio": 1.78,
            "deadline": "2021-06-23",
            "users": ["uuid123", "uuid456"],
            "pipeFiles": [
                {
                    "uuid":"uuid123",
                    "shortName":"geoPipe",
                    "comment":"A comment",
                    "fileTypeUuid":"uuid789",
                    "colorSpaceUuid":"uuid333",
                    "projectUuid":"2d7d7e01-671c-11e7-a78f-4ccc6a288527"
                },
                {
                    "uuid":"uui456",
                    "shortName":"shaderPipe",
                    "comment":"A comment",
                    "fileTypeUuid":"uuid789",
                    "colorSpaceUuid":"uuid333",
                    "projectUuid":"2d7d7e01-671c-11e7-a78f-4ccc6a288527"
                }
            ],
            "steps": [
                {
                    "uuid":"uuid123",
                    "shortName":"ANIM",
                    "comment":"A comment",
                    "name":"Animation",
                    "type":"shot",
                    "order":2,
                    "color":"#123456",
                    "estimationMethod":"second",
                    "estimationVeryEasy":0.2,
                    "estimationEasy":0.5,
                    "estimationMedium":1.0,
                    "estimationHard":2.0,
                    "estimationVeryHard":3.0,
                    "multiplyGroupUuid":"uuid789",
                    "projectUuid":"2d7d7e01-671c-11e7-a78f-4ccc6a288527"
                },
                {
                    "uuid":"uuid456",
                    "shortName":"RIG",
                    "comment":"A comment",
                    "name":"Rigging",
                    "type":"asset",
                    "order":1,
                    "color":"#789456",
                    "estimationMethod":"shot",
                    "estimationVeryEasy":0.2,
                    "estimationEasy":0.5,
                    "estimationMedium":1.0,
                    "estimationHard":2.0,
                    "estimationVeryHard":3.0,
                    "multiplyGroupUuid":"",
                    "projectUuid":"2d7d7e01-671c-11e7-a78f-4ccc6a288527"
                }
            ],
            "pipes": [
                {
                    "uuid":"uuid123",
                    "inputStepUuid":"uuid456",
                    "outputStepUuid":"uuid789",
                    "pipeFiles": ["uuid111","uuid222"],
                    "projectUuid":"2d7d7e01-671c-11e7-a78f-4ccc6a288527"
                },
                {
                    "uuid":"uuid123",
                    "inputStepUuid":"uuid456",
                    "outputStepUuid":"uuid789",
                    "pipeFiles": ["uuid111","uuid222"],
                    "projectUuid":"2d7d7e01-671c-11e7-a78f-4ccc6a288527"
                }
            ],
            "assetGroups": [
                {
                    "uuid":"uuid123",
                    "shortName":"CHARS",
                    "comment":"A Comment",
                    "name": "Characters",
                    "projectUuid":"2d7d7e01-671c-11e7-a78f-4ccc6a288527"
                },
                {
                    "uuid":"uuid456",
                    "shortName":"PROPS",
                    "comment":"A Comment",
                    "name": "Props",
                    "projectUuid":"2d7d7e01-671c-11e7-a78f-4ccc6a288527"
                }
            ],
            "assets": [
                {
                    "uuid":"uuid456",
                    "shortName":"TRISTAN",
                    "name":"Tristan",
                    "comment":"A main character",
                    "tags": "main, male, warrior",
                    "assetGroupUuid": "uuid123",
                    "statusHistory": [
                        {
                            "uuid":"uuid123",
                            "completionRatio": 0,
                            "comment":"To do",
                            "version": 0,
                            "date":"2021-06-23 12:35:23",
                            "userUuid":"uuid111",
                            "stateUuid":"uuid789",
                            "stepUuid":"uuid777",
                            "assignedUserUuid":"uuid888",
                            "published": 0,
                            "timeSpent": 3600,
                            "difficulty":"hard",
                            "estimation": 12.5,
                            "assetUuid":"uuid456"
                        }
                    ]
                }
            ],
            "sequences": [
                {
                    "uuid": "uuid456",
                    "shortName": "S001",
                    "name": "Sequence 001 - At sea",
                    "comment": "A comment",
                    "order": 1,
                    "projectUuid": "2d7d7e01-671c-11e7-a78f-4ccc6a288527",
                }
            ],
            "shots": [
                {
                    "uuid":"uuid456",
                    "shortName":"001",
                    "name":"Shot 001",
                    "comment":"A comment",
                    "duration": 3.2,
                    "order": 1,
                    "sequenceUuid": "uuid123",
                    "assetUuids": ["uuid111","uuid222"],
                    "statusHistory": [
                        {
                            "uuid":"uuid123",
                            "completionRatio": 0,
                            "comment":"To do",
                            "version": 0,
                            "date":"2021-06-23 12:35:23",
                            "userUuid":"uuid111",
                            "stateUuid":"uuid789",
                            "stepUuid":"uuid777",
                            "assignedUserUuid":"uuid888",
                            "published": 0,
                            "timeSpent": 3600,
                            "difficulty":"hard",
                            "estimation": 12.5,
                            "assetUuid":"uuid456"
                        }
                    ]
                }
            ],
            "schedule": [
                {
                    "uuid":"uuid23",
                    "date":"2021-06-13 12:00:00",
                    "comment":"A comment",
                    "userUuid":"uuid456",
                    "stepUuid":"uuid789",
                },
                {
                    "uuid":"uuid45",
                    "date":"2021-06-14 00:00:00",
                    "comment":"A comment",
                    "userUuid":"uuid456",
                    "stepUuid":"uuid789",
                }
            ],
            "scheduleComments": [
                {
                    "uuid":"uuid23",
                    "date":"2021-06-13 12:00:00",
                    "comment":"A comment",
                    "color":"#2345269",
                    "projectUuid":"uuid789",
                },
                {
                    "uuid":"uuid45",
                    "date":"2021-06-14 00:00:00",
                    "comment":"A comment",
                    "color":"#FF12BB",
                    "projectUuid":"uuid789",
                }
            ],
        }
}

getProjects

http://your.server/ramses/?getProjects

Retrieves the list of all projects.

Query attributes:

Reply content:

The server replies with an array of project information. Each project is an object with the following attributes:

The project objects also contain empty lists for the project content (shots, assets, etc.). To retrieve the content, use getProject for the given project.

Reply body:

{
    "accepted": true,
    "query": "getProjects",
    "success": true,
    "message": "Project list retrieved.",
    "content":  [
        {
            "name": "Mythomen",
            "shortName": "Mytho",
            "comment": "A comment",
            "uuid": "2d7d7e01-671c-11e7-a78f-4ccc6a288527",
            "folderPath": "PROJECTS/MYTHO",
            "framerate": 25.0,
            "width": 1920,
            "height": 1080,
            "aspectRatio": 1.78,
            "deadline": "2021-06-23",
            "users": ["uuid123", "uuid456"],
            "pipeFiles": [],
            "steps": [],
            "pipes": [],
            "assetGroups": [],
            "assets": [],
            "sequences": [],
            "shots": [],
            "schedule": []
        },
        {
            "name": "Purpleboy",
            "shortName": "PPB",
            "comment": "A comment",
            "uuid": "2d7d7e01-671c-11e7-a78f-4ccc6a288527",
            "folderPath": "PROJECTS/PPB",
            "framerate": 24.0,
            "width": 2048,
            "height": 858,
            "aspectRatio": 2.39,
            "deadline": "2020-05-15",
            "users": ["uuid123", "uuid456"],
            "pipeFiles": [],
            "steps": [],
            "pipes": [],
            "assetGroups": [],
            "assets": [],
            "sequences": [],
            "shots": [],
            "schedule": []
        }
    ]
}

updateProject

http://your.server/ramses/?updateProject

Updates project information.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "updateProject",
    "success": true,
    "message": "Project \"Mytho\" updated.",
    "content": { }
}

removeProject

http://your.server/ramses/?removeProject

Removes a project from the database.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "removeProject",
    "success": true,
    "message": "Project uuid123 removed.",
    "content": { }
}

assignStep

http://your.server/ramses/?assignStep

Assigns a template step to a project

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "assignStep",
    "success": true,
    "message": "Step uuid123 associated with project uuid456.",
    "content": { }
}

assignUser

http://your.server/ramses/?assignUser

Assigns a user to a project

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "assignUser",
    "success": true,
    "message": "User assigned to project.",
    "content": { }
}

unassignUser

http://your.server/ramses/?unassignUser

Unassigns a user to a project

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "unassignUser",
    "success": true,
    "message": "User unassigned from project.",
    "content": { }
}