Function SchemasApiFp

Returns {
    adminCreateSchema(groupId, appId, adminCreateSchemaRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<AdminCreateSchema200Response>)>;
    adminDeleteSchema(groupId, appId, schemaId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminGetNullTypeSchemaValidationSetting(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<NullTypeSchemaValidationSetting>)>;
    adminGetSchema(groupId, appId, schemaId, options?) => Promise<((axios?, basePath?) => AxiosPromise<AdminGetSchema200Response>)>;
    adminListSchemas(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminSetNullTypeSchemaValidationSetting(groupId, appId, nullTypeSchemaValidationSetting, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminUpdateSchema(groupId, appId, schemaId, adminUpdateSchemaRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminValidateDocuments(groupId, appId, datasourceId, adminValidateDocumentsRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<AdminValidateDocuments200Response>)>;
}

• adminCreateSchema:function

  • adminCreateSchema(groupId, appId, adminCreateSchemaRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<AdminCreateSchema200Response>)>

  • 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<((axios?, basePath?) => AxiosPromise<AdminCreateSchema200Response>)>

    Summary

    Create a schema

    Throws

• adminDeleteSchema:function

  • adminDeleteSchema(groupId, appId, schemaId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete a schema

    Throws

• adminGetNullTypeSchemaValidationSetting:function

  • adminGetNullTypeSchemaValidationSetting(groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<NullTypeSchemaValidationSetting>)>

  • 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<((axios?, basePath?) => AxiosPromise<NullTypeSchemaValidationSetting>)>

    Summary

    Get Null Type Schema Validation Setting

    Throws

• adminGetSchema:function

  • adminGetSchema(groupId, appId, schemaId, options?): Promise<((axios?, basePath?) => AxiosPromise<AdminGetSchema200Response>)>

  • 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<((axios?, basePath?) => AxiosPromise<AdminGetSchema200Response>)>

    Summary

    Get a schema

    Throws

• adminListSchemas:function

  • adminListSchemas(groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • 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<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    List schemas

    Throws

• adminSetNullTypeSchemaValidationSetting:function

  • adminSetNullTypeSchemaValidationSetting(groupId, appId, nullTypeSchemaValidationSetting, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Set Null Type Schema Validation Setting

    Throws

• adminUpdateSchema:function

  • adminUpdateSchema(groupId, appId, schemaId, adminUpdateSchemaRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Update a schema

    Throws

• adminValidateDocuments:function

  • adminValidateDocuments(groupId, appId, datasourceId, adminValidateDocumentsRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<AdminValidateDocuments200Response>)>

  • 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<((axios?, basePath?) => AxiosPromise<AdminValidateDocuments200Response>)>

    Summary

    Sample & Validate Documents

    Throws