REST API for Oracle Commerce Cloud December 2017

getRegistry

get

/ccadmin/v1/registry

Get Registry. Get the endpoint registry.

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 : getRegistry_response

Properties

crossDomainRequestsEnabled: Type: boolean

Whether cross domain request enabled.
Endpoint Name: Type: object Endpoint Name

Additional Properties Allowed:

Object of various Oauth Admin end points.
httpPort: Type: integer

Http port.
httpsPort: Type: integer

Https port.

Nested Schema : Endpoint Name

Type: object

Object of various Oauth Admin end points.

Properties

authRequired: Type: boolean

Whether authentication is required or not.
hasDoc: Type: boolean

Whether endpoint has the doc or not.
httpsRequired: Type: boolean

Whether https is required or not.
method: Type: string

Method of the service.
requestType: Type: string

Type of request, e.g. application/json.
responseType: Type: string

Type of response, e.g. application/json.
url: Type: string

url to trigger the endpoint.

Example 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

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:

{
  "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
}