Jump to

• Request
• Response

getEndpointAPIs

get

/ccagent/v1/api

Get Endpoint APIs. Get the endpoint API doc info. Deprecated

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

Type: object

Show Source

• Endpoint Service(optional): object Endpoint Service
  Object of endpoint service.

{
    "properties":{
        "Endpoint Service":{
            "description":"Object of endpoint service.",
            "type":"object",
            "properties":{
                "endpoints":{
                    "description":"Object of Oauth Admin endpoint.",
                    "type":"object",
                    "properties":{
                        "responseType":{
                            "description":"Type of response, for e.g. application/json.",
                            "type":"string"
                        },
                        "authRequired":{
                            "description":"Whether authentication is required or not.",
                            "type":"boolean"
                        },
                        "requestType":{
                            "description":"Tyep of request, for e.g. application/json.",
                            "type":"string"
                        },
                        "method":{
                            "description":"Method of the service.",
                            "type":"string"
                        },
                        "hasDoc":{
                            "description":"Whether endpoint has the doc or not. Deprecated",
                            "type":"boolean"
                        },
                        "id":{
                            "description":"ID of endpoint.",
                            "type":"string"
                        },
                        "url":{
                            "description":"url to trigger the endpoint.",
                            "type":"string"
                        },
                        "httpsRequired":{
                            "description":"Whether https is required or not.",
                            "type":"boolean"
                        }
                    }
                },
                "description":{
                    "description":"Description of service.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : Endpoint Service

Type: object

Object of endpoint service.

Show Source

• description(optional): string
  Description of service.
• endpoints(optional): object endpoints
  Object of Oauth Admin endpoint.

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

Nested Schema : endpoints

Type: object

Object of Oauth Admin endpoint.

Show Source

• authRequired(optional): boolean
  Whether authentication is required or not.
• hasDoc(optional): boolean
  Whether endpoint has the doc or not. Deprecated
• httpsRequired(optional): boolean
  Whether https is required or not.
• id(optional): string
  ID of endpoint.
• method(optional): string
  Method of the service.
• requestType(optional): string
  Tyep of request, for e.g. application/json.
• responseType(optional): string
  Type of response, for e.g. application/json.
• url(optional): string
  url to trigger the endpoint.

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

Example Response (application/json)

{
    "Orders":{
        "endpoints":[
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":true,
                "id":"getOrder",
                "url":"/ccagent/v1/orders/{id}",
                "httpsRequired":false
            }
        ],
        "description":"Order endpoints"
    },
    "Profiles":{
        "endpoints":[
            {
                "responseType":"application/json",
                "authRequired":true,
                "requestType":null,
                "method":"GET",
                "hasDoc":false,
                "id":"getProfile",
                "url":"/ccagent/v1/profiles/{id}",
                "httpsRequired":false
            }
        ],
        "description":"Profile endpoints"
    }
}

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