Function getDataConnections

getDataConnections(
    query: {
        caseinsensitive?: boolean;
        dataName?: string;
        extended?: boolean;
        filter?: string;
        includeDisabled?: boolean;
        includeQris?: boolean;
        limit?: number;
        locale?: string;
        noDatafiles?: boolean;
        ownedByMe?: boolean;
        owner?: string;
        page?: string;
        personal?: boolean;
        sort?:
            | "+created"
            | "-created"
            | "+updated"
            | "-updated"
            | "+_id"
            | "-_id"
            | "+qName"
            | "-qName";
        spaceId?: string;
        userId?: string;
    },
    options?: ApiCallOptions,
): Promise<dataConnections.GetDataConnectionsHttpResponse>
Use this operation to retrieve a list of data connections available to the caller. Results are filtered based on the caller's space access permissions. Use the spaceId, personal, or filter parameters to narrow results to a specific scope.
Parameters
- query: {
      caseinsensitive?: boolean;
      dataName?: string;
      extended?: boolean;
      filter?: string;
      includeDisabled?: boolean;
      includeQris?: boolean;
      limit?: number;
      locale?: string;
      noDatafiles?: boolean;
      ownedByMe?: boolean;
      owner?: string;
      page?: string;
      personal?: boolean;
      sort?:
          | "+created"
          | "-created"
          | "+updated"
          | "-updated"
          | "+_id"
          | "-_id"
          | "+qName"
          | "-qName";
      spaceId?: string;
      userId?: string;
  }
  an object with query parameters
  - Optionalcaseinsensitive?: boolean
    When true, sorting is applied case-insensitively. Only applies when sort is also specified.
  - OptionaldataName?: string
  - Optionalextended?: boolean
  - Optionalfilter?: string
  - OptionalincludeDisabled?: boolean
  - OptionalincludeQris?: boolean
  - Optionallimit?: number
  - Optionallocale?: string
  - OptionalnoDatafiles?: boolean
  - OptionalownedByMe?: boolean
  - Optionalowner?: string
  - Optionalpage?: string
  - Optionalpersonal?: boolean
  - Optionalsort?:
        | "+created"
        | "-created"
        | "+updated"
        | "-updated"
        | "+_id"
        | "-_id"
        | "+qName"
        | "-qName"
  - OptionalspaceId?: string
  - OptionaluserId?: string
- Optionaloptions: ApiCallOptions
Returns Promise<dataConnections.GetDataConnectionsHttpResponse>
Example
```
getDataConnections(
  {
    dataName: "data",
    extended: false,
    spaceId: "611bcebaeec1203d88211ac4",
    personal: false,
    owner: "928e2a66-01ba-4678-aa32-e74c213896fa",
    ownedByMe: true,
    limit: 30,
    page: "page=JwAAAAljcmVhdGVkAPfQ-sx0AQAAB19pZABfb93nZcM4SN1M0e8A",
    noDatafiles: true,
    userId: "6K9xjsItDexffolu5vg1oWYkY8x7f-0G",
    caseinsensitive: true,
    locale: "en",
    includeQris: true,
    includeDisabled: true
  }
)
```
Throws
GetDataConnectionsHttpError

Function getDataConnections

Parameters

`Optional`caseinsensitive?: boolean

`Optional`dataName?: string

`Optional`extended?: boolean

`Optional`filter?: string

`Optional`includeDisabled?: boolean

`Optional`includeQris?: boolean

`Optional`limit?: number

`Optional`locale?: string

`Optional`noDatafiles?: boolean

`Optional`ownedByMe?: boolean

`Optional`owner?: string

`Optional`page?: string

`Optional`personal?: boolean

`Optional`sort?:
    | "+created"
    | "-created"
    | "+updated"
    | "-updated"
    | "+_id"
    | "-_id"
    | "+qName"
    | "-qName"

`Optional`spaceId?: string

`Optional`userId?: string

Returns Promise<dataConnections.GetDataConnectionsHttpResponse>

Example

Throws

Settings

Function getDataConnections

Parameters

Optionalcaseinsensitive?: boolean

OptionaldataName?: string

Optionalextended?: boolean

Optionalfilter?: string

OptionalincludeDisabled?: boolean

OptionalincludeQris?: boolean

Optionallimit?: number

Optionallocale?: string

OptionalnoDatafiles?: boolean

OptionalownedByMe?: boolean

Optionalowner?: string

Optionalpage?: string

Optionalpersonal?: boolean

Optionalsort?: | "+created" | "-created" | "+updated" | "-updated" | "+_id" | "-_id" | "+qName" | "-qName"

OptionalspaceId?: string

OptionaluserId?: string

Returns Promise<dataConnections.GetDataConnectionsHttpResponse>

Example

Throws

Settings

`Optional`caseinsensitive?: boolean

`Optional`dataName?: string

`Optional`extended?: boolean

`Optional`filter?: string

`Optional`includeDisabled?: boolean

`Optional`includeQris?: boolean

`Optional`limit?: number

`Optional`locale?: string

`Optional`noDatafiles?: boolean

`Optional`ownedByMe?: boolean

`Optional`owner?: string

`Optional`page?: string

`Optional`personal?: boolean

`Optional`sort?:
| "+created"
| "-created"
| "+updated"
| "-updated"
| "+_id"
| "-_id"
| "+qName"
| "-qName"

`Optional`spaceId?: string

`Optional`userId?: string