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

Create Data Flows

Create Data Flows

Use the POST method to create a data flow in EDS.

POST Request in JSON Format

Generate a POST request. For example, the following POST request creates a data flow:
POST /api/dataflows Content-Type: application/json Accept: application/json

POST Body in JSON Format

{ "name": "Test Dataflow", "description":"new dataflow" }

POST Response in JSON Format

The following is a sample response for the 201 Created code:
{ "id": {dataflow-id}, "name": "Test Dataflow", "description":"new dataflow" "success": true, "deploymentState": "DRAFT" }
The following are sample responses for the 400 Bad Request code:
{ "success": false, "errors": [ { "code": INVALID_DATAFLOW_NAME, "parameters": null, "errorMessage": "Dataflow name not valid." } ] }
{ "success": false, "errors": [ { "code": DATAFLOW_NAME_ALREADY_EXISTS, "parameters": null, "errorMessage": "Dataflow name already exists." } ] }
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 create the dataflow. Exception : {error-message}" } ] }

0 COMMENTS

We’d like to hear from you!