META

Queries for managing pipes

Pipes are the connections between Steps which form the pipeline.

Hint

There is no method to retrieve pipes directly; pipes are returned by the project method getProject

createPipe

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

Creates a new pipe in the database.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "createPipe",
    "success": true,
    "message": "Pipe created.",
    "content": { }
}

updatePipe

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

Update pipe info in the database.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "updatePipe",
    "success": true,
    "message": "Pipe updated.",
    "content": { }
}

removePipe

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

Removes a pipe group from the database.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "removePipe",
    "success": true,
    "message": "Pipe removed.",
    "content": { }
}

assignPipeFile

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

Assigns a pipe file type to a pipe.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "assignPipeFile",
    "success": true,
    "message": "New File assigned to pipe.",
    "content": { }
}

unassingPipeFile

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

Unassigns a pipe file type from a pipe.

Query attributes:

Reply content:

Empty

Reply body:

{
    "accepted": true,
    "query": "unassignFileType",
    "success": true,
    "message": "File removed from pipe.",
    "content": { }
}