REST API for Oracle Commerce Cloud December 2017

getExternalServiceData

get

/ccadmin/v1/merchant/{id}

Get External Service Data. Get a single external service data object.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The ID of the external application data. In the form "{serverType}-{applicationName}".

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getExternalServiceData_response

Properties

id: Type: string

The ID of the external application data. In the form "{serverType}-{applicationName}".
serverType: Type: string

The server type. Typically "production" (storefront) or "publishing" (admin).
serviceData: Type: object serviceData

Additional Properties Allowed:

description of serviceData

Nested Schema : serviceData

Type: object

description of serviceData

Properties

applicationId: Type: string

The Facebook application ID of the merchant. (Facebook only)
displayName: Type: string

The localized display name of the application.
host: Type: string

The host name of the recommendations host. (Recommendations only)
name: Type: string

The non-localized name of the service, such as "Facebook" or "Recommendations".
port: Type: integer

The port of the recommendations server. (Recommendations only)
tenantId: Type: string

The tenant ID of the merchant. (Recommendations only)

Example application/json


{
    "serverType":"production",
    "serviceData":{
        "port":123,
        "displayName":"Oracle Recommendations",
        "host":"myHost",
        "name":"Recommendations",
        "tenantId":"foo"
    },
    "id":"production-Recommendations"
}

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 Response Payload returned by endpoint:

{
  "serverType": "production",
  "serviceData": {
    "port": 123,
    "displayName": "Oracle Recommendations",
    "host": "myHost",
    "name": "Recommendations",
    "tenantId": "foo"
  },
  "id": "production-Recommendations"
}