Obtener un esquema | Documentación de la API de administración de servicios de aplicaciones de MongoDB Atlas 3.0

Obtener un esquema Obsoleto

Obtener /grupos/{groupId}/aplicaciones/{appId}/esquemas/{schemaId}

Autorización de token

Obtenga un esquema específico por su _id valor.

Parámetros de ruta

ID de grupo string Requerido

Un ID de proyecto/grupo Atlas.
ID de aplicación string Requerido

El ObjectID de tu aplicación. La sección de ID de Proyecto y ID de la aplicación de App Services API muestra cómo encontrar este valor.
schemaId string Requerido

El valor único _id de un esquema.

Respuestas

200 aplicación/json

Vale
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- metadata Objeto
  
  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.
- 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
  
  * Objeto
  
  Un esquema válido para la colección.
- 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.

OBTENER /grupos/{groupId}/aplicaciones/{appId}/esquemas/{schemaId}

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/schemas/{schemaId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Ejemplos de respuestas (200)

{
  "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
    }
  }
}