Versions Compared

Old Version 45

changes.mady.by.user Shankar Selvam

Saved on

compared with

New Version 46

changes.mady.by.user Shankar Selvam

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

HTTP Request Type

Endpoint

Request Body

Response Status

Response Body
POST

/extensions/hydrator/drafts/{draft-name}

 
Code Block
languagejs
{ 
"config": {...},
"message" : "..."
}

200 OK: draft created and saved successfully

409 CONFLICT: draft-name already exists

500 Error: while creating the draft

 
PUT/extensions/hydrator/drafts/{draft-name} 
Code Block
languagejs
{ 
"config": {...},
"message" : "..."
}

200 OK: draft updated successfully

404 NOT Found : draft doesn't exist already, cannot be updated.

400 BAD Request : only 20 versions can be stored, delete old version before storing.

500 Error while updating the draft

 
GET

/extensions/hydrator/drafts/{draft-name}/versions/

 

200 return all the versions for the draft identified by the draft-name

404 draft not found

500 error while getting draft

Code Block
languagejs
[
{
"message" : "...",
"config": {
 "source" : {
    ....
  }, 
 "transforms" : [...],
 "sinks" [...]
 "connections" : [..]
 }
}, 
... 
]
GET

/extensions/hydrator/drafts/{draft-name}/versions/{version-number}

-1 -> latest version

 

200 return the versions for the draft identified by the draft-name and version-number

404 draft not found

500 error while getting draft

Code Block
languagejs
{ 
"message" : "...",
"config": {
 "source" : {
    ....
  }, 
 "transforms" : [...],
 "sinks" [...]
 "connections" : [..]
 }
}
GET/extensions/hydrator/drafts/ 

200 return the list of all saved drafts

500 error

[ 
  "streamToTPFS",
  "DBToHBase",
   ...
]
DELETE/extensions/hydrator/drafts/ 

200 successfully deleted all drafts

500 error while deleting

 
DELETE/extensions/hydrator/drafts/{draft-name} 

200 successfully deleted the specified draft

404 draft does not exist

500 error while deleting

 
DELETE/extensions/hydrator/drafts/{draft-name}/versions/{version-number} 

200 successfully deleted the version of a drat

404 draft with the version does not exist

500 error while deleting

 
POST

/extensions/hydrator/plugins/{plugin-name}/schema

 

Code Block
languagejs
{ 
"artifact" : {
  "name" : "...",
  "version":"...",
  "scope":"..."
},
"jdbcConnectionString": "...", 
 "jdbcPluginName": "...", 
 "tableName" : "..."
}

 

200 based on the plugin and plugin-properties

 determine output schema and return output schema

404 unrecognized plugin-name

500 Error

Code Block
languagejs
{ 
  "field1" : Integer,
  "field2" : String,
   ...
  "fieldN" : Double
}
POST

/extensions/hydrator/plugins/{plugin-name}/list

QueryParam : target

Example: target=table

Example:

Code Block
languagejs
{ 
"artifact" : {
  "name" : "...",
  "version":"...",
  "scope":"..."
}
"connectionString":   ..., 
 "username": ..., 
 "password" : ...
}

For the specified plugin, based on the provided connection information, get the list of available target field and return the list.

200 , list of available values for target type field. Example: list of tables in a database.

500 error while retrieving.

Code Block
languagejs
[ 
  "tableA",
  "tableB"
   ...
  "tableN" 
]

Design

...