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

Update Data flows

Update Data flows

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

POST Request in JSON Format

Generate a POST request. For example, the following POST request updates a data flow:
POST /api/dataflows/{dataflow-id} Content-Type: application/json Accept: application/json x-http-method-override: PUT

POST Body in JSON Format

The following a sample POST body in JSON format:
{ "name": "Test Dataflow Updated", "description":"name updated" }

PUT Response in JSON Format

The following is a sample response for the 200 OK code:
{ "id" : {dataflow-id} "name": {updated-dataflow-name} "description":"name updated", "success": true, "deploymentState": "DRAFT" }
The following is the sample response for the 404 Not Found code:
{ "success": false, "errors": [ { "code": DATAFLOW_NOT_FOUND, "parameters": [{dataflow-id}], "errorMessage": "Dataflow with Id: {dataflow-id} not found" } ] }
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 update dataflow. Exception : {error-message}." } ] }

0 COMMENTS

We’d like to hear from you!