put https://api.ol-hub.com/backend/api/v1/modules/
The update module API sends a PUT request to update a module.
Prerequisites: The caller must supply the moduleId for the asset definition.
Authorization: API key
Input parameters:
Field name | Description | Format |
---|---|---|
id | Module id | UUID |
Output parameters:
Field name | Description | Format |
---|---|---|
id | Module id | UUID |
name | Module name | String |
modifiedAt | Date-time module was modified | Instant |
modifiedBy | User who modified the module | String |
description | Description text | String |
config | Container - see below | Config |
createdAt | Date-time module was created | Instant |
type | Module type | String |
profiles | Container - see below | Profiles |
Config:
Field name | Description | Format |
---|---|---|
connectorName | Connector name | String |
connectorVersion | Connector version | String |
Profiles:
Field name | Description | Format |
---|---|---|
url | URL | URL |
password | User password | String |
username | User name | String |
driverClassName | Driver |
Example:
{
"id": "2f2fe37f-01f2-4ffb-9a97-3fd7d60ada5e",
"name": "new_name",
"modifiedAt": "2021-07-18T13:35:34.273894Z",
"modifiedBy": "local dev",
"description": "discription bla bla",
"config": {
"connectorName": "oracle-db",
"connectorVersion": "latest"
},
"createdAt": "2021-07-18T12:54:22.139933Z",
"type": "oracle_db",
"profiles": {
"$default": {
"url": "jdbc:oracle:thin:@//oracle-db-openlegacy.cucbes8jvrek.us-east-1.rds.amazonaws.com:1521/ORCL",
"password": "1234",
"username": "demo",
"driverClassName": "oracle.jdbc.driver.OracleDriver"
}
}
}