Step queries

getStep

Returns a step.

Query attributes

Reply content

The Daemon replies with more information about the step.

Example

Query:
getStep&shortName=RIG

Reply:

{
    "accepted": true,
    "query": "getStep",
    "success": true,
    "message": "Step retrived.",
    "content": {
            "shortName": "RIG",
            "name": "Rigging",
            "folder": "/path/to/RIG",
            "type": "ASSET_PRODUCTION",
            "color": [0.5, 0.5, 0.5]
        }
}

getSteps

Returns the list of available steps for the current project.

Query attributes

Reply content

The Daemon replies with the list of Steps.

Example

Query:
getSteps

Reply:

{
    "accepted": true,
    "query": "getSteps",
    "success": true,
    "message": "Step list retrived.",
    "content": {
        "steps": [
            {
                "shortName": "RIG",
                "name": "Rigging",
                "folder": "/path/to/RIG",
                "type": "ASSET_PRODUCTION"
            },
            {
                "shortName": "ANIM",
                "name": "Animation",
                "folder": "/path/to/ANIM",
                "type": "SHOT_PRODUCTION"
            }
        ]
    }
}

setPublishSettings

Sets new publish settings for the step.

Query attributes

Reply content

None.

Example

Query:
setPublishSettings&shortName=MOD&name=Modeling&settings=great settings

Reply:

{
    "accepted": true,
    "query": "setPublishSettings",
    "success": true,
    "message": "Settings set.",
}