Jump to

• Request
• Response

Retrieve Connection

get

[host-url]/dt-rest/v2/connections/{connectionId}

Retrieves a single Connection using the given ID.

Request

Path Parameters

• connectionId(required): string
  the ID of the connection to retrieve.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

a Response object containing the connection details in JSON format with a 200 OK status code.

Body ()

Root 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