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

Retrieve All Data Flows

Retrieve All Data Flows

Use the GET method to retrieve all data flows in EDS.

GET Request in JSON Format

Generate a GET request. For example, the following GET request retrieves all data flows:
GET /api/dataflows Content-Type: application/json Accept: application/json

GET Response in JSON Format

The following is the sample response for the 200 OK code when there are no data flows:
{ "success": true, "total": 0, "count": 0, "items": [] }
The following is the sample response for the 200 OK code when there are three data flows:
{ "success": true, "total": 3, "count": 3, "items": [ { "id": 1, "name": "Dataflow 1", "deploymentState": "DRAFT" }, { "id": 2, "name": "My second Dataflow", "deploymentState": "DEPLOYED" }, { "id": 3, "name": "DF3", "deploymentState": "NEEDS_REDEPLOYMENT" } ] }
The following is a sample response for the 500 Internal Server Error code:
{ "success": false, "errors": [ { "code": INTERNAL_SERVER_ERROR, "parameters": [{error-message}], "errorMessage": "Failed to get all dataflows. Exception: {error-message}" } ] }

0 COMMENTS

We’d like to hear from you!