Create handle service (admin)
Creates a new handle service.
This operation requires oz_handle_services_create admin privilege.
See also:
Example cURL requests
Add handle services
curl -u username:password -X POST -H "Content-type: application/json" \
-d '{ ... }' https://$ZONE_HOST/api/v3/onezone/handle_services
Request body
Handle service Id.
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.
creator Object representing a subject in the system, can be perceived as client (actor) identity.
Object representing a subject in the system, can be perceived as client (actor) identity.
Type of the subject
Id of the subject (null for nobody)
Timestamp in seconds (UNIX epoch), e.g. 1563819329.
Request Examples
{
"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
},
"creator": {
"type": "user",
"id": "7434b256e71e1052e0d5e3e9da657ebf"
},
"creationTime": 1576152793
}Responses
URI of the created handle service in form https://$ZONE_HOST/api/onezone/v3/handle_services/{id} 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."
}
}