Gets all endpoints

Gets all endpoints

Gets all endpoints

Request
URI
GET
https://{api_host}/component-registry/endpoints
COPY
Query Parameters
integer
page
Optional

Page Number

integer
limit
Optional

Number of entries per page

string
$orderby
Optional

Multiple comma-separated properties sorted in ascending or descending order

integer
$top
Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer
$skip
Optional

Sets how many entries you would like to skip

string
$filter
Optional

Boolean expression for whether a particular entry should be included in the response

Request Body
PageAndSortRequest of type(s) application/json
Optional 
{
    "pageNumber": 0,
    "offset": 0,
    "pageSize": 0,
    "queryInfo": {
        "expand": [
            {
                "propertyName": "string"
            }
        ],
        "select": [
            {
                "propertyName": "string"
            }
        ],
        "top": 0,
        "skipToken": "string",
        "inlineCount": "string",
        "orderBy": [
            {
                "direction": "string"
            }
        ],
        "skip": 0,
        "rawFilter": "string",
        "rawOrderBy": "string"
    }
}
integer As int32 As int32
pageNumber
Optional

pageNumber

integer As int32 As int32
offset
Optional

offset

integer As int32 As int32
pageSize
Optional

pageSize

Sort
sort
Optional

sort

OdataQueryInfo
queryInfo
Optional

queryInfo

Responses
200

successful operation

Returns PageEndPoint of type(s) */* 
{
    "number": 0,
    "size": 0,
    "last": false,
    "numberOfElements": 0,
    "totalPages": 0,
    "content": [
        {
            "lastUpdated": "string",
            "endPointType": {
                "protocol": "string",
                "typeId": "string"
            },
            "serviceInfoId": "string",
            "createdDate": "string",
            "endPointAttributes": [
                {
                    "id": "string",
                    "value": "string",
                    "key": "string"
                }
            ],
            "id": "string",
            "sslTrusts": [
                "string"
            ],
            "url": "string"
        }
    ],
    "first": false,
    "totalElements": 0
}
integer As int32 As int32
number
Optional

number

integer As int32 As int32
size
Optional

size

boolean
last
Optional

last

integer As int32 As int32
numberOfElements
Optional

numberOfElements

integer As int32 As int32
totalPages
Optional

totalPages

Sort
sort
Optional

sort

array of EndPoint
content
Optional

content

boolean
first
Optional

first

integer As int64 As int64
totalElements
Optional

totalElements


On This Page
Component Registry Operations
POST
API To generate A resolved link which points To A specific UI page and takes into account anyrequired parameters for the UI view page To render properly. The best way To see how To usethis API Is By looking At A real-world example.
POST
Create Or update A service.
POST
Create Endpoint Type Extension
POST
Create Endpoint Type Spec
GET
Creates A new ModelAndView object with 'docs/odata'view name and sets the base bath To /services
DELETE
DELETE calls are not allowed
DELETE
DELETE Method not allowed
DELETE
Delete Endpoint
DELETE
Delete Endpoint Type Extension
DELETE
Delete Endpoint Type Spec
DELETE
Deletes the endpoint associated with the provided service Id and endpointTypeId.
GET
Get all serviceStatuses for services with registered status type endpoints.
GET
GET Method not allowed
GET
Get the config.js needed for API Explorer
GET
Get Endpoint Type Extension
GET
Get Endpoint Type Spec
GET
Gets A new Form resource By endpointTypeId. The form provided will Be A composition Of all forms registered via An EndPointTypeExtension instance and the base Form generated based On the EndPointTypeSpec.
GET
Gets A new ModelAndView object with 'docs/auth' view name and sets the base bath To /services
GET
Gets all distinct endpoint types
GET
Gets all distinct endpoint types associated with endpoints with services that match the provided serviceTypeId.
GET
Gets all distinct service types In the system.
GET
Gets all documentation endpoints
GET
Gets all endpoint instances for A given service instance.
GET
Gets all endpoint instances that implement the provided endpointTypeId
GET
Gets all endpoints
GET
Gets all endpoints associated with services that match the provided serviceTypeId AND that match the provided endpointTypeId.
GET
Gets all endpoints associated with services that match the provided serviceTypeId.
GET
Gets all registered services
GET
Gets all services associated with the provided serviceTypeId.
GET
Gets An edit Form resource By endpointId. The form provided will Be A composition Of all forms registered via An EndPointTypeExtension instance and the base Form generated based On the EndPointTypeSpec
GET
Gets the 'default' endpoint instance that implements the provided endpointTypeId
GET
Gets the default endpoint associated with the identity service's token endpoint (used To create Bearer tokens).
GET
Gets the default endpoint associated with the SSO server endpoint type.
GET
Gets the default service associated with the provided serviceTypeId
GET
Gets the endpoint identified By Id
GET
Gets the endpoint instance that implements endpointTypeId for A given service instance.
GET
Gets the LoggerEntity Of the given category for provided serviceTypeId
GET
Gets the service identified By id.
GET
Gets the serviceStatus for the specified serviceId.
DELETE
Handler for DELETE HTTP operations
POST
Handler for POST HTTP operations
PUT
Handler for PUT HTTP operations
GET
List Endpoint Type Extension
GET
List Endpoint Type Spec
POST
POST calls are not allowed
POST
POST Method not allowed
PUT
PUT calls are not allowed
POST
Registers A new service To the component registry.
DELETE
Removes (i.e.: deregisters) the service matching the provided id.
PUT
Sets the given level To category To all services with endpoint
PUT
Sets the given severity level To category for the provided serviceTypeId
GET
Similar To /services/status, this API gets all serviceStatuses for services with registered status type endpoints.
POST
Submits A new EndPointFormData resource By endpointTypeId. The values In the form submitted will Be used To create A new EndPoint Of the provided enpointTypeId.
PUT
Submits An updated version Of An EndPoint through the EndPointFormData resource. The values In the form submitted will Be used To update An existing EndPoint with the provided endpointId As part Of the URL parameters.
POST
This Is A convenience method which creates A new solution user, registers It with the SSO server, and then registers the provided service As new solution user In A single call
PUT
Update Or create A service.
PUT
Update Endpoint
PUT
Update Endpoint Type Extension
PUT
Update Endpoint Type Spec
POST
Updates Or creates An endpoint associated with the provided service Id and endpointTypeId.