Aquarius v0.2.2past versions

Aquarius provides an off-chain database store for metadata about data assets. When running with our Docker images, it is exposed under:http://0.0.0.0:5000.

/assets

get

Get all asset IDs.

Responses

200 successful action

/assets/ddo

delete

Retire metadata of all the assets.

Responses

200 successfully deleted
500 Error

get

Get DDO of all assets.

Responses

200 successful action

post

Register DDO of a new asset

Parameters

body*

DDO of the asset.

{
"@context": "https://w3id.org/future-method/v1",
"authentication": [ { "type": "RsaSignatureAuthentication2018" }, { "publicKey": "did:op:123456789abcdefghi#keys-1" } ],
"created": "2016-02-08T16:02:20Z",
"id": "did:op:123456789abcdefghi",
"proof": ,
"publicKey": [ { "id": "did:op:123456789abcdefghi#keys-1" }, { "type": "Ed25519VerificationKey2018" }, { "owner": "did:op:123456789abcdefghi" }, { "publicKeyBase58": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV" } ],
"service": [ { "serviceEndpoint": "http://mybrizo.org/api/v1/brizo/services/consume?pubKey=${ pubKey}&serviceId={serviceId}&url={url}", "type": "Access" }, { "serviceEndpoint": "http://mybrizo.org/api/v1/brizo/services/compute?pubKey=${ pubKey}&serviceId={serviceId}&algo={algo}&container={container}", "type": "Compute" }, { "metadata": { "additionalInformation": { "structuredMarkup": [ { "mediaType": "application/ld+json", "uri": "http://skos.um.es/unescothes/C01194/jsonld" }, { "mediaType": "text/turtle", "uri": "http://skos.um.es/unescothes/C01194/turtle" } ], "updateFrecuency": "yearly" }, "base": { "author": "Met Office", "checksum": "38803b9e6f04fce3fba4b124524672592264d31847182c689095a081c9e85262", "compression": "zip", "copyrightHolder": "Met Office", "dateCreated": "2012-02-01T10:55:11Z", "description": "Weather information of UK including temperature and humidity", "encryptedFiles": "0x098213xzckasdf089723hjgdasfkjgasfv", "files": [ { "compression": "zip", "contentLength": "4535431", "contentType": "text/csv", "encoding": "UTF-8", "resourceId": "access-log2018-02-13-15-17-29-18386C502CAEA932" } ], "inLanguage": "en", "license": "CC-BY", "links": [ { "name": "Sample of Asset Data", "type": "sample", "url": "https://foo.com/sample.csv" }, { "AssetID": "4d517500da0acb0d65a716f61330969334630363ce4a6a9d39691026ac7908ea", "name": "Data Format Definition", "type": "format" } ], "name": "UK Weather information 2011", "price": 10, "tags": "weather, uk, 2011, temperature, humidity", "type": "dataset", "workExample": "stationId,latitude,longitude,datetime, temperature,humidity/n423432fsd,51.509865,-0.118092, 2011-01-01T10:55:11+00:00,7.2,68" }, "curation": { "numVotes": 123, "rating": 0.93, "schema": "Binary Voting" } }, "serviceDefinitionId": "2", "serviceEndpoint": "http://myaquarius.org/api/v1/provider/assets/metadata/{did}", "type": "Metadata" } ],
}

Responses

201 Asset successfully registered.
400 One of the required attributes is missing.
404 Invalid asset data.
500 Error

/assets/ddo/query

get

Get a list of DDOs that match with the given text.

Parameters

text*string

ID of the asset.

sortobject

Key or list of keys to sort the result

offsetint

Number of records per page

pageint

Page showed

Responses

200 successful action

post

Get a list of DDOs that match with the executed query.

Parameters

body*

Asset metadata.

{
"offset": ,
"page": ,
"query": "[object Object]",
"sort": { "value": 1 },
}

Responses

200 successful action

/assets/ddo/validate

post

Validate metadata content.

Parameters

body*

Asset metadata.

{}

Responses

200 successfully request.
500 Error

/assets/ddo/{did}

delete

Retire metadata of an asset

Parameters

did*string

DID of the asset.

Responses

200 successfully deleted
404 This asset DID is not in OceanDB
500 Error

get

Get DDO of a particular asset.

Parameters

did*string

DID of the asset.

Responses

200 successful operation
404 This asset DID is not in OceanDB

put

Update DDO of an existing asset

Parameters

body*

DDO of the asset.

{
"@context": "https://w3id.org/future-method/v1",
"authentication": [ { "type": "RsaSignatureAuthentication2018" }, { "publicKey": "did:op:123456789abcdefghi#keys-1" } ],
"created": "2016-02-08T16:02:20Z",
"id": "did:op:123456789abcdefghi",
"proof": ,
"publicKey": [ { "id": "did:op:123456789abcdefghi#keys-1" }, { "type": "Ed25519VerificationKey2018" }, { "owner": "did:op:123456789abcdefghi" }, { "publicKeyBase58": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV" } ],
"service": [ { "serviceEndpoint": "http://mybrizo.org/api/v1/brizo/services/consume?pubKey=${ pubKey}&serviceId={serviceId}&url={url}", "type": "Access" }, { "serviceEndpoint": "http://mybrizo.org/api/v1/brizo/services/compute?pubKey=${ pubKey}&serviceId={serviceId}&algo={algo}&container={container}", "type": "Compute" }, { "metadata": { "additionalInformation": { "structuredMarkup": [ { "mediaType": "application/ld+json", "uri": "http://skos.um.es/unescothes/C01194/jsonld" }, { "mediaType": "text/turtle", "uri": "http://skos.um.es/unescothes/C01194/turtle" } ], "updateFrecuency": "yearly" }, "base": { "author": "Met Office", "checksum": "38803b9e6f04fce3fba4b124524672592264d31847182c689095a081c9e85262", "compression": "zip", "copyrightHolder": "Met Office", "dateCreated": "2012-02-01T10:55:11Z", "description": "Weather information of UK including temperature and humidity", "encryptedFiles": "0x098213xzckasdf089723hjgdasfkjgasfv", "files": [ { "compression": "zip", "contentLength": "4535431", "contentType": "text/csv", "encoding": "UTF-8", "resourceId": "access-log2018-02-13-15-17-29-18386C502CAEA932" } ], "inLanguage": "en", "license": "CC-BY", "links": [ { "name": "Sample of Asset Data", "type": "sample", "url": "https://foo.com/sample.csv" }, { "AssetID": "4d517500da0acb0d65a716f61330969334630363ce4a6a9d39691026ac7908ea", "name": "Data Format Definition", "type": "format" } ], "name": "UK Weather information 2011", "price": 10, "tags": "weather, uk, 2011, temperature, humidity", "type": "dataset", "workExample": "stationId,latitude,longitude,datetime, temperature,humidity/n423432fsd,51.509865,-0.118092, 2011-01-01T10:55:11+00:00,7.2,68" }, "curation": { "numVotes": 123, "rating": 0.93, "schema": "Binary Voting" } }, "serviceDefinitionId": "2", "serviceEndpoint": "http://myaquarius.org/api/v1/provider/assets/metadata/{did}", "type": "Metadata" } ],
}

Responses

200 Asset successfully updated.
201 Asset successfully registered.
400 One of the required attributes is missing.
404 Invalid asset data.
500 Error

/assets/metadata/{did}

get

Get metadata of a particular asset

Parameters

did*string

DID of the asset.

Responses

200 successful operation.
404 This asset DID is not in OceanDB.