Connection ID
an object with query parameters
Optional
byCredentialName?: booleanIf set to true, credentialId in the query will be interpreted as credential's name
Optional
credentialId?: stringCredential ID
Optional
extended?: booleanReturns extended list of properties (e.g. encrypted credential string) when set to true.
Optional
noCache?: booleandatafiles connections will be returned from cache by default (if data-connections is configured to use cache), this query parameter is used disable this default behavior, e.g. return an update-to-date datafiles connection if the query is set to true
Optional
parseConnection?: booleanList of connection properties shall be returned when the query is set to true, default is false
Optional
spaceId?: stringFiltering on connections by space ID
Optional
type?: "connectionname"The connection ID in the path becomes a connection name when this query parameter is set.
Optional
options: ApiCallOptions
Retrieves a connection by connection ID, or by name when the query parameter "type" is set to "connectionname."