REST API for Oracle Commerce Cloud December 2017

getEndpointAPIs

get

/ccstore/v1/api

Get Endpoint APIs. Get the endpoint API doc info.

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

Properties

Endpoint Service: Type: object Endpoint Service

Additional Properties Allowed:

Object of endpoint service.

Nested Schema : Endpoint Service

Type: object

Object of endpoint service.

Properties

description: Type: string

Description of service.
endpoints: Type: object endpoints

Additional Properties Allowed:

Object of Oauth Admin endpoint.

Nested Schema : endpoints

Type: object

Object of Oauth Admin endpoint.

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.
id: Type: string

ID of endpoint.
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


{
    "Orders":{
        "endpoints":[
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"getOrder",
                "url":"/ccadmin/v1/orders/{id}",
                "httpsRequired":false
            }
        ],
        "description":"Order endpoints"
    },
    "Health Check":{
        "endpoints":[
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"DELETE",
                "hasDoc":true,
                "id":"deletePaymentGatewayAuthorizationResponses",
                "url":"/ccstore/v1/healthCheck/payments",
                "httpsRequired":false
            }
        ],
        "description":"Admin health check endpoints"
    },
    "Profiles":{
        "endpoints":[
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":false,
                "id":"getProfile",
                "url":"/ccadmin/v1/profiles/{id}",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"getCurrentProfile",
                "url":"/ccadmin/v1/profiles/current",
                "httpsRequired":false
            }
        ],
        "description":"Profile endpoints"
    },
    "Asset Import/Export":{
        "endpoints":[
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":"application/json",
                "method":"POST",
                "hasDoc":true,
                "id":"uploadAssets",
                "url":"/ccadmin/v1/asset/upload",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"POST",
                "hasDoc":true,
                "id":"importAssets",
                "url":"/ccadmin/v1/asset/import",
                "httpsRequired":false
            },
            {
                "responseType":"*/*",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"exportAssets",
                "url":"/ccadmin/v1/asset/export",
                "httpsRequired":false
            },
            {
                "responseType":"text/html",
                "authRequired":true,
                "requestType":"multipart/form-data",
                "method":"POST",
                "hasDoc":false,
                "id":"uploadAssetsMultipart",
                "url":"/ccadmin/v1/asset/upload",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"POST",
                "hasDoc":true,
                "id":"validateAssets",
                "url":"/ccadmin/v1/asset/validate",
                "httpsRequired":false
            },
            {
                "responseType":"*/*",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"getValidationReport",
                "url":"/ccadmin/v1/asset/validationReport/{token}",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"getImportProgress",
                "url":"/ccadmin/v1/asset/import/{token}",
                "httpsRequired":false
            }
        ],
        "description":"Asset import/export endpoints"
    },
    "WebHooks":{
        "endpoints":[
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"getWebHook",
                "url":"/ccadmin/v1/webhooks/{id}",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"getWebHooks",
                "url":"/ccadmin/v1/webhooks",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"getWebHookSecretKey",
                "url":"/ccadmin/v1/webhooks/{id}/secretKey",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"PUT",
                "hasDoc":true,
                "id":"resetWebHookSecretKey",
                "url":"/ccadmin/v1/webhooks/{id}/secretKey",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":"application/json",
                "method":"PUT",
                "hasDoc":true,
                "id":"updateWebHooks",
                "url":"/ccadmin/v1/webhooks",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":"application/json",
                "method":"PUT",
                "hasDoc":true,
                "id":"updateWebHook",
                "url":"/ccadmin/v1/webhooks/{id}",
                "httpsRequired":false
            }
        ],
        "description":"WebHook endpoints"
    },
    "Error Log Entries":{
        "endpoints":[
            {
                "responseType":null,
                "authRequired":true,
                "requestType":"application/json",
                "method":"POST",
                "hasDoc":true,
                "id":"createErrorlog",
                "url":"/ccadmin/v1/errorLogs",
                "httpsRequired":false
            }
        ],
        "description":"Error Log Entry endpoints"
    },
    "OAuth":{
        "endpoints":[
            {
                "responseType":"application/json",
                "authRequired":false,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"getRegistry",
                "url":"/ccadmin/v1/registry",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":false,
                "id":"getTimestampDiff",
                "url":"/ccadmin/v1/timediff",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":false,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"getEndpointAPIs",
                "url":"/ccadmin/v1/api",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":false,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"getEndpointAPI",
                "url":"/ccadmin/v1/api/{id}",
                "httpsRequired":false
            },
            {
                "responseType":"application/x-www-form-urlencoded",
                "authRequired":false,
                "requestType":null,
                "method":"POST",
                "hasDoc":true,
                "id":"login",
                "url":"/ccadmin/v1/login",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"POST",
                "hasDoc":true,
                "id":"verify",
                "url":"/ccadmin/v1/verify",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"POST",
                "hasDoc":true,
                "id":"logout",
                "url":"/ccadmin/v1/logout",
                "httpsRequired":false
            },
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"POST",
                "hasDoc":true,
                "id":"refresh",
                "url":"/ccadmin/v1/refresh",
                "httpsRequired":false
            }
        ],
        "description":"OAuth endpoints"
    }
}

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:

{
  "Orders": {
    "endpoints": [{
      "responseType": "application/json",
      "authRequired": true,
      "requestType": null,
      "method": "GET",
      "hasDoc": true,
      "id": "getOrder",
      "url": "/ccadmin/v1/orders/{id}",
      "httpsRequired": false
    }],
    "description": "Order endpoints"
  },
  "Health Check": {
    "endpoints": [{
      "responseType": "application/json",
      "authRequired": true,
      "requestType": null,
      "method": "DELETE",
      "hasDoc": true,
      "id": "deletePaymentGatewayAuthorizationResponses",
      "url": "/ccstore/v1/healthCheck/payments",
      "httpsRequired": false
    }],
    "description": "Admin health check endpoints"
  },
  "Profiles": {
    "endpoints": [
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "GET",
        "hasDoc": false,
        "id": "getProfile",
        "url": "/ccadmin/v1/profiles/{id}",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "GET",
        "hasDoc": true,
        "id": "getCurrentProfile",
        "url": "/ccadmin/v1/profiles/current",
        "httpsRequired": false
      }
    ],
    "description": "Profile endpoints"
  },
  "Asset Import/Export": {
    "endpoints": [
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": "application/json",
        "method": "POST",
        "hasDoc": true,
        "id": "uploadAssets",
        "url": "/ccadmin/v1/asset/upload",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "POST",
        "hasDoc": true,
        "id": "importAssets",
        "url": "/ccadmin/v1/asset/import",
        "httpsRequired": false
      },
      {
        "responseType": "*/*",
        "authRequired": true,
        "requestType": null,
        "method": "GET",
        "hasDoc": true,
        "id": "exportAssets",
        "url": "/ccadmin/v1/asset/export",
        "httpsRequired": false
      },
      {
        "responseType": "text/html",
        "authRequired": true,
        "requestType": "multipart/form-data",
        "method": "POST",
        "hasDoc": false,
        "id": "uploadAssetsMultipart",
        "url": "/ccadmin/v1/asset/upload",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "POST",
        "hasDoc": true,
        "id": "validateAssets",
        "url": "/ccadmin/v1/asset/validate",
        "httpsRequired": false
      },
      {
        "responseType": "*/*",
        "authRequired": true,
        "requestType": null,
        "method": "GET",
        "hasDoc": true,
        "id": "getValidationReport",
        "url": "/ccadmin/v1/asset/validationReport/{token}",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "GET",
        "hasDoc": true,
        "id": "getImportProgress",
        "url": "/ccadmin/v1/asset/import/{token}",
        "httpsRequired": false
      }
    ],
    "description": "Asset import/export endpoints"
  },
  "WebHooks": {
    "endpoints": [
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "GET",
        "hasDoc": true,
        "id": "getWebHook",
        "url": "/ccadmin/v1/webhooks/{id}",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "GET",
        "hasDoc": true,
        "id": "getWebHooks",
        "url": "/ccadmin/v1/webhooks",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "GET",
        "hasDoc": true,
        "id": "getWebHookSecretKey",
        "url": "/ccadmin/v1/webhooks/{id}/secretKey",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "PUT",
        "hasDoc": true,
        "id": "resetWebHookSecretKey",
        "url": "/ccadmin/v1/webhooks/{id}/secretKey",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": "application/json",
        "method": "PUT",
        "hasDoc": true,
        "id": "updateWebHooks",
        "url": "/ccadmin/v1/webhooks",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": "application/json",
        "method": "PUT",
        "hasDoc": true,
        "id": "updateWebHook",
        "url": "/ccadmin/v1/webhooks/{id}",
        "httpsRequired": false
      }
    ],
    "description": "WebHook endpoints"
  },
  "Error Log Entries": {
    "endpoints": [{
      "responseType": null,
      "authRequired": true,
      "requestType": "application/json",
      "method": "POST",
      "hasDoc": true,
      "id": "createErrorlog",
      "url": "/ccadmin/v1/errorLogs",
      "httpsRequired": false
    }],
    "description": "Error Log Entry endpoints"
  },
  "OAuth": {
    "endpoints": [
      {
        "responseType": "application/json",
        "authRequired": false,
        "requestType": null,
        "method": "GET",
        "hasDoc": true,
        "id": "getRegistry",
        "url": "/ccadmin/v1/registry",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "GET",
        "hasDoc": false,
        "id": "getTimestampDiff",
        "url": "/ccadmin/v1/timediff",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": false,
        "requestType": null,
        "method": "GET",
        "hasDoc": true,
        "id": "getEndpointAPIs",
        "url": "/ccadmin/v1/api",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": false,
        "requestType": null,
        "method": "GET",
        "hasDoc": true,
        "id": "getEndpointAPI",
        "url": "/ccadmin/v1/api/{id}",
        "httpsRequired": false
      },
      {
        "responseType": "application/x-www-form-urlencoded",
        "authRequired": false,
        "requestType": null,
        "method": "POST",
        "hasDoc": true,
        "id": "login",
        "url": "/ccadmin/v1/login",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "POST",
        "hasDoc": true,
        "id": "verify",
        "url": "/ccadmin/v1/verify",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "POST",
        "hasDoc": true,
        "id": "logout",
        "url": "/ccadmin/v1/logout",
        "httpsRequired": false
      },
      {
        "responseType": "application/json",
        "authRequired": true,
        "requestType": null,
        "method": "POST",
        "hasDoc": true,
        "id": "refresh",
        "url": "/ccadmin/v1/refresh",
        "httpsRequired": false
      }
    ],
    "description": "OAuth endpoints"
  }
}