Wallet Endpoint

Added in version 2.3.

Developer Preview

The ESS Wallet Service endpoints are available as part of a Developer Preview program to allow early access to these features. Please be aware that these APIs may change.

The ESS Wallet Service provides the following endpoint for interacting with resources stored in the Data Wallet:

https://datawallet.{ESS Domain}/wallet

Note

To access the /wallet endpoint, users must be authenticated. The endpoint supports the use of HTTP-only, secure session cookies.

List Resources

The Wallet Service provides an endpoint that returns a list of all the resources stored in the Wallet.

Method	GET
Content-Type	application/json
Endpoint	https://datawallet.{ESS Domain}/wallet
Payload	none

Output

Returns an array list of resources with the following fields:

Example response

[
  {
    "fileName": "MyResource",
    "identifier": "https://storage.example/data/MyResource",
    "isRDFResource": true
  }
]

The fields have the following values

Field	Value
fileName	The short-name of the resource without the hostname or parent path.
identifier	The URI identifying the resource.
isRDFResource	Boolean value true|false indicating whether this resource is an RDF dataset.

Create/Update Resources

The Wallet Service provides an endpoint to create or update a resource stored in the Wallet.

Method	PUT
Content-Type	multipart/form-data
Endpoint	https://datawallet.{ESS Domain}/wallet
Payload	The binary resource to create or update within the Wallet.

Input

The endpoint accepts the name of the resource as a query parameter:

Query Parameter	Value
fileName	The name of the resource without hostname or parent path.

The body of the request contains the binary data for the resource to be created or updated.

Body	Value
Content-Type	multipart/form-data
file	The binary data of the file to create or update.

Output

Successful completion returns the URI of the created or updated resource.

Read Resource

The Wallet Service provides an endpoint to get the content of a Wallet resource.

Method	GET
Content-Type	*/*
Endpoint	https://datawallet.{ESS Domain}/wallet/{identifier}
Payload	none

Input

Path Parameter	Value
identifier	The filename of the Wallet resource from which content is to be returned.

Query Parameter	Value
raw	A boolean value determining whether to process the Wallet resource as binary data (true) or as RDF when applicable (false).

Output

The content of the identified resource.

Delete Resource

The Wallet Service provides an endpoint to delete a Wallet resource.

Method	DELETE
Content-Type	application/json
Endpoint	https://datawallet.{ESS Domain}/wallet/{identifier}
Payload	none

Input

Path Parameter	Value
identifier	The filename of the Wallet resource to be deleted.

Output

Upon completion, a status message is returned.

Example response

{
    "message": "success"
}

The fields have the following values:

Field	Value
message	A successful operation includes the string “success”.
error	An unsuccessful operation describes the failure category, such as “UNAUTHORIZED”.