Function SchemasApiAxiosParamCreator

Returns {
    adminCreateSchema: ((groupId, appId, adminCreateSchemaRequest, options?) => Promise<RequestArgs>);
    adminDeleteSchema: ((groupId, appId, schemaId, options?) => Promise<RequestArgs>);
    adminGetNullTypeSchemaValidationSetting: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminGetSchema: ((groupId, appId, schemaId, options?) => Promise<RequestArgs>);
    adminListSchemas: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminSetNullTypeSchemaValidationSetting: ((groupId, appId, nullTypeSchemaValidationSetting, options?) => Promise<RequestArgs>);
    adminUpdateSchema: ((groupId, appId, schemaId, adminUpdateSchemaRequest, options?) => Promise<RequestArgs>);
    adminValidateDocuments: ((groupId, appId, datasourceId, adminValidateDocumentsRequest, options?) => Promise<RequestArgs>);
}

• adminCreateSchema: ((groupId, appId, adminCreateSchemaRequest, options?) => Promise<RequestArgs>)

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

    • Define a new schema for a linked collection.

      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.

      • adminCreateSchemaRequest: AdminCreateSchemaRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Create a schema

      Throws

• adminDeleteSchema: ((groupId, appId, schemaId, options?) => Promise<RequestArgs>)

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

    • Delete a specific schema by its _id value.

      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.

      • schemaId: any

        The unique `_id` value of a schema.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Delete a schema

      Throws

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

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

    • Check if null type schema validation is enabled.

      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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get Null Type Schema Validation Setting

      Throws

• adminGetSchema: ((groupId, appId, schemaId, options?) => Promise<RequestArgs>)

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

    • Get a specific schema by its _id value.

      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.

      • schemaId: any

        The unique `_id` value of a schema.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get a schema

      Throws

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

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

    • List all defined schemas.

      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: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List schemas

      Throws

• adminSetNullTypeSchemaValidationSetting: ((groupId, appId, nullTypeSchemaValidationSetting, options?) => Promise<RequestArgs>)

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

    • Enable or disable null type schema validation.

      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.

      • nullTypeSchemaValidationSetting: NullTypeSchemaValidationSetting

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Set Null Type Schema Validation Setting

      Throws

• adminUpdateSchema: ((groupId, appId, schemaId, adminUpdateSchemaRequest, options?) => Promise<RequestArgs>)

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

    • Replace an existing schema with a new one.

      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.

      • schemaId: any

        The unique `_id` value of a schema.

      • adminUpdateSchemaRequest: AdminUpdateSchemaRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Update a schema

      Throws

• adminValidateDocuments: ((groupId, appId, datasourceId, adminValidateDocumentsRequest, options?) => Promise<RequestArgs>)

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

    • Query a subset of documents in a collection and validate each match against a schema.

      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.

      • datasourceId: any

        The unique `_id` value of a MongoDB data source.

      • adminValidateDocumentsRequest: AdminValidateDocumentsRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Sample & Validate Documents

      Throws