Jump to

• Request
• Response

List Connections

get

[host-url]/dt-rest/v2/connections

Retrieves the list with all connections. This method supports various query parameters to filter and customize the response:

• fields: specifies the fields to include in the response (comma-separated)
• name: filters connections by name
• connectionType: filters connections by type of technology

The following examples demonstrate the supported query patterns:

• Retrieve all connections (no filters):

  Retrieves all available connections without any name or connection type filtering. All default fields for these connections will be included in the response.

  /connections


• Retrieve all connections with specific fields:

  Retrieves all connections, but the response for each connection will only include the fields specified in the fields parameter.

  /connections?fields=name,connectionId,...


• Filter by name only:

  Retrieves all connections that match the specified name. All default fields for these connections will be included in the response.

  /connections?name=your_connection_name


• Filter by name and select specific fields:

  Retrieves connections that match the given name, and the response for these connections will only include the fields specified in the fields parameter.

  /connections?name=your_connection_name&fields=name,connectionId,...


• Filter by connection type only:

  Retrieves all connections that belong to the specified connectionType. All default fields for these connections will be included in the response.

  /connections?connectionType=your_connection_type


• Filter by connection type and select specific fields:

  Retrieves connections that belong to the specified connectionType, and the response for these connections will only include the fields specified in the fields parameter.

  /connections?connectionType=your_connection_type&fields=name,connectionId,...

Request

Query Parameters

• connectionType: string
  filters connections by technology type
• fields: string
  comma-separated list of fields to include in the response
• name: string
  filters connections by name

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

a response object containing the list of connections

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ConnectionBaseDTO
  Represents a connection.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ConnectionBaseDTO"
    }
}

Nested Schema : ConnectionBaseDTO

Type: object

Represents a connection.

Show Source

• connectionId: string
• dateCreated: string (date-time)
• dateUpdated: string (date-time)
• name(required): string

{
    "type":"object",
    "description":"Represents a connection.",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "connectionId":{
            "type":"string"
        },
        "dateCreated":{
            "type":"string",
            "format":"date-time"
        },
        "dateUpdated":{
            "type":"string",
            "format":"date-time"
        }
    }
}

401 Response

Unauthorized

404 Response

Not Found

Back to Top