About this API
These API endpoints are used to add, edit, or delete connections/listeners/formats.
Authentication
Before making a call to the built-in API, the user must receive a JWT token from the authentication API.
Step 1. Use any user with the Editor
or Administrator
role to call an Integrator authentication endpoint and receive an access token.
Step 2. Use the access token, received in Step 1, to call Integrator API endpoints. The access token must be submitted as a header parameter, as in: Authorization:Bearer access-token
, or query parameter, as in: ?Authorization=Bearer%20access-token
.
Access tokens in Integrator are short-lived and self-expiring. An access token gives you access to the APIs for approximately 10 minutes. It is recommended that you refresh the access token before each call to the API.
Connections API
Add new connection
The API endpoint parameters
- PATH:
/rest/v1/connections
EXAMPLE: https://app.etlworks.com/rest/v1/connections
- METHOD: POST
- HEADER: Authorization:Bearer access-token
- REQUEST BODY: JSON document in the following format
-
{
}
- REQUEST CONTENT TYPE:
application/json
.
Response
The response is a JSON document in the following format:
{"id": number, the ID
"name": string, the name
"description": string, the description
"connectionType": string, the connection type
"properties": object, the map of properties
"tags": array, the list of tag strings
}
Response Codes
200 for success, 400 for not valid request body, 401 for not authorized, 403 for forbidden, and 500 for an internal error.
Edit connection
The API endpoint parameters
- PATH:
/rest/v1/connections/{connectionId}
EXAMPLE: https://app.etlworks.com/rest/v1/connections/1
- METHOD:
PUT
- HEADER: Authorization:Bearer access-token
- REQUEST BODY: JSON document in the following format
-
{
}
- REQUEST CONTENT TYPE:
application/json
.
Response
The response is a JSON document in the following format:
{
"id": number, the ID
"name": string, the name
"description": string, the description
"connectionType": string, the connection type
"properties": object, the map of properties
"tags": array, the list of tag strings
}
Response Codes
200 for success, 400 for not valid request body, 401 for not authorized, 403 for forbidden, and 500 for an internal error.
Delete connection
The API endpoint parameters
- PATH:
/rest/v1/connections/{connectionId}
EXAMPLE: https://app.etlworks.com/rest/v1/connections/1
- METHOD:
DELETE
- HEADER: Authorization:Bearer access-token
- REQUEST BODY: none
- REQUEST CONTENT TYPE: none
- RESPONSE: none
Response Codes
204 for success, 401 for not authorized, 403 for forbidden, 409 if connection cannot be deleted because it is referenced in some flow, and 500 for an internal error.
Listeners API
Add new listener
The API endpoint parameters
- PATH:
/rest/v1/listeners
EXAMPLE: https://app.etlworks.com/rest/v1/listeners
- METHOD: POST
- HEADER: Authorization:Bearer access-token
- REQUEST BODY: JSON document in the following format
-
{
listener
type
}
- REQUEST CONTENT TYPE:
application/json
.
Response
The response is a JSON document in the following format:
{"id": number, the ID
"name": string, the name
"description": string, the description
"connectionType": string, the
listener
type"properties": object, the map of properties
"tags": array, the list of tag strings
}
Response Codes
200 for success, 400 for not valid request body, 401 for not authorized, 403 for forbidden, and 500 for an internal error.
Edit listener
The API endpoint parameters
- PATH:
/rest/v1/listeners/{listenerId}
EXAMPLE: https://app.etlworks.com/rest/v1/listeners/1
- METHOD:
PUT
- HEADER: Authorization:Bearer access-token
- REQUEST BODY: JSON document in the following format
-
{
}
- REQUEST CONTENT TYPE:
application/json
.
Response
The response is a JSON document in the following format:
{
"id": number, the ID
"name": string, the name
"description": string, the description
"connectionType": string, the listener
type
"properties": object, the map of properties
"tags": array, the list of tag strings
}
Response Codes
200 for success, 400 for not valid request body, 401 for not authorized, 403 for forbidden, and 500 for an internal error.
Delete listener
The API endpoint parameters
- PATH:
/rest/v1/listeners/{listenerId}
EXAMPLE: https://app.etlworks.com/rest/v1/listeners/1
- METHOD:
DELETE
- HEADER: Authorization:Bearer access-token
- REQUEST BODY: none
- REQUEST CONTENT TYPE: none
- RESPONSE: none
Response Codes
204 for success, 401 for not authorized, 403 for forbidden, 409 if listener cannot be deleted because it is referenced in some flow, and 500 for an internal error.
Formats API
Add new format
The API endpoint parameters
- PATH:
/rest/v1/formats
EXAMPLE: https://app.etlworks.com/rest/v1/formats
- METHOD: POST
- HEADER: Authorization:Bearer access-token
- REQUEST BODY: JSON document in the following format
-
{
format
Type": string, theformat
type
}
- REQUEST CONTENT TYPE:
application/json
.
Response
The response is a JSON document in the following format:
{"id": number, the ID
"name": string, the name
"description": string, the description
"
format
Type": string, theformat
type"properties": object, the map of properties
"tags": array, the list of tag strings
}
Response Codes
200 for success, 400 for not valid request body, 401 for not authorized, 403 for forbidden, and 500 for an internal error.
Edit format
The API endpoint parameters
- PATH:
/rest/v1/formats/{formatId}
EXAMPLE: https://app.etlworks.com/rest/v1/formats/1
- METHOD:
PUT
- HEADER: Authorization:Bearer access-token
- REQUEST BODY: JSON document in the following format
-
{
}
- REQUEST CONTENT TYPE:
application/json
.
Response
The response is a JSON document in the following format:
{
"id": number, the ID
"name": string, the name
"description": string, the description
"format
Type": string, the format
type
"properties": object, the map of properties
"tags": array, the list of tag strings
}
Response Codes
200 for success, 400 for not valid request body, 401 for not authorized, 403 for forbidden, and 500 for an internal error.
Delete format
The API endpoint parameters
- PATH:
/rest/v1/formats/{formatId}
EXAMPLE: https://app.etlworks.com/rest/v1/formats/1
- METHOD:
DELETE
- HEADER: Authorization:Bearer access-token
- REQUEST BODY: none
- REQUEST CONTENT TYPE: none
- RESPONSE: none
Response Codes
204 for success, 401 for not authorized, 403 for forbidden, 409 if format cannot be deleted because it is referenced in some flow, and 500 for an internal error.
Comments
0 comments
Please sign in to leave a comment.