Function SyncApiAxiosParamCreator

Returns {
    adminGetFlexSync: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>);
    adminGetSync: ((serviceId, groupId, appId, options?) => Promise<RequestArgs>);
}

• adminGetFlexSync: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, serviceId, options?): Promise<RequestArgs>

    • Retrieve sync data for a specific Atlas App Services App when using Flexible Sync.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • serviceId: any

        The unique `_id` value of a service.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get Flexible Sync information

      Throws

• adminGetSync: ((serviceId, groupId, appId, options?) => Promise<RequestArgs>)

  • • (serviceId, groupId, appId, options?): Promise<RequestArgs>

    • Retrieve partition field data when using Partition-Based Sync.

      Parameters

      • serviceId: any

        The Service ID for the linked cluster.

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get Partition-Based Sync information

      Throws