Define a new schema for a linked collection.
An Atlas Project/Group ID.
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.
Create a schema
SchemasApiInterface
Delete a specific schema by its _id
value.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a schema.
Optional
options: AxiosRequestConfig<any>Override http request option.
Delete a schema
SchemasApiInterface
Check if null type schema validation is enabled.
An Atlas Project/Group ID.
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.
Get Null Type Schema Validation Setting
SchemasApiInterface
Get a specific schema by its _id
value.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a schema.
Optional
options: AxiosRequestConfig<any>Override http request option.
Get a schema
SchemasApiInterface
List all defined schemas.
An Atlas Project/Group ID.
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.
List schemas
SchemasApiInterface
Enable or disable null type schema validation.
An Atlas Project/Group ID.
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.
Set Null Type Schema Validation Setting
SchemasApiInterface
Replace an existing schema with a new one.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a schema.
Optional
options: AxiosRequestConfig<any>Override http request option.
Update a schema
SchemasApiInterface
Query a subset of documents in a collection and validate each match against a schema.
An Atlas Project/Group ID.
The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
The unique `_id` value of a MongoDB data source.
Optional
options: AxiosRequestConfig<any>Override http request option.
Sample & Validate Documents
SchemasApiInterface
Generated using TypeDoc
SchemasApi - interface
Export
SchemasApi