REST API for Oracle Commerce Cloud December 2017

updateFunctionWebHooks

put

/ccadmin/v1/functionWebhooks

Update Function Web Hooks. Update existing WebHooks.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : updateFunctionWebHooks_request

Example


{
    "webHooks":[
        {
            "headers":null,
            "secretKey":null,
            "displayName":"atg.service.webhook.Resources->webHookDisplayName_publishEvent",
            "serverType":"production",
            "name":"calculateShipping",
            "id":"production-calculateShipping",
            "url":null
        },
        {
            "headers":{
                "header1":"value1"
            },
            "displayName":"Calculate Shipping - Publishing",
            "serverType":"publishing",
            "name":"calculateShipping",
            "id":"publishing-calculateShipping",
            "basicAuthentication":{
                "admin":"admin123"
            },
            "url":"https://localhost:8080/calculateShipping"
        }
    ]
}

Properties

basicAuthentication: Type: object basicAuthentication

Additional Properties Allowed:

Map of username and password
displayName: Type: integer

The display name of the WebHook.
headers: Type: object headers

Additional Properties Allowed:

Map of header names and header values
id: Type: integer

Required: true

WebHook identifier.
name: Type: integer

The simple name of the WebHook.
secretKey: Type: integer

The base64 encoded secret key of the WebHook. Will be null unless includeSecretKeys query parameter is true. A secret key is currently shared between WebHooks of the same name (like "calculateShipping").
serverType: Type: integer

The server type of the WebHook.
url: Type: string

The target URL for the function WebHook.

Nested Schema : basicAuthentication

Type: object

Map of username and password

Properties

password: Type: string

Required: true

The password.
username: Type: string

Required: true

The user name.

Nested Schema : headers

Type: object

Map of header names and header values

Properties

headerName: Type: string

Required: true

The header name.
headerValue: Type: string

Required: true

The header value.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateFunctionWebHooks_response

Properties

basicAuthentication: Type: object basicAuthentication

Additional Properties Allowed:

Map of username and password
displayName: Type: integer

The display name of the WebHook.
headers: Type: object headers

Additional Properties Allowed:

Map of header names and header values
id: Type: integer

WebHook identifier.
name: Type: integer

The simple name of the WebHook.
secretKey: Type: integer

The base64 encoded secret key of the WebHook. Will be null unless includeSecretKeys query parameter is true. 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.
serverType: Type: integer

The server type of the WebHook.
url: Type: string

The target URL for the function WebHook.

Nested Schema : basicAuthentication

Type: object

Map of username and password

Properties

password: Type: string

The password.
username: Type: string

The user name.

Nested Schema : headers

Type: object

Map of header names and header values

Properties

headerName: Type: string

The header name.
headerValue: Type: string

The header value.

Example application/json


[
    {
        "headers":null,
        "secretKey":null,
        "displayName":"Calculate Shipping - Production",
        "serverType":"production",
        "name":"calculateShipping",
        "id":"production-calculateShipping",
        "url":null
    },
    {
        "headers":{
            "header1":"value1"
        },
        "displayName":"Calculate Shipping - Publishing",
        "serverType":"publishing",
        "name":"calculateShipping",
        "id":"publishing-calculateShipping",
        "basicAuthentication":{
            "admin":"admin123"
        },
        "url":"https://localhost:8080/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:

{"webHooks": [
  {
    "headers": null,
    "secretKey": null,
    "displayName": "atg.service.webhook.Resources->webHookDisplayName_publishEvent",
    "serverType": "production",
    "name": "calculateShipping",
    "id": "production-calculateShipping",
    "url": null
  },
  {
    "headers": {"header1": "value1"},
    "displayName": "Calculate Shipping - Publishing",
    "serverType": "publishing",
    "name": "calculateShipping",
    "id": "publishing-calculateShipping",
    "basicAuthentication": {"admin": "admin123"},
    "url": "https://localhost:8080/calculateShipping"
  }
]}

Sample Response Payload returned by endpoint:

[
  {
    "headers": null,
    "secretKey": null,
    "displayName": "Calculate Shipping - Production",
    "serverType": "production",
    "name": "calculateShipping",
    "id": "production-calculateShipping",
    "url": null
  },
  {
    "headers": {"header1": "value1"},
    "displayName": "Calculate Shipping - Publishing",
    "serverType": "publishing",
    "name": "calculateShipping",
    "id": "publishing-calculateShipping",
    "basicAuthentication": {"admin": "admin123"},
    "url": "https://localhost:8080/calculateShipping"
  }
]