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 Parameters

Retrieve Parameters

Use the GET method to retrieve parameters in EDS.

GET Request in JSON Format

Generate a GET request. For example, the following GET request retrieves a node:
GET /api/parameters/{parameter-id} Content-Type: application/json Accept: application/json

GET Response in JSON Format

The following are sample responses for the 200 OK code:
{ "parameterId": {parameter-id}, "key": {parameter-key}, "success": true, "value": {parameter-value-masked}, "secure": false, "timestamp": {timestamp} }
{ "parameterId": {parameter-id}, "key": {parameter-key}, "success": false, "value": {parameter-value}, "secure": true, "timestamp": {timestamp} }
The following is a sample response for the 404 Not Found code:
{ "success": false, "errors": [ { "code": PARAMETER_NOT_FOUND, "parameters": [{parameter-id}], "errorMessage": "Parameter with Id: {parameter-id} not found" } ] }
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 parameter. Exception : {error-message}." } ] }

0 COMMENTS

We’d like to hear from you!