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.
Back to TopResponse
Supported Media Types
- application/json
- application/swagger+json
200 Response
Following model is returned when operation succeeds.
Root Schema : getWebhookMetadata_response
Type:
Show Source
object
-
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
Nested Schema : info
Type:
Show Source
object
-
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
Example Response (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":[
"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|
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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