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 Parameters

Retrieve All Parameters

Use the GET method to retrieve all parameters in EDS.

GET Request in JSON Format

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

GET Response in JSON Format

The following are the sample responses for the 200 OK code:
{ "success": true, "total": 0, "count": 0, "items": [] }
{ "success": true, "total":3, "count":3, "items": [ {"key": "key1", "value": "*****", "secure": true, "timestamp": 1435911720961, "parameterId": 1}, {"key": "key2", "value": "value2", "secure": false, "timestamp": 1435911720924, "parameterId": 2}, {"key": "TestKey", "value": "TestValue", "secure": false, "timestamp": 1435911720785, "parameterId": 3} ] }
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 parameters. Exception : {error-message}." } ] }

0 COMMENTS

We’d like to hear from you!