getWebHookResourceMetadata
get
/ccadmin/v1/metadata-catalog/webhook/{id}
Get Web Hook Resource Metadata. Returns metadata catalog of a webhook resource. The response will be in hyper schema format. The **JSON hyper schema** being served is **deprecated**. Use Swagger.
Request
Supported Media Types
- application/json
Path Parameters
- id
-
Type:
stringRequired:trueThe ID of the resource
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getWebHookResourceMetadata_response
- $schema
-
Type:
stringlocation of schema for the given resource - definitions
-
Type:
objectdefinitionsrespective properties of the resource - description
-
Type:
stringdescription of the resource being retrieved - title
-
Type:
stringtitle of metadata resource - token
-
Type:
stringThe auth token for the Endpoint - type
-
Type:
stringtype of metadata resource
Nested Schema : definitions
Type:
objectrespective properties of the resource
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- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - errors
-
Type:
arrayerrorsAn optional list of errors if multiple errors were encountered - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code - type
-
Type:
stringThe URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code