1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Admin Metadata Catalog

getWebhookMetadata

get

/ccadmin/v1/metadata-catalog/webhook

Get Webhook Metadata. Returns webhoook metadata catalog. Returns metadata catalog. Returns Swagger webhook 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 : getWebhookMetadata_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

{
    "basePath":"/ccadmin/v1/webhook",
    "paths":{
        "/idleCart":{
            "post":{
                "summary":"idleCart",
                "produces":[
                    "application/json"
                ],
                "operationId":"idleCart",
                "description":"The details of idle cart in the Oracle Commerce Cloud",
                "responses":{
                    "200":{
                        "schema":{
                            "ref":"#/definitions/emptyResponse"
                        },
                        "description":"No response is returned as this is an event webhook"
                    }
                },
                "parameters":[
                    {
                        "schema":{
                            "ref":"#/definitions/idleCart_request"
                        },
                        "in":"body",
                        "name":"idleCart"
                    }
                ],
                "tags":[
                    "Admin/Idle Cart"
                ]
            }
        }
    },
    "host":"localhost:9080",
    "schemes":[
        "http"
    ],
    "definitions":{
        "idleCart_request":{
            "description":"The details of the idle cart",
            "properties":{
                "taxPriceInfo":{
                    "description":"The shipping address details.",
                    "type":"object",
                    "properties":{
                        "cityTax":{
                            "description":"City Tax",
                            "type":"number"
                        },
                        "districtTax":{
                            "description":"District Tax.",
                            "type":"number"
                        }
                    }
                }
            }
        }
    },
    "swagger":"2.0",
    "tags":[
        {
            "name":"Idle Cart",
            "description":"The details of idle cart in the Oracle Commerce Cloud"
        }
    ],
    "info":{
        "description":"The Webhook details of the Oracle Commerce Cloud.",
        "title":"Oracle Commerce Cloud Webhooks",
        "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
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object