Jump to

• Request
• Response

getMetadataCatalog

get

/ccagent/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.

Back to Top

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

Show Source

• basePath(optional): string
  The base path on which the API is served, which is relative to the host.
• definitions(optional): object definitions
• host(optional): string
  The host (name or ip) serving the API.
• info(optional): object info
• paths(optional): object paths
• schemes(optional): array schemes
• swagger(optional): string
  Specifies the Swagger Specification version being used.
• tags(optional): array tags

{
    "type":"object",
    "properties":{
        "basePath":{
            "description":"The base path on which the API is served, which is relative to the host.",
            "type":"string"
        },
        "paths":{
            "type":"object",
            "properties":{
                "/path1/path2":{
                    "type":"object",
                    "properties":{
                    }
                }
            }
        },
        "host":{
            "description":"The host (name or ip) serving the API.",
            "type":"string"
        },
        "schemes":{
            "type":"array",
            "items":{
                "description":"The transfer protocol of the API.",
                "type":"string"
            }
        },
        "definitions":{
            "type":"object",
            "properties":{
                "EntityDefinition":{
                    "type":"object",
                    "properties":{
                    }
                }
            }
        },
        "swagger":{
            "description":"Specifies the Swagger Specification version being used.",
            "type":"string"
        },
        "info":{
            "type":"object",
            "properties":{
                "description":{
                    "description":"A short description of the application. ",
                    "type":"string"
                },
                "title":{
                    "description":"The title of the application.",
                    "type":"string"
                },
                "version":{
                    "description":"Provides the version of the application API",
                    "type":"string"
                }
            }
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"The name of the tag.",
                        "type":"string"
                    },
                    "description":{
                        "description":"A short description for the tag.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : definitions

Type: object

Show Source

• EntityDefinition(optional): object EntityDefinition

{
    "type":"object",
    "properties":{
        "EntityDefinition":{
            "type":"object",
            "properties":{
            }
        }
    }
}

Nested Schema : info

Type: object

Show Source

• description(optional): string
  A short description of the application.
• title(optional): string
  The title of the application.
• version(optional): string
  Provides the version of the application API

{
    "type":"object",
    "properties":{
        "description":{
            "description":"A short description of the application. ",
            "type":"string"
        },
        "title":{
            "description":"The title of the application.",
            "type":"string"
        },
        "version":{
            "description":"Provides the version of the application API",
            "type":"string"
        }
    }
}

Nested Schema : paths

Type: object

Show Source

• /path1/path2(optional): object /path1/path2

{
    "type":"object",
    "properties":{
        "/path1/path2":{
            "type":"object",
            "properties":{
            }
        }
    }
}

Nested Schema : schemes

Type: array

Show Source

• Array of: string
  The transfer protocol of the API.

{
    "type":"array",
    "items":{
        "description":"The transfer protocol of the API.",
        "type":"string"
    }
}

Nested Schema : tags

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"The name of the tag.",
                "type":"string"
            },
            "description":{
                "description":"A short description for the tag.",
                "type":"string"
            }
        }
    }
}

Nested Schema : EntityDefinition

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : /path1/path2

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : items

Type: object

Show Source

• description(optional): string
  A short description for the tag.
• name(optional): string
  The name of the tag.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"The name of the tag.",
            "type":"string"
        },
        "description":{
            "description":"A short description for the tag.",
            "type":"string"
        }
    }
}

Example Response (application/swagger+json)

{
    "basePath":"/ccagent/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"
    }
}

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

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top