Versions Compared

Old Version 18

changes.mady.by.user Karl Henselin

Saved on

compared with

New Version 19

changes.mady.by.user Chandresh Patel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
Top
Top

Info
titleBase URL for Endpoint REST API

http://host:port/flexdeploy/rest/v1/topology/endpoint

Include Page
REST V1 Authentication
REST V1 Authentication

Table of Contents
maxLevel2

...

GET (Using Query Parameters)

This GET service will return a list of Endpoints in the form of JSON objects based on the query parameters name, address, group and subgroup. Endpoints are only returned if they match ALL of the specified query parameters. If no query parameters are given this request will return the entire list of Endpoints.

Info
titleAPI URL

http://host:port/flexdeploy/rest/v1/topology/endpoint?

Append the following character sequences to the above URL to specify Query parameters.
Use '&' between successive query parameters: 

endpointName={name}

endpointAddress={address}

endpointGroup={group}

endpointSubgroup={subgroup}

Examples:
To Specify the name parameter only:

http://host:port/flexdeploy/rest/v1/topology/endpoint?endpointName={name}

To Specify the name and group parameters:

http://host:port/flexdeploy/rest/v1/topology/endpoint?endpointName={name}&endpointGroup={group}

To Specify the name, address and group parameters:

http://host:port/flexdeploy/rest/v1/topology/endpoint?endpointName={name}&endpointAddress={address}&endpointGroup={group}

...

Back to Top

Anchor
PATCH
PATCH

PATCH

This PATCH service will update an existing endpoint with the information passed through a JSON object. If an attribute is absent of its value is null it will not be updated in the Endpoint.


Info
titleAPI URL

http://host:port/flexdeploy/rest/v1/topology/endpoint/{Id}

...