REST API for Oracle Commerce Cloud December 2017

functionWebHookOperation

post

/ccadmin/v1/functionWebhooks/{id}

Function Web Hook Operation. Perform an operation on a function WebHook, like reset the secret key of a specific WebHook with the help of provided ID.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

ID corresponding to the WebHook whose secret key is to be reset.

Body Parameter

Root Schema : functionWebHookOperation_request

Example


{
    "op":"resetSecretKey"
}

Properties

op: Type: string

Required: true

The operation to perform. Valid values are: resetSecretKey

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : functionWebHookOperation_response

Properties

id: Type: string

WebHook identifier.
secretKey: Type: string

The base64 encoded secret key of the WebHook. A secret key is currently shared between WebHooks of the same name (like "calculateShipping"). The secret key will have a non-null value only if the authentication method was previously chosen as secret key.

Example application/json


{
    "secretKey":"jCFq0IhpO7Qk7Fr5H3tHpMckhroKRhiTcMR15PKywH9B8QoA4lRgDaoSg46mAh+W4z3G2c1dHeVEOgMaMIBjUA==",
    "id":"production-calculateShipping"
}

Default Response

The error response

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

Additional Properties Allowed:

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

Additional Properties Allowed:

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

Examples

Sample Request:

{"op": "resetSecretKey"}

Sample Response Payload returned by endpoint:

{
  "secretKey": "jCFq0IhpO7Qk7Fr5H3tHpMckhroKRhiTcMR15PKywH9B8QoA4lRgDaoSg46mAh+W4z3G2c1dHeVEOgMaMIBjUA==",
  "id": "production-calculateShipping"
}