Data connections

Provides an alternate name to be used for data[] element in GET response.

Returns extended list of properties when set to true.

Filtering on connections by space ID

Filtering on connections, connections in personal space will be returned if set to true

Filtering on datafile connections by owner (i.e. app) ID.

Filtering on conneections, return connections owned by the caller if set to true (doesn't apply to datafiles connectionos)

Number of resources to be returned

Name of field sort on for pagination, with prefix with + or - indicating ascending or descending order. When used for data-connections, sort field only applies to non-datafiles connections. Whatever sorting order is, datafiles connections will be returned after all regular connections being returned.

Pagination sursor string, which is generated auotmatically in previous pagination query.

Datafiles connections will not be returned if set to true

Filtering on userId. Requires admin role if specified userId doesn't match that is defined in JWT.

Sort results will be returned in case insensitive order if set to true (Only used along with sort query)

ICU locale ID, used only when caseinsensitive is set to true, default to 'en' if undefined

Base Qri (encrypted) will be returned when the query is set to true, default is false

List connections with optional filter queries. Connections will be filtered internally based on the space access rules applicable to the caller. When some of connections are not returned due to errors, errors array in the response will be set.

Bad request, typically when dataName is empty

Internal error, this happens when the service fails to make requests to dependency services

Bad gateway, this happens when the requests to dependency services are timedout

Data connection created

Invalid data connection specified

User has no access to the connection or space

Credentials pointed by qCredentialsID in the request body doesn't exist

Data connection already exists

Connection ID

Returns extended list of properties when set to true.

Connection / credential ID defined in path become connection / credential name when this query parameter is set

Credential ID

If set to true, credentialId in the query will be intepreted as credential's name

Filtering on connections by space ID

datafiles 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

Data connection fetched

qID is an invalid UUID

User has no access to the connection or space

Data connection not found

Credential decryption failed, which is most likely caused by invalid credentials

Connection ID

Connection / credential ID defined in path become connection / credential name when this query parameter is set

Data connection updated successfully

Bad request due to invalid data in body

User has no access to the connection or space

Data connection not found

Data connection already exists (when updated name conflicts with existing record)

Connection ID

Connection / credential ID defined in path become connection / credential name when this query parameter is set

Filtering on connections by space ID

Data connection updated successfully

Bad request due to invalid data in body

User has no access to the connection or space

Data connection not found

Data connection already exists (when updated name conflicts with existing record)

Connection ID

Connection / credential ID defined in path become connection / credential name when this query parameter is set

Filtering on connections by space ID

Data connection deleted successfully

User has no access to the connection or space

Data connection not found

Bulk delete completed

Bad request (Missing required field in request body)

User has no access to the endpoint. The endpoint requires Admin role

Duplicate completed

Bad request (Missing required field in request body, or duplicate from / to a reserved connection)

User has no access to the source connection or no access to target space

Connection defined by id not found

Duplicated connection would result in a name conficts with the connections in the scope

Bulk update completed

Bad request (Missing required field in request body)

User has no access to the endpoint. The endpoint requires Admin role

ID of the source connection being duplicated

Optional name for the duplicated connection, must be unique in the target scope. If not specified, a name will be automatically generated

Optional target space ID for the duplicated connection. If not specified, the duplicated connection will be in the same space as the source connection

Optional credential password, specify to override credential embedded (or associated) with the source connection

Optional credential username, specify to override credential embedded (or associated) with the source connection

Unique identifier (UUID) for the data connection, must be same as qEngineObjectID

Encrypted base Qri string

User ID of the connection's creator

Descriptive name of the data connection

Type of connection - indicates connection provider type

ID of the space to which the connection belongs

Indicates the type of user associated with the data connection

0

1

LOG_ON_SERVICE_USER

LOG_ON_CURRENT_USER

Tenant ID of the connection's creator (Only when extended=true in query)

Datetime when the connection was created

Datetime when the connection was last updated

Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection

Data source ID

0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified.

0

1

Reference key of credential in redis

ID of the credential associated with the connection

Unique identifier (UUID) for the data connection, must be same as qID

Name of the credential associated with the connection

Connection string for the data connection

String that contains connection specific secret (or password). This field will not be included in response of GET /data-connections, will only be included in the response of GET /data0connections/{qID}

Indicates whether or not this is a credential-less connection

Unique identifier (UUID) for the data connection. A UUID will be generated automatically if qID is not specified or empty

ID of the cloud app that owns this connection

Descriptive name of the data connection

Type of connection - indicates connection provider type

ID of the space to which the connection belongs

Indicates the type of user associated with the data connection.

0

1

LOG_ON_SERVICE_USER

LOG_ON_CURRENT_USER

Any logon password associated with the data connection

Any logon username associated with the data connection

ID of the datasource associated with this connection

QRI string of the connection. The string will be persisted to mongo when the request is originated from trusted client (i.e. dcaas) to avoid invalid QRi string.

0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified.

0

1

ID of the credential associated with the connection

Unique identifier (UUID) for the data connection as specified by the Sense engine. A UUID will be generated automatically if this field is not specified or empty

Name of the credential associated with the connection

Connection string for the data connection

String that contains connection specific secret (or password) that requires encryption before persist to database. This field is connection level secret

Indicates whether or not to create a credential-less connection

Unique identifier (UUID) for the data connection, must be same as qEngineObjectID

User ID of the connection's creator

Descriptive name of the data connection

Type of connection - indicates connection provider type

ID of the space to which the connection belongs

Indicates the type of user associated with the data connection.

0

1

LOG_ON_SERVICE_USER

LOG_ON_CURRENT_USER

Datetime when the connection was created

Datetime when the connection was last updated

0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified.

0

1

Reference key of credential in redis

ID of the credential associated with the connection

Unique identifier (UUID) for the data connection, must be same as qID

Name of the credential associated with the connection

Connection string for the data connection

Indicates whether or not this is a credential-less connection

Unique identifier for the data connection

Descriptive name of the data connection

Type of connection - indicates connection provider type

ID of the space to which the connection belongs

Indicates the type of user associated with the data connection.

0

1

LOG_ON_SERVICE_USER

LOG_ON_CURRENT_USER

Any logon password associated with the data connection

Any logon username associated with the data connection

ID of the datasource associated with this connection

0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified.

0

1

ID of the credential associated with the connection

Unique identifier for the data connection as specified by the Sense engine

Name of the credential associated with the connection

Connection string for the data connection

String that contains connection level secret (or password). If this field presents in request, then existing connection secret will be updated to its value. If is an empty string, then eixsting connection secret will be cleared. If this field is missing, existing secret will not be updated.

Indicates whether or not this is a credential-less connection

Unique internal error code

A summary in english explaining what went wrong

More concrete details

HTTP status code

Unique internal error code

A summary in english explaining what went wrong

More concrete details

HTTP status code

Link to cirrent query

Total count of resources being requested.

URL link to next page of requested resources (available to paged request only)

URL link to previous page of requested resources (available to paged request only)

Link to cirrent query