Create handle service for given group (admin)
Creates a new handle service for group.
This operation requires group_create_handle_service privilege and
oz_handle_services_create admin privilege.
For administrator who does not belong to this group
oz_handle_services_create and oz_groups_add_relationships privileges are required.
Example cURL requests
Add group handle services
curl -u username:password -X POST -H "Content-type: application/json" \
-d '{ ... }' https://$ZONE_HOST/api/v3/onezone/groups/4ebd9efd1e67f6c18695db1d762a914a/handle_services
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string Group Id. |
Request body
The user defined name of the service.
The endpoint of the Handle service proxy, i.e. a service which implements logic specific for particular Handle service.
serviceProperties An abstract type for Handle identifier services properties.
An abstract type for Handle identifier services properties.
The type of handle service.
The type of handle service.
Request Examples
{
"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
}
}Responses
URI of the created space in form https://$ZONE_HOST/api/onezone/v3/groups/{id}/handle_services/{sid} is returned in the response Location header.
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."
}
}