REST API - Grids

iceprod.rest.handlers.grids.setup(handler_cfg)[source]

Setup method for Grids REST API.

Parameters:

handler_cfg (dict) – args to pass to the route

Returns:

routes, database, indexes

Return type:

dict

class iceprod.rest.handlers.grids.MultiGridsHandler(*args, **kwargs)[source]

Handle multi grids requests.

async get()[source]

Get grid entries.

Returns:

{‘uuid’: {grid_data}}

Return type:

dict

async post()[source]

Create a grid entry.

Body should contain the grid data.

Returns:

{‘result’: <grid_id>}

Return type:

dict

class iceprod.rest.handlers.grids.GridsHandler(*args, **kwargs)[source]

Handle single grid requests.

async get(grid_id)[source]

Get a grid entry.

Parameters:

grid_id (str) – the grid id

Returns:

grid entry

Return type:

dict

async patch(grid_id)[source]

Update a grid entry.

Body should contain the grid data to update. Note that this will perform a merge (not replace).

Parameters:

grid_id (str) – the grid id

Returns:

updated grid entry

Return type:

dict