ETL Application APIs

Gathr’s REST API supports the following actions on ETL applications:

• Start ETL Application

• Stop ETL Application

• Get ETL Application Status

• Update ETL Application

Start ETL Application #

This API will start a Gathr ETL application with the following REST call.

Request URL #

POST https://app.gathr.one/api/v1/application/start

Headers #

Request Body #

{
"name":"<your_etl_app_name>",
"appType":"etl",
"projectName":"<your_project_name>"
}

Request Body Parameters #

Response #

HTTP Status Code: 200

{"message": "Request to start the application is accepted.",
"status": "Success"}

HTTP Status Code: 400

{"message": "<A description of the error will be provided.>",
"status": "Error"}

Stop ETL Application #

This API will stop a Gathr ETL application with the following REST call.

Request URL #

POST https://app.gathr.one/api/v1/application/stop

Headers #

Request Body #

{
"name":"<your_etl_app_name>",
"appType":"etl",
"projectName":"<your_project_name>"
}

Request Body Parameters #

Response #

HTTP Status Code: 200

{"message": "Request to stop the application is accepted.",
"status": "Success"}

HTTP Status Code: 400

{"message": "<A description of the error will be provided.>",
"status": "Error"}

Get ETL Application Status #

This API will get the status of a Gathr ETL application with the following REST call.

Request URL #

GET https://app.gathr.one/api/v1/application/status/<appType>/<appName>

Headers #

Query Parameters #

Response #

HTTP Status Code: 200

{"application_status": "STOPPED",
"status": "Success"}

{"application_status": "STARTING",
"status": "Success"}

{"application_status": "RUNNING",
"status": "Success"}

{"application_status": "ERROR",
"status": "Success"}

HTTP Status Code: 400

{"message": "<A description of the error will be provided.>",
"status": "Error"}

Update ETL Application #

This API will update a Gathr ETL application with the following REST call.

Request URL #

POST https://app.gathr.one/api/v1/application/update

Headers #

Request Body #

{
"name":"<your_etl_app_name>",
"appType":"etl",
"projectName":"<your_project_name>",
"componentId":"<yourS3ChannelComponentID>",
"bucketName":"<yourS3BucketName>",
"filename":["file-1.csv,file-2.csv,file-3.csv"]
}

Request Body Parameters #

Name	Required	Description
name	YES	The name of the ETL application to be updated.
appType	YES	The type of the Gathr application that should be updated. Value to be provided – etl
projectName	YES	The Gathr project name containing the ETL application to be updated.
componentId	YES	The component ID of the S3 Batch Data Source. Note: Right-click a component to see its component ID on the ETL canvas, as shown in the image below:
bucketName	YES	The bucket name to be updated in the component’s configuration should be provided.
filename	YES	The array of files to be to be updated in the component’s configuration should be provided.

Response #

HTTP Status Code: 200

{"message": " Application updated successfully.",
"status": "Success"}

HTTP Status Code: 400

{"message": "<A description of the error will be provided.>",
"status": "Error"}