Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get effective group handle service details

GET /groups/{id}/effective_handle_services/{hsid}

Returns the details of a specific effective handle service.

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

Example cURL requests

Get effective handle service details

curl -u username:password -X GET \
https://$HOST/api/v3/onezone/groups/$GROUP_ID/effective_handle_services/$HANDLE_SERVICE_ID

{
    "handleServiceId": "0fe7c8a20ffdf07480c46f084bc3b8d5",
    "name": "MyCommunity Handle service",
    "proxyEndpoint": "https://localhost:17000/handle_proxy",
    "serviceProperties": {
        "allowTemplateOverride": false,
        "doiEndpoint": "/doi",
        "host": "https://mds.test.datacite.org",
        "identifierTemplate": "{{space.name}}-{{space.guid}}",
        "mediaEndpoint": "/media",
        "metadataEndpoint": "/metadata",
        "password": "pa$$word",
        "prefix": 10.5072,
        "type": "DOI",
        "username": "alice"
    }
}

Path parameters

Parameter	Type & Description
id required	string Group Id.
hsid required	string Handle service Id.

Request Examples

Shell

onezone-rest-cli getEffectiveGroupHandleService id=9f63efbd952391af88e096c2bb33bb5d hsid=0fe7c8a20ffdf07480c46f084bc3b8d5

Responses

application/json

200

The handle service details have been returned successfully.

Property

Type & Description

handleServiceId

string

Handle service Id.

name

string

The user defined name of the service.

proxyEndpoint

string

The endpoint of the Handle service proxy, i.e. a service which implements logic specific for particular Handle service.

serviceProperties

object (HandleServiceProperties)

An abstract type for Handle identifier services properties.

type required

discriminator string

The type of handle service.

Example

application/json

{
  "handleServiceId": "cdca849d2b71bc7205f3eab686cf62fb",
  "name": "MyCommunity Handle service",
  "proxyEndpoint": "https://localhost:17000/handle_proxy",
  "serviceProperties": {
    "type": "DOI",
    "host": "https://mds.test.datacite.org",
    "doiEndpoint": "/doi",
    "metadataEndpoint": "/metadata",
    "mediaEndpoint": "/media",
    "prefix": 10.5072,
    "username": "alice",
    "password": "pa$$word",
    "identifierTemplate": "{{space.name}}-{{space.guid}}",
    "allowTemplateOverride": false
  }
}

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