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 Plugins

Retrieve Plugins

Use the GET method to retrieve plugins in EDS.

GET Request in JSON Format

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

GET Response in JSON Format

The following is a sample response for the 200 OK code:
{ "name": "Syslog TCP", "success": true, "pluginId": "_VDS_SRC_SYSLOG_TCP", "zipName": "C:\\Informatica\\vds\\6.5\\admind\\plugins\\infa\\syslog-tcp-2.3.0.zip", "fieldsInfo": {"helpKey":"syslogTCP_source_properties","sourceSystemProperties":[{"textControl":{"integerTextField":{"default":8192,"minValue":1},"description":"Size of the source data (bytes) to be sent in an event. An event consists of one or more complete records.","name":"eventSize","mandatory":true,"displayName":"Maximum Event Size"},"seqNum":4},{"seqNum":6,"checkBoxControl":{"default":false,"description":"Persist the data from source locally so that source can continue processing even if the target is down.","name":"persistEvents","displayName":"Persist Data"}},{"seqNum":7,"textAreaControl":{"default":"# --\\n# The interval in milliseconds after which the writes \\n# are flushed to disk.\\n# --\\n#flushInterval=5000\\n\\n# --\\n# The maximum number of db files to keep\\n# --\\n#maxDataFiles=10\\n\\n# --\\n# Size of individual db file in bytes after which the files are rolled over\\n# --\\n#maxDataFileSize=1073741824\\n\\n# --\\n# The max size of unsent data in bytes. If 0, it is unbounded\\n# --\\n#maxQueueSizeInBytes=0\\n\\n# --\\n# The batch size in bytes up to which the data is buffered before writing to the disk.\\n# --\\n#batchSizeInBytes=262144\\n\\n","description":"Advanced options; only valid if persist data option is selected","name":"persistOptions","displayName":"Persistence options"}}],"displayName":"Syslog TCP","version":"2.3.0_1435821164","fields":[{"textControl":{"description":"Name of the entity. Maximum number of characters is 32.","name":"name","mandatory":true,"stringTextField":{"maxLength":32,"pattern":"^([_a-zA-Z][_a-zA-Z0-9 ]*)$","secure":false},"displayName":"Entity Name"},"seqNum":1},{"textControl":{"integerTextField":{"minValue":1,"maxValue":65536},"name":"portTCP","mandatory":true,"displayName":"Port"},"seqNum":2},{"seqNum":3,"listControl":{"default":0,"items":[{"id":0,"displayName":"LF"}],"name":"delimiter","displayName":"Delimiter"}}]}, "runTime": {"helpKey":"syslogTCP_source_properties","pluginClass":"com.informatica.binge.sources.syslog_tcp.SyslogTcpReader","pluginId":"_VDS_SRC_SYSLOG_TCP","name":"Syslog TCP","pluginJar":"syslog-tcp.jar","version":"2.3.0_1435821164"}, "statistics": {"statistic":[{"id":"1","displayName":"Events Dropped","type":"CUMULATIVE"},{"id":"2","displayName":"Concurrent Connections","type":"CUMULATIVE"},{"id":"3","displayName":"Maximum Concurrent Clients","type":"CUMULATIVE"}]}, "type": "SOURCE" }
The following is a sample response for the 404 Not Found code:
{ "success": false, "errors": [ { "code": PLUGIN_NOT_FOUND, "parameters": [{plugin-id}], "errorMessage": "Plugin with id {plugin-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 plugin. Exception : {error-message}." } ] }

0 COMMENTS

We’d like to hear from you!