# DataSourceConnections

# GET GET Connection

# /data-catalog/api/connection

# Description

Get list of data source connections for specified ConnectionName or ConnectionId or SourceSystemType. If no parameter value is given, it'll list all the data source connections otherwise combination of parameter values will be used to filter the connections.

# Parameters

Name	Located in	Description	Required	Schema
ConnectionName	query	Connection Name	No	string
ConnectionId	query	Connection Id	No	string
SourceSystemType	query	Source System Type	No	string

# Responses

Code	Description	Schema
200	Success	Connections info JSON
400	Bad Request. Something wrong with request body.
401	Not Authorized. Either the Access token is missing or the access token validation failed	ServiceErrors
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource	ServiceErrors
404	Not found. One or more resources were not found
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# POST Create Connection

# /data-catalog/api/connection

# Description

Creates a new Data Source Connection with the information provided in the payload. ConnectionName or ConnectionId are the individually unique fields. If same Name or Id exist in database, it will not create with that name. BaseSchema validation is performed to check the accepted values for the parameters from list of Enum values

# Payload

{
      "connectionName": "string",
      "description": "string",
      "connectionType": "string",
      "tenantId": "string",
      "connectionId": "string",
      "adapterType": "string",
      "sourceSystemType": "string",
      "sourceSystemNetwork": "string",
      "host": "string",
      "port": 0,
      "isEnabled": true,
      "authenticationMechanism": {
        "method": "string",
        "credentials": "string",
        "secretsURL": "string"
      },
      "additionalParameter": "string",
      "createdBy": "string"
}

# Accepted Values (Enums)

Type	Description
ConnectionType	"Direct", "Bridge"
SourceSystemNetwork	"Protocols", "Database", "Cloud Storage", "Quality", "File", "Operation", "ERP"
SourceSystemType	"Soap", "OData", "MySQL", "Postgres", "Mongo", "Oracle", "ABB Ability Platform", "Azure Blob Storage", "Rest", "Amazon S3", "ABB Knowledge Manager", "CSV", "Excel", "Modbus", "OPC-DA", "OPC-UA", "OSI-PI", "AspenTech", "IBM Maximo Core", "IBM Maximo Rest", "IBM Maximo Writeback", "SAP Plant Maintenance (PM)", "SAP Plant Maintenance (PM) Writeback", "SAP Sales and Distribution (SD)", "SAP Finance and controlling (FICO)", "SAP Material Management (MM)", "SAP Production Planning (PP)", "SAP Quality Management (QM)", "SAP Project System (PS)"
Method	"Basic", "OAuth2", "Anonymous", "No Auth", "ApiKey", "Bearer Token"
Credentials	"KeyVault", "K8S Secrets"

# Responses

Code	Description	Schema
201	Successfully Created.	DataSourceConnection
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc
401	Not Authorized. Either the Access token is missing or the access token validation failed	ServiceErrors
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource	ServiceErrors
409	Conflict. Connection with same name/id already exists.
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# PUT Update Connection

# /data-catalog/api/connection

# Description

Updates a Data Source Connection for given ConnectionId BaseSchema validation is performed to check the accepted values for the parameters from list of Enum values.

# Payload

  {
  "connectionId": "string",
  "connectionName": "string",
  "description": "string",
  "host": "string",
  "port": 0,
  "isEnabled": true,
  "authenticationMechanism": {
    "method": "string",
    "credentials": "string",
    "secretsURL": "string"
  },
  "additionalParameter": "string",
  "lastModifiedBy": "string"
}

# Accepted Values (Enums)

Type	Description
ConnectionType	"Direct", "Bridge"
SourceSystemNetwork	"Protocols", "Database", "Cloud Storage", "Quality", "File", "Operation", "ERP"
SourceSystemType	"Soap", "OData", "MySQL", "Postgres", "Mongo", "Oracle", "ABB Ability Platform", "Azure Blob Storage", "Rest", "Amazon S3", "ABB Knowledge Manager", "CSV", "Excel", "Modbus", "OPC-DA", "OPC-UA", "OSI-PI", "AspenTech", "IBM Maximo Core", "IBM Maximo Rest", "IBM Maximo Writeback", "SAP Plant Maintenance (PM)", "SAP Plant Maintenance (PM) Writeback", "SAP Sales and Distribution (SD)", "SAP Finance and controlling (FICO)", "SAP Material Management (MM)", "SAP Production Planning (PP)", "SAP Quality Management (QM)", "SAP Project System (PS)"
Method	"Basic", "OAuth2", "Anonymous", "No Auth", "ApiKey", "Bearer Token"
Credentials	"KeyVault", "K8S Secrets"

# Responses

Code	Description	Schema
201	Successfully Created.	DataSourceConnection
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc
401	Not Authorized. Either the Access token is missing or the access token validation failed	ServiceErrors
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource	ServiceErrors
404	Connection with given detail is not found.
409	Conflict. Connection with same name/id already exists.
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# DELETE Delete Connection

# /data-catalog/api/connection/{connectionId}

# Description

Deletes the data source connection for the specified ConnectionId.

# Parameters

Name	Located in	Description	Required	Schema
ConnectionId	path	Connection Id	Yes	string

# Responses

Code	Description	Schema
204	Connection successfully deleted.
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc
401	Not Authorized. Either the Access token is missing or the access token validation failed	ServiceErrors
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource	ServiceErrors
404	Connection not found for specified connectionId
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET OT Source Connections

# /data-catalog/api/connection/OTSources

# Description

Get list of OT data source connections. It will list ConnectionId and ConnectionName for all the OT source connections.

# Responses

Code	Description	Schema
200	Success	OT source Connections json with ConnectionId and ConnectionName
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc
401	Not Authorized. Either the Access token is missing or the access token validation failed	ServiceErrors
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource	ServiceErrors
404	Connection not found for specified connectionId
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

← Models Information →