Function DataApiApiFactory

Returns {
    adminCreateDataApiConfig(groupId, appId, dataApiConfig, options?) => AxiosPromise<DataApiConfig>;
    adminGetDataApiConfig(groupId, appId, options?) => AxiosPromise<DataApiConfig>;
    adminGetDataApiVersions(groupId, appId, options?) => AxiosPromise<any>;
    adminModifyDataApiConfig(groupId, appId, dataApiConfig, options?) => AxiosPromise<void>;
}

• adminCreateDataApiConfig:function

  • adminCreateDataApiConfig(groupId, appId, dataApiConfig, options?): AxiosPromise<DataApiConfig>

  • Create your app's Data API configuration.

    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.

    • dataApiConfig: DataApiConfig

      A valid configuration object for the endpoint.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<DataApiConfig>

    Summary

    Enable the Data API

    Throws

• adminGetDataApiConfig:function

  • adminGetDataApiConfig(groupId, appId, options?): AxiosPromise<DataApiConfig>

  • Get your app's Data API configuration.

    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.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<DataApiConfig>

    Summary

    Get the Data API Configuration

    Throws

• adminGetDataApiVersions:function

  • adminGetDataApiVersions(groupId, appId, options?): AxiosPromise<any>

  • List all possible Data API versions.

    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.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List Data API versions

    Throws

• adminModifyDataApiConfig:function

  • adminModifyDataApiConfig(groupId, appId, dataApiConfig, options?): AxiosPromise<void>

  • Update your app's Data API configuration.

    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.

    • dataApiConfig: DataApiConfig

      A valid configuration object for the endpoint.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Modify the Data API

    Throws