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?: string;
      spaceId?: string;
      userId?: string;
  }

  an object with query parameters

  • Optionalcaseinsensitive?: boolean

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

  • OptionaldataName?: string

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

  • Optionalextended?: boolean

    Returns extended list of properties (e.g. encrypted credential string) when set to true.

  • Optionalfilter?: string

    Filtering resources by properties (filterable properties only) using SCIM filter string. Note the filter string only applies to connections managed by data-connections service, i.e. filtering doesn't apply to DataFile connections. When filtering on datetime property (e.g. created, updated), datetime should be in RFC3339 format.

  • OptionalincludeDisabled?: boolean

    Includes connections that uses disabled datasources

  • OptionalincludeQris?: boolean

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

  • Optionallimit?: number

    Number of resources to be returned (between 1 and 100)

  • Optionallocale?: string

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

  • OptionalnoDatafiles?: boolean

    Datafiles connections will not be returned if set to true

  • OptionalownedByMe?: boolean

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

  • Optionalowner?: string

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

  • Optionalpage?: string

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

  • Optionalpersonal?: boolean

    Filtering on personal connections, ignored if spaceId is defined in same request

  • Optionalsort?: string

    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.

  • OptionalspaceId?: string

    Filtering on connections by space ID

  • OptionaluserId?: string

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

• Optionaloptions: ApiCallOptions