getRegistry
get
/ccadmin/v1/registry
Get Registry. Get the endpoint registry.
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 : getRegistry_response
Type:
Show Source
object
-
crossDomainRequestsEnabled(optional):
boolean
Whether cross domain request enabled.
-
Endpoint Name(optional):
object Endpoint Name
Object of various Oauth Admin end points.
-
httpPort(optional):
integer
Http port.
-
httpsPort(optional):
integer
Https port.
Nested Schema : Endpoint Name
Type:
object
Object of various Oauth Admin end points.
Show Source
-
authRequired(optional):
boolean
Whether authentication is required or not.
-
hasDoc(optional):
boolean
Whether endpoint has the doc or not.
-
httpsRequired(optional):
boolean
Whether https is required or not.
-
method(optional):
string
Method of the service.
-
requestType(optional):
string
Type of request, e.g. application/json.
-
responseType(optional):
string
Type of response, e.g. application/json.
-
url(optional):
string
url to trigger the endpoint.
Example Response (application/json)
{
"httpPort":9080,
"endpointMap":{
"getEndpointAPIs":{
"responseType":"application/json",
"authRequired":false,
"requestType":null,
"method":"GET",
"hasDoc":true,
"url":"/ccadmin/v1/api",
"httpsRequired":false
},
"getWidgetSourceCode":{
"responseType":"application/json",
"authRequired":true,
"requestType":null,
"method":"GET",
"hasDoc":true,
"url":"/ccadmin/v1/widgets/{}/code",
"httpsRequired":false
},
"listProductInventories":{
"responseType":"application/json",
"authRequired":true,
"requestType":null,
"method":"GET",
"hasDoc":true,
"url":"/ccadmin/v1/products/inventories",
"httpsRequired":false
},
"createProduct":{
"responseType":"application/json",
"authRequired":true,
"requestType":"application/json",
"method":"POST",
"hasDoc":true,
"url":"/ccadmin/v1/products",
"httpsRequired":false
},
"getProfile":{
"responseType":"application/json",
"authRequired":true,
"requestType":null,
"method":"GET",
"hasDoc":false,
"url":"/ccadmin/v1/profiles/{}",
"httpsRequired":false
},
"getTaxProcessor":{
"responseType":"application/json",
"authRequired":true,
"requestType":null,
"method":"GET",
"hasDoc":true,
"url":"/ccadmin/v1/taxProcessors/{}",
"httpsRequired":false
},
"listWidgets":{
"responseType":"application/json",
"authRequired":true,
"requestType":null,
"method":"GET",
"hasDoc":true,
"url":"/ccadmin/v1/widgets",
"httpsRequired":false
},
"setSearchSchedule":{
"responseType":"application/json",
"authRequired":true,
"requestType":"application/json",
"method":"POST",
"hasDoc":true,
"url":"/ccadmin/v1/search/schedule",
"httpsRequired":false
},
"listCountries":{
"responseType":"application/json",
"authRequired":true,
"requestType":null,
"method":"GET",
"hasDoc":true,
"url":"/ccadmin/v1/countries",
"httpsRequired":false
}
},
"httpsPort":9443,
"crossDomainRequestsEnabled":false
}
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