collection.py¶

Collection requests.

collection.add_collection()[source]¶

Add a collection.

Returns

Json structure with the _id of the collection.

Return type

flask.Response

collection.delete_collection(identifier: str)[source]¶

Delete a collection.

Can be deleted only by an owner or user with DATA_MANAGEMENT permissions.

Parameters

identifier (str) – The collection uuid.

collection.get_collection(identifier)[source]¶

Retrieve the collection with uuid <identifier>.

Parameters

identifier (str) – uuid for the wanted collection

Returns

json structure for the collection

Return type

flask.Request

collection.get_collection_log(identifier: str = None)[source]¶

Get change logs for the collection matching identifier.

Can be accessed by editors (with DATA_EDIT) and admin (DATA_MANAGEMENT).

Deleted entries cannot be accessed.

Parameters

identifier (str) – The uuid of the collection.

Returns

Logs as json.

Return type

flask.Response

collection.list_collection()[source]¶

Provide a simplified list of all available collections.

collection.update_collection(identifier)[source]¶

Update a collection.

Parameters

identifier (str) – The collection uuid.

Returns

Status code.

Return type

flask.Response