Get Metadata API Catalog
get
/documents/api/{version}/metadata-catalog/metadata
Return API catalog information for the metadata resource, including supported services.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
version: string
Version value
Response
Supported Media Types
- application/json
- application/xml
200 Response
The request was fulfilled. Response includes links to supported services.
Examples
The following example returns API catalog information for the metadata resource, including supported services.
GET .../api/1.2/metadata-catalog/metadata/
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{
"$schema": "http://json-schema.org/schema#",
"type": "object",
"properties": {
"links": {
"type": "array",
"items": {
"$ref": "rest-schemas/link#"
}
}
},
"links": [
{
"rel": "describedBy",
"href": "http://service1-tenant2.local:8080/documents/api/1.2/metadata-catalog/metadata"
},
{
"rel": "self",
"href": "http://service1-tenant2.local:8080/documents/api/1.2/metadata-catalog/metadata"
},
{
"rel": "get-available-metadata-collection",
"href": "http://service1-tenant2.local:8080/documents/api/1.2/metadata",
"method": "GET"
},
{
"rel": "create-metadata-collection",
"href": "http://service1-tenant2.local:8080/documents/api/1.2/metadata/{metadata-collection-id}",
"method": "POST"
},
{
"rel": "edit-metadata-collection",
"href": "http://service1-tenant2.local:8080/documents/api/1.2/metadata/{metadata-collection-id}",
"method": "PUT"
},
{
"rel": "get-metadata-collection",
"href": "http://service1-tenant2.local:8080/documents/api/1.2/metadata/{metadata-collection-id}",
"method": "GET"
},
{
"rel": "delete-metadata-collection",
"href": "http://service1-tenant2.local:8080/documents/api/1.2/metadata/{metadata-collection-id}",
"method": "DELETE"
},
{
"rel": "edit-metadata-fields",
"href": "http://service1-tenant2.local:8080/documents/api/1.2/metadata/{metadata-collection-id}/field",
"method": "PUT"
},
{
"rel": "get-metadata-searchable-fields",
"href": "<?rootHttpPath?>metadata/searchFields",
"method": "GET"
},
{
"rel": "set-metadata-searchable-fields",
"href": "<?rootHttpPath?>metadata/searchFields",
"method": "POST"
}
]
}