Get effective handle details
Returns information about a specific effective handle to which the user has access.
This operation can be invoked on behalf of the current user only.
Example cURL requests
Get user effective handle
curl -u username:password -X GET \
https://$ZONE_HOST/api/v3/onezone/user/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 |
|---|---|
| hid required | string Handle Id. |
Request Examples
onezone-rest-cli getUserEffectiveHandle hid=95b663a6467c72ab1256865efef9e387Responses
Returns the information about a specific effective handle.
Unique Id of the handle in Onedata.
Id of the service through which the handle was registered.
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).
The type of resource to which the handle points - currently, only the Share type is supported.
The Id of the resource to which the handle points (currently, always a share Id).
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 Coreoai_datacite- Dataciteedm- 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.
Metadata (in XML format) compliant with the schema indicated by the metadata prefix.
Timestamp of the last handle modification.
creator The creator of the handle.
Not included in public handle details.
The creator of the handle. Not included in public handle details.
Type of the subject
Id of the subject (null for nobody)
Timestamp in seconds (UNIX epoch), e.g. 1563819329.
Example
{
"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
}Invalid request.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authentication error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authorization error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Resource not found.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Internal server Error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}