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.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getExternalServicesData_response
Type:
Show Source
object
-
items(optional):
array items
List of external application data objects.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the external application data. In the form "{serverType}-{applicationName}".
-
serverType(optional):
string
The server type. Typically "production" (storefront) or "publishing" (admin).
-
serviceData(optional):
object serviceData
description of serviceData
Nested Schema : serviceData
Type:
object
description of serviceData
Show Source
-
applicationId(optional):
string
The Facebook application ID of the merchant. (Facebook only)
-
displayName(optional):
string
The localized display name of the application.
-
host(optional):
string
The host name of the recommendations host. (Recommendations only)
-
name(optional):
string
The non-localized name of the service, such as "Facebook" or "Recommendations".
-
port(optional):
integer
The port of the recommendations server. (Recommendations only)
-
tenantId(optional):
string
The tenant ID of the merchant. (Recommendations only)
Example Response (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
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code