META

Queries for managing steps

Note

The API also provides an access to “template steps” which can be assigned to projects. The calls are exactly the same except you have to insert the “Template” word (e.g. use createTemplateStep instead of createStep)

Hint

There is no method to retrive steps directly; steps are returned by the project method getProjects

createStep

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

Creates a new step in the database and assigns it to a project.

Query attributes:

Note

When creating a template step with createTemplateStep, omit the projectUuid attribute.

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "createStep",
    "success": true,
    "message": "Step \"RIG\" created.",
    "content": { }
}

updateStep

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

Update step info in the database.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "updateStep",
    "success": true,
    "message": "Step \"RIG\" updated.",
    "content": { }
}

setStepOrder

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

Moves a step in the list. This method changes only the order value of the given step.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "setStepOrder",
    "success": true,
    "message": "Step moved.",
    "content": { }
}

moveStep

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

Moves a step in the list. This method will update the order of all the other steps of the same project accordingly.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "moveStep",
    "success": true,
    "message": "Step moved.",
    "content": { }
}

removeStep

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

Removes a step from the database.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "removeStep",
    "success": true,
    "message": "Step uuid123 removed.",
    "content": { }
}

setStepEstimations

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

Updates the default estimations for this step

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "setStepEstimations",
    "success": true,
    "message": "Step updated.",
    "content": { }
}

assignApplication

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

Assigns an application to a step.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "assignApplication",
    "success": true,
    "message": "Application assigned to step.",
    "content": { }
}

unassignApplication

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

Unassigns an application from a step.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "unassignApplication",
    "success": true,
    "message": "Application unassigned from step.",
    "content": { }
}