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
• Response

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

Properties

basePath

Type: string

The base path on which the API is served, which is relative to the host.

definitions

Type: object definitions

host

Type: string

The host (name or ip) serving the API.

info

Type: object info

paths

Type: object paths

schemes

Type: array schemes

swagger

Type: string

Specifies the Swagger Specification version being used.

tags

Type: array tags

Nested Schema : definitions

Type: object

Properties

EntityDefinition

Type: object EntityDefinition

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

Nested Schema : schemes

Type: array

Items

• Type: string
  The transfer protocol of the API.

Nested Schema : tags

Type: array

Items

• Type: object items

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.

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

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

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