1. Oracle Commerce Cloud October 2017
  2. Tasks
  3. Admin
  4. Admin Metadata Catalog

getMetadataCatalog

get

/ccadmin/v1/metadata-catalog

Get Metadata Catalog. Returns metadata catalog. Returns Swagger metadata catalog when 'Accept' request header is specified as 'application/swagger+json' else will return json hyper schema docs. The **JSON hyper schema** being served is **deprecated**. Use Swagger.

Request

There are no request parameters for this operation.

Response

Supported Media Types
  • application/json
  • application/swagger+json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getMetadataCatalog_response
Type: object
Nested Schema : definitions
Type: object
Nested Schema : info
Type: object
Nested Schema : paths
Type: object
Nested Schema : schemes
Type: array
Nested Schema : tags
Type: array
Nested Schema : EntityDefinition
Type: object
Nested Schema : /path1/path2
Type: object
Nested Schema : items
Type: object
Example application/swagger+json

{
    "items":[
        {
            "name":"profiles",
            "links":[
                {
                    "rel":"alternate",
                    "href":"http://localhost:9080/ccadmin/v1/metadata-catalog/profiles",
                    "mediaType":"application/schema+json"
                },
                {
                    "rel":"canonical",
                    "href":"http://localhost:9080/ccadmin/v1/metadata-catalog/profiles",
                    "mediaType":"application/schema+json"
                },
                {
                    "rel":"describes",
                    "href":"http://localhost:9080/ccadmin/v1/profiles"
                }
            ]
        },
        {
            "name":"orders",
            "links":[
                {
                    "rel":"alternate",
                    "href":"http://localhost:9080/ccadmin/v1/metadata-catalog/orders",
                    "mediaType":"application/schema+json"
                },
                {
                    "rel":"canonical",
                    "href":"http://localhost:9080/ccadmin/v1/metadata-catalog/orders",
                    "mediaType":"application/schema+json"
                },
                {
                    "rel":"describes",
                    "href":"http://localhost:9080/ccadmin/v1/orders"
                }
            ]
        }
    ],
    "links":[
        {
            "href":"http://localhost:9080/ccadmin/v1/metadata-catalog/",
            "rel":"self"
        }
    ]
}
Default Response
The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |13101|METADATA INTERNAL ERROR|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object