Get Configuration API Catalog
get
/documents/api/{version}/metadata-catalog/configuration
Return API catalog information for the configuration 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 configuration resource, including supported services.
GET .../api/1.2/metadata-catalog/configuration
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{
"$schema": "http://json-schema.org/schema#",
"type": "object",
"properties": {
"cListURL": {
"type": "string",
"description": "Collaboration cList URL."
},
"clientURL": {
"type": "string",
"description": "Collaboration client URL."
},
"oAuthCListURL": {
"type": "string",
"description": "Collaboration OAuth cList URL."
},
"oAuthClientURL": {
"type": "string",
"description": "Collaboration OAuth client URL."
},
"restURL": {
"type": "string",
"description": "Collaboration REST URL."
},
"serviceURL": {
"type": "string",
"description": "Collaboration Service URL."
},
"domain": {
"type": "string",
"description": "The URL for the CDN."
},
"description": {
"type": "string",
"description": "The description of the CDN."
},
"links": {
"type": "array",
"items": {
"$ref": "rest-schemas/link#"
}
}
},
"links": [
{
"rel": "describedBy",
"href": "http://service1-tenant1:8080/documents/api/1.2/metadata-catalog/configuration"
},
{
"rel": "self",
"href": "http://service1-tenant1:8080/documents/api/1.2/metadata-catalog/configuration"
},
{
"rel": "get-collaboration-configuration",
"href": "http://service1-tenant1:8080/documents/api/1.2/config/collaboration",
"method": "GET"
},
{
"rel": "get-deliverycdn-configuration",
"href": "http://service1-tenant1:8080/documents/api/1.2/config/sites/deliverycdn",
"method": "GET"
}
]
}