REST API for Oracle Commerce Cloud December 2017

getExternalServicesData

get

/ccadmin/v1/merchant

Get External Services Data. Get all the external service data objects.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getExternalServicesData_response

Properties

items: Type: array items

Additional Properties Allowed:

List of external application data objects.

Nested Schema : items

Type: array

List of external application data objects.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

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


{
    "items":[
        {
            "serverType":"production",
            "serviceData":{
                "displayName":"Facebook",
                "name":"Facebook",
                "applicationId":null
            },
            "id":"production-Facebook"
        },
        {
            "serverType":"production",
            "serviceData":{
                "port":123,
                "displayName":"Oracle Recommendations",
                "host":"myHost",
                "name":"Recommendations",
                "tenantId":"foo"
            },
            "id":"production-Recommendations"
        },
        {
            "serverType":"publishing",
            "serviceData":{
                "displayName":"Facebook",
                "name":"Facebook",
                "applicationId":null
            },
            "id":"publishing-Facebook"
        },
        {
            "serverType":"publishing",
            "serviceData":{
                "port":0,
                "displayName":"Oracle Recommendations",
                "host":null,
                "name":"Recommendations",
                "tenantId":null
            },
            "id":"publishing-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:

{"items": [
  {
    "serverType": "production",
    "serviceData": {
      "displayName": "Facebook",
      "name": "Facebook",
      "applicationId": null
    },
    "id": "production-Facebook"
  },
  {
    "serverType": "production",
    "serviceData": {
      "port": 123,
      "displayName": "Oracle Recommendations",
      "host": "myHost",
      "name": "Recommendations",
      "tenantId": "foo"
    },
    "id": "production-Recommendations"
  },
  {
    "serverType": "publishing",
    "serviceData": {
      "displayName": "Facebook",
      "name": "Facebook",
      "applicationId": null
    },
    "id": "publishing-Facebook"
  },
  {
    "serverType": "publishing",
    "serviceData": {
      "port": 0,
      "displayName": "Oracle Recommendations",
      "host": null,
      "name": "Recommendations",
      "tenantId": null
    },
    "id": "publishing-Recommendations"
  }
]}