Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the Swagger UI provided for this API.

name path methods description
RestEtlService
  • /v1/connection
  • /v1/data
  • /v1/fields
  • /v1/health
  • /v1/info
  • /v1/message
  • /v1/metrics
  • /v1/objects
  • /v1/scenario
  • /v1/script
  • /v1/fields/cache
  • /v1/objects/cache
  • POST
  • POST
  • POST PUT
  • GET
  • GET
  • POST
  • GET
  • POST PUT
  • POST
  • POST
  • POST
  • POST
REST ETL service.

Data Types

JSON

type description
ConnectionAlias This POJO includes all parameters needed to create a connection to the database or file based data source.
DataElement Data set, message or stack trace, returned by REST ETL Server getData endpoint. All 3 attributes are mutually exclusive.
DataRequest This POJO is used as a request to the REST ETL Server to retrieve data from the supported connection and serialize to JsonDataSet.
DataResponse The instance of this POJO is returned by REST ETL Server when getData endpoint is called.
DataSetObject This POJO represents a data set.
EtlServiceFileMetrics This POJO represents metrics captured during file operations, such as file copied, file moved, file deleted, etc.
EtlServiceMetrics This POJO represents metrics captured during ETL transformation.
EtlServiceRequest This POJO used as a request for the REST ETL Service.
EtlServiceResponse This POJO is returned by REST ETL Service when ETL scenario is executed.
Field This POJO represents a data set field.
FieldsRequest This POJO is used as a request to the REST ETL Server to get a list of fields which belong to the data set.
JsonDataSet This POJO represents a data set in the json rowset format.
JsonDataSetField This POJO represents a data set field and used together with JsonDataSet.
Message Message in a raw text format (json, xml, csv, etc.) or a byte array if source is a binary object (excel, pdf, etc.), returned by REST ETL Server getMessage endpoint.
Point
Point2D
ScriptRequest This POJO is used as a request to the REST ETL Server to execute any JavaScript
ScriptResponse The instance of this POJO is returned by REST ETL Server when executeScrip endpoint is called.