REST API for Oracle Commerce Cloud December 2017

getMetadataCatalog

get

/ccstore/v1/metadata-catalog

Get Metadata Catalog. Returns metadata catalog. Returns Swagger metadata catalog.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getMetadataCatalog_response

Type: object

Properties

basePath: Type: string

The base path on which the API is served, which is relative to the host.
definitions: Type: object definitions

Additional Properties Allowed:
host: Type: string

The host (name or ip) serving the API.
info: Type: object info

Additional Properties Allowed:
paths: Type: object paths

Additional Properties Allowed:
schemes: Type: array schemes

Additional Properties Allowed:
swagger: Type: string

Specifies the Swagger Specification version being used.
tags: Type: array tags

Additional Properties Allowed:

Nested Schema : definitions

Type: object

Properties

EntityDefinition: Type: object EntityDefinition

Additional Properties Allowed:

Nested Schema : info

Type: object

Properties

description: Type: string

A short description of the application.
title: Type: string

The title of the application.
version: Type: string

Provides the version of the application API

Nested Schema : paths

Type: object

Properties

/path1/path2: Type: object /path1/path2

Additional Properties Allowed:

Nested Schema : schemes

Type: array

Items

Type: string

The transfer protocol of the API.

Nested Schema : tags

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : EntityDefinition

Type: object

Properties

Nested Schema : /path1/path2

Type: object

Properties

Nested Schema : items

Type: object

Properties

description: Type: string

A short description for the tag.
name: Type: string

The name of the tag.

Example application/json


{
    "basePath":"/ccstore/v1",
    "paths":{
        "/metadata/{id}":{
            "get":{
                "summary":"getMetadata",
                "produces":[
                    "application/json"
                ],
                "operationId":"getMetadata",
                "description":"Get Metadata. Get the metadata information for an item descriptor by ID.",
                "responses":{
                    "200":{
                        "description":"Following model is returned when operation succeeds."
                    }
                },
                "parameters":[
                    {
                        "in":"path",
                        "name":"id",
                        "description":"The ID of the itemType.",
                        "type":"string",
                        "required":true
                    }
                ],
                "tags":[
                    "Store/Metadata"
                ]
            }
        }
    },
    "definitions":{
        "getMetadata_response":{
            "properties":{
                "items":{
                    "description":"An array of metadata/ properties information for an item descriptor.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "editableAttributes":{
                                "description":"List of attributes of the property which can be edited from UI.",
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "swagger":"2.0",
    "info":{
        "description":"Metadata endpoints",
        "title":"Metadata",
        "version":"1.0"
    }
}

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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "basePath": "/ccstore/v1",
  "paths": {"/metadata/{id}": {"get": {
    "summary": "getMetadata",
    "produces": ["application/json"],
    "operationId": "getMetadata",
    "description": "Get Metadata. Get the metadata information for an item descriptor by ID.",
    "responses": {"200": {"description": "Following model is returned when operation succeeds."}},
    "parameters": [{
      "in": "path",
      "name": "id",
      "description": "The ID of the itemType.",
      "type": "string",
      "required": true
    }],
    "tags": ["Metadata"]
  }}},
  "definitions": {"getMetadata_response": {"properties": {"items": {
    "description": "An array of metadata/ properties information for an item descriptor.",
    "type": "array",
    "items": {
      "type": "object",
      "properties": {"editableAttributes": {
        "description": "List of attributes of the property which can be edited from UI.",
        "type": "array",
        "items": {"type": "string"}
      }}
    }
  }}}},
  "swagger": "2.0",
  "info": {
    "description": "Metadata endpoints",
    "title": "Metadata",
    "version": "1.0"
  }
}