Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get handle

GET /handles/{id}

Returns the properties of a specific handle.

This operation requires handle_view privilege or oz_handles_view admin privilege.

Example cURL requests

Get handle

curl -u username:password -X GET \
https://$HOST/api/v3/handles/$HANDLE_ID

{
  "handle": "10.5072/w95Zlng"
  "handleId": "95b663a6467c72ab1256865efef9e387",
  "handleServiceId": "97c27230017cd54c1220189e357322c4",
  "resourceType": "Share",
  "resourceId": "d6ee1aecf03b23f09756d6a49e435455",
  "metadata": "<?xml version=\"1.0\"?>
      <!DOCTYPE rdf:RDF SYSTEM \\"http://dublincore.org/2000/12/01-dcmes-xml-dtd.dtd\">
      <rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
               xmlns:dc=\"http://purl.org/dc/elements/1.1/\">
        <rdf:Description rdf:about=\"http://example.com/resouces/1\">
          <dc:title>Example Resource</dc:title>
          <dc:creator>John Doe</dc:creator>
          <dc:publisher>MIT</dc:publisher>
          <dc:date>2000-06-06</dc:date>
        </rdf:Description>
      </rdf:RDF>",
  "timestamp": "1997-07-16T19:20"
}

Path parameters

Parameter Type & Description
id required
string

The handle Id (internal Onedata GUID) of the identifier.

Request Examples

Shell
onezone-rest-cli getHandle id=45bf25a5cb16e12a9faa6d088a2c7088

Responses

application/json
200

The properties of a specific handle.

Property
Type & Description
handle
string

Unique Id of the handle as registered in the handle service.

handleId
string

Unique Id of the handle in Onedata.

handleServiceId
string

Id of the service where the handle was registered.

resourceType
string

The type of resource to be registered.

Enum:
Share
resourceId
string

The Onedata GUID of the resource to which the handle should be resolved.

metadata
string

Dublin Core metadata for the resource encoded in XML.

timestamp
string

Handle registration timestamp.

Example

application/json
{
  "handle": "10.5072/w95Zlng",
  "handleId": "14208c48fe063d26fd45144b90977a56",
  "resourceType": "Share",
  "resourceId": "3d8cd457cef92ba08261bf1bb8d40438",
  "handleServiceId": "f480c4889db90d93996ee89d0ee5f8f0",
  "metadata": "<?xml version=\\\"1.0\\\"?> <!DOCTYPE rdf:RDF SYSTEM \\\\\"http://dublincore.org/2000/12/01-dcmes-xml-dtd.dtd\\\"> <rdf:RDF xmlns:rdf=\\\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\\\"\n         xmlns:dc=\\\"http://purl.org/dc/elements/1.1/\\\">\n  <rdf:Description rdf:about=\\\"http://example.com/resouces/1\\\">\n    <dc:title>Example Resource</dc:title>\n    <dc:creator>John Doe</dc:creator>\n    <dc:publisher>MIT</dc:publisher>\n    <dc:date>2000-06-06</dc:date>\n  </rdf:Description>\n</rdf:RDF>\n",
  "timestamp": "2016-07-16T18:20:30.450Z"
}
400

Invalid request.

Property
Type & Description
error
object

Object describing an error.
id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
401

Authentication error.

Property
Type & Description
error
object

Object describing an error.
id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
403

Authorization error.

Property
Type & Description
error
object

Object describing an error.
id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
404

Resource not found.

Property
Type & Description
error
object

Object describing an error.
id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
500

Internal server Error.

Property
Type & Description
error
object

Object describing an error.
id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}