PUBLICAR /grupos/{groupId}/aplicaciones/{appId}/esquemas
Autorización de token

Defina un nuevo esquema para una colección vinculada. Al crear un esquema con este punto final, asegúrese de que la carga útil JSON no tenga escapes. Los formatos JSON con escapes incorrectos pueden provocar errores.

Parámetros de ruta

aplicación/json

Cuerpo Requerido

  • metadata Requerido

    Metadatos que describen a qué colección vinculada se aplica el esquema.

    Hide metadata attributes Mostrar atributos de metadatos
    • data_source string

      El nombre de la fuente de datos.

    • database string

      El nombre de la base de datos.

    • Colección string

      El nombre de la colección.

  • esquema Objeto

    Un esquema válido para la colección.

    Ocultar atributos del esquema Mostrar atributos del esquema Objeto
    • bsonType string

      El tipo BSON del campo.

      Los valores son object, array, string, number, int, long, double, decimal, date, timestamp, bool, null, regex, objectId, binary, uuid, function, javascript, symbol, minKey o maxKey.

    • Título string

      Un título legible para humanos para el esquema.

    • Requerido array[string]

      Para los esquemas object, una matriz de nombres de campos que se requieren en las instancias del objeto.

    • propiedades Objeto

      Un objeto donde cada nombre de campo es una propiedad del esquema. El valor correspondiente es una definición de esquema para ese campo.

      Ocultar atributo de propiedades Mostrar atributo de propiedades Objeto
  • relaciones Objeto

    Relaciones con colecciones externas. Cada nombre de campo es una propiedad del esquema. El valor correspondiente es una definición de relación para ese campo.

    Ocultar el atributo de relaciones Mostrar atributo de relaciones Objeto
    • * Objeto Propiedades adicionales

      Una definición de relación.

      Ocultar * atributos Mostrar * atributos Objeto
      • ref string

        Una cadena de referencia para la colección extranjera.

      • clave externa string

        El nombre del campo en la colección externa al que apunta la relación.

      • es_lista booleano

        Si true:

        • La relación puede apuntar a muchos documentos extranjeros.
        • El campo local debe definirse como una matriz en el esquema de colección.

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • _id string Requerido
    • metadata Objeto Requerido

      Metadatos que describen a qué colección vinculada se aplica el esquema.

      Hide metadata attributes Mostrar atributos de metadatos Objeto
      • data_source string

        El nombre de la fuente de datos.

      • database string

        El nombre de la base de datos.

      • Colección string

        El nombre de la colección.
POST /grupos/{groupId}/aplicaciones/{appId}/esquemas 
curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/schemas' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"metadata":{"data_source":"string","database":"string","collection":"string"},"schema":{"bsonType":"object","title":"string","required":["string"],"properties":{"*":{}}},"relationships":{"additionalProperty1":{"ref":"string","foreign_key":"string","is_list":true},"additionalProperty2":{"ref":"string","foreign_key":"string","is_list":true}}}'
Solicitar ejemplos 
{
  "metadata": {
    "data_source": "string",
    "database": "string",
    "collection": "string"
  },
  "schema": {
    "bsonType": "object",
    "title": "string",
    "required": [
      "string"
    ],
    "properties": {
      "*": {}
    }
  },
  "relationships": {
    "additionalProperty1": {
      "ref": "string",
      "foreign_key": "string",
      "is_list": true
    },
    "additionalProperty2": {
      "ref": "string",
      "foreign_key": "string",
      "is_list": true
    }
  }
}
Ejemplos de respuestas (200) 
{
  "_id": "string",
  "metadata": {
    "data_source": "string",
    "database": "string",
    "collection": "string"
  }
}