Function getDataFilesConnections

  • The non-filtered list contains a set of hardcoded connections, along with one connection per team space that the given user has access to.

    Parameters

    • query: {
          appId?: string;
          includeSpaceStats?: boolean;
          limit?: number;
          name?: string;
          page?: string;
          personal?: boolean;
          sort?: GetConnectionsSortField;
          spaceId?: string;
      }

      an object with query parameters

      • OptionalappId?: string

        If present, get connections with connection strings that are scoped to the given app ID.

      • OptionalincludeSpaceStats?: boolean

        If set to true, include computed space-level statistics for the spaces represented by the connections in the returned list. If false, this information is not returned.

      • Optionallimit?: number

        If present, the maximum number of data file connection records to return.

      • Optionalname?: string

        If present, only return connections with the given name.

      • Optionalpage?: string

        If present, the cursor that starts the page of data that is returned.

      • Optionalpersonal?: boolean

        If true, only return the connections that access data in a personal space. Default is false.

      • Optionalsort?: GetConnectionsSortField

        The name of the field used to sort the result. By default, the sort is ascending. Putting a '+' prefix on the sort field name explicitly indicates ascending sort order. A '-' prefix indicates a descending sort order.

      • OptionalspaceId?: string

        If present, only return the connection that accesses data files in the specified space.

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetDataFilesConnectionsHttpResponse>

    getDataFilesConnections(
    {
    appId: "f34b91a1-0dc3-44ac-a847-51cb84122c84",
    includeSpaceStats: false,
    limit: 5,
    name: "MySenseApp",
    page: "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1",
    personal: true,
    spaceId: "617979737a9f56e49dea2e6e"
    }
    )

    GetDataFilesConnectionsHttpError