Function getDataConnections

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"
          | "+_id"
          | "-_id"
          | "+qName"
          | "-qName"
          | "+updated"
          | "-updated";
      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

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

  • Optionalextended?: boolean

    When true, returns an extended set of properties, including the encrypted credential string.

  • Optionalfilter?: string

    Filter connections by property values using a SCIM filter string. Only filterable properties are supported. Filtering does not apply to datafile connections. Datetime values must be in RFC 3339 format, for example: created gt "2000-01-10T15:04:05Z".

  • OptionalincludeDisabled?: boolean

    When true, includes connections that use disabled data sources.

  • OptionalincludeQris?: boolean

    When true, includes the encrypted base QRI string in the response. Default is false.

  • Optionallimit?: number

    Maximum number of results to return per page. Defaults to 20 if not specified.

  • Optionallocale?: string

    An ICU locale identifier that controls case-insensitive sort order. Only applies when caseinsensitive is true. Defaults to en if not specified.

  • OptionalnoDatafiles?: boolean

    When true, datafile connections are excluded from the results.

  • OptionalownedByMe?: boolean

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

  • Optionalowner?: string

    Filter data file connections by owner (app) ID.

  • Optionalpage?: string

    Pagination cursor string, which is generated automatically in previous pagination query.

  • Optionalpersonal?: boolean

    When true, returns only personal connections. Ignored if spaceId is also specified.

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

    Field to sort results by. Prefix the field name with + for ascending order or - for descending order. This parameter is only applicable to paginated requests (e.g. ?limit=30&sort=+qName) For data connections, sorting only applies to non-datafile connections. Datafile connections are always returned after standard connections, regardless of sort order.

  • OptionalspaceId?: string

    Filter connections by space ID.

  • OptionaluserId?: string

    Filter by userId. Requires Admin role if specified userId doesn't match that is defined in JWT.

• Optionaloptions: ApiCallOptions