Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get effective group handle details

GET /groups/{id}/effective_handles/{hid}

Returns the details of a specific effective handle.

This operation requires group_view privilege. For administrator who does not belong to this group oz_handles_view privilege is required.

Example cURL requests

Get effective handle details

curl -u username:password -X GET \
https://$ZONE_HOST/api/v3/onezone/groups/$GROUP_ID/effective_handles/$HANDLE_ID

{
  "publicHandle": "10.5072/w95Zlng",
  "handleId": "95b663a6467c72ab1256865efef9e387",
  "handleServiceId": "97c27230017cd54c1220189e357322c4",
  "resourceType": "Share",
  "resourceId": "d6ee1aecf03b23f09756d6a49e435455",
  "metadataSchema": "oai_dc",
  "metadata": "<?xml version=\"1.0\" encoding=\"utf-8\" ?>
    <metadata xmlns:dc=\"http://purl.org/dc/elements/1.1/\">
      <dc:title>Example Resource</dc:title>
      <dc:creator>John Doe</dc:creator>
      <dc:publisher>ACC Cyfronet AGH</dc:publisher>
      <dc:date>2024-06-15</dc:date>
    </metadata>",
  "timestamp": "1997-07-16T19:20",
  "creator": {
    "type": "user",
    "id": "7434b256e71e1052e0d5e3e9da657ebf"
  },
  "creationTime": 1576152793
}

Path parameters

Parameter Type & Description
id required
string

Group Id.
hid required
string

Handle Id.

Request Examples

Shell
onezone-rest-cli getEffectiveGroupHandle id=KLAJSHDjhkahsdkasjdKLHSALD hid=95b663a6467c72ab1256865efef9e387

Responses

application/json
200

Returns the details of a specific effective handle.

PropertyType & Description
handleId
string

Unique Id of the handle in Onedata.

handleServiceId
string

Id of the service through which the handle was registered.

publicHandle
string

Unique Id of the handle as registered in the handle service. Depending on the handle service, can be an Id (DOI: 10.5072/w95Zlng) or an URL (PID: http://hdl.handle.net/21.T15999/TgAl7s0).

resourceType
string

The type of resource to which the handle points - currently, only the Share type is supported.

Enum:
Share
resourceId
string

The Id of the resource to which the handle points (currently, always a share Id).

metadataSchema
string

Short keyword that indicates the schema of the metadata attached to the handle. The keywords are borrowed from the concept of metadataPrefix in the OAI-PMH protocol.

  • oai_dc - Dublin Core
  • oai_datacite - Datacite
  • edm - Europeana Data Model Each handle metadata schema can be disseminated using one or more OAI-PMH metadata prefixes, but each OAI-PMH metadata prefix has only one corresponding handle metadata schema.
Enum:
oai_dcoai_dataciteedm
metadata
string

Metadata (in XML format) compliant with the schema indicated by the metadata prefix.

timestamp
string

Timestamp of the last handle modification.

creator
object (Subject)

The creator of the handle. Not included in public handle details.

type
string

Type of the subject

Enum:
nobodyuseroneprovider
id
string

Id of the subject (null for nobody)

creationTime
integer (Timestamp)

Timestamp in seconds (UNIX epoch), e.g. 1563819329.

Example

application/json
{
  "handleId": "14208c48fe063d26fd45144b90977a56",
  "handleServiceId": "f480c4889db90d93996ee89d0ee5f8f0",
  "publicHandle": "10.5072/w95Zlng",
  "resourceType": "Share",
  "resourceId": "3d8cd457cef92ba08261bf1bb8d40438",
  "metadataSchema": "oai_dc",
  "metadata": "<?xml version=\\\"1.0\\\" encoding=\\\"utf-8\\\" ?> <metadata xmlns:dc=\\\"http://purl.org/dc/elements/1.1/\\\">\n  <dc:title>Example Resource</dc:title>\n  <dc:creator>John Doe</dc:creator>\n  <dc:publisher>ACC Cyfronet AGH</dc:publisher>\n  <dc:date>2024-06-15</dc:date>\n</metadata>\n",
  "timestamp": "2016-07-16T18:20:30.450Z",
  "creator": {
    "type": "user",
    "id": "7434b256e71e1052e0d5e3e9da657ebf"
  },
  "creationTime": 1576152793
}
400

Invalid request.

PropertyType & 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.

PropertyType & 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.

PropertyType & 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.

PropertyType & 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.

PropertyType & 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."
  }
}