Jump to

• Request
• Response

getRegistry

get

/ccadmin/v1/registry

Get Registry. Get the endpoint registry.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getRegistry_response

Type: object

Show Source

• 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.

{
    "properties":{
        "httpPort":{
            "description":"Http port.",
            "type":"integer"
        },
        "Endpoint Name":{
            "description":"Object of various Oauth Admin end points.",
            "type":"object",
            "properties":{
                "responseType":{
                    "description":"Type of response, e.g. application/json.",
                    "type":"string"
                },
                "authRequired":{
                    "description":"Whether authentication is required or not.",
                    "type":"boolean"
                },
                "requestType":{
                    "description":"Type of request, e.g. application/json.",
                    "type":"string"
                },
                "method":{
                    "description":"Method of the service.",
                    "type":"string"
                },
                "hasDoc":{
                    "description":"Whether endpoint has the doc or not.",
                    "type":"boolean"
                },
                "url":{
                    "description":"url to trigger the endpoint.",
                    "type":"string"
                },
                "httpsRequired":{
                    "description":"Whether https is required or not.",
                    "type":"boolean"
                }
            }
        },
        "httpsPort":{
            "description":"Https port.",
            "type":"integer"
        },
        "crossDomainRequestsEnabled":{
            "description":"Whether cross domain request enabled.",
            "type":"boolean"
        }
    }
}

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.

{
    "description":"Object of various Oauth Admin end points.",
    "type":"object",
    "properties":{
        "responseType":{
            "description":"Type of response, e.g. application/json.",
            "type":"string"
        },
        "authRequired":{
            "description":"Whether authentication is required or not.",
            "type":"boolean"
        },
        "requestType":{
            "description":"Type of request, e.g. application/json.",
            "type":"string"
        },
        "method":{
            "description":"Method of the service.",
            "type":"string"
        },
        "hasDoc":{
            "description":"Whether endpoint has the doc or not.",
            "type":"boolean"
        },
        "url":{
            "description":"url to trigger the endpoint.",
            "type":"string"
        },
        "httpsRequired":{
            "description":"Whether https is required or not.",
            "type":"boolean"
        }
    }
}

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

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top