Table of Contents

Search

  1. Preface
  2. Introduction to Edge Data Streaming Custom Entity Types
  3. Managing Custom Entity Types
  4. Custom Entities from Maven Archetypes
  5. REST APIs
  6. HTTP Request and Response Parameters
  7. Sample JSON Requests and Responses
  8. Glossary

Developer Guide

Developer Guide

REST APIs Overview

REST APIs Overview

The REST API is a Representational State Transfer (REST) API.
The EDS REST API allows you to use API calls to perform the following tasks in EDS:
  • Create, update, retrieve, delete, deploy, and undeploy specific and all data flows.
  • Create, update, retrieve, delete, deploy, and undeploy source services and target services.
  • Create, update, retrieve, and delete connections and links.
  • Create, update, retrieve, and delete aggregators and transformations.
  • Create, update, retrieve, and delete EDS Nodes and node groups.
  • Create, update, retrieve, and delete parameters.
  • Retrieve plug-ins.
You can access the REST APIs through the following base URL:
http://<hostname>:<port>/administrator/api
where,
hostname
is the machine name on which the Administrator tool is running and
port
is the port on which it listens.
When you use the REST API to configure a request, use the appropriate resource, method, the applicable date and time values, object ID, along with the applicable headers. Use the applicable format for the request header and body component. EDS supports the JSON formats for passing the attributes. EDS performs the requested task and returns the http response, or returns an error object and related messages.
For more information on the request and response format for specific EDS resources, see the sample JSON requests and responses.

0 COMMENTS

We’d like to hear from you!