Amostra e validação de documentos

POSTAR /groups/{groupId}/apps/{appId}/services/{datasourceId}/commands/validate_documents

tokenAuth

Consulte um subconjunto de documentos em uma coleção e valide cada correspondência em relação a um esquema.

parâmetros de caminho

groupId string Obrigatório

Uma ID de projeto/grupo do Atlas.
appId string Obrigatório

O ObjectID do seu aplicativo. A seção de ID de projeto e aplicativo do App Services API mostra como localizar esse valor.
datasourceId string Obrigatório

O valor _id único de uma fonte de dados do MongoDB.

aplicação/json

corpo, corpo Obrigatório

nome do banco de dados string Obrigatório

O nome do banco de dados que contém a collection para validar.
collection_name string Obrigatório

O nome da coleção para validar.
from_schema objeto Obrigatório

O esquema EJSON para validar os documentos da amostra.
Query objeto

Uma query do MongoDB que corresponda a documentos na collection. O resultado da execução desta query é a população de amostra. Use isso para restringir a amostra a um subconjunto de documentos na collection.

O valor padrão é {} (vazio).
limit número

O número máximo de documentos a serem amostrados.

O valor padrão é 10000.
sort objeto

Uma classificação do MongoDB para a coleção. Use isso para determinar de qual extremidade de uma query de faixa iniciar a amostragem.

O valor padrão é {} (vazio).

Respostas

200 aplicação/json

OK
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- errors array[objeto]
  
  Ocultar atributos de erros Mostrar atributos de erros objeto
  
  error_code string
  
  Um erro de validação de esquema EJSON.
  
  Um dos seguintes:
  FalseValidationError string RequiredValidationError string InvalidTypeValidationError string ItemsMustBeUniqueValidationError string String em falta InternalValidationError string ConstValidationError string EnumValidationError string NumberAnyOfValidationError string NumberOneOfValidationError string NumberAllOfValidationError string NumberNotValidationError string NumberGTEValidationError string NumberGTValidationError string NumberLTEValidationError string NumberLTValidationError string MultipleOfValidationError string ArrayNoAdditionalItemsValidationError string ArrayMinItemsValidationError string ArrayMaxItemsValidationError string ArrayContainsValidationError string ArrayMinPropertiesValidationError string ArrayMaxPropertiesValidationError string AdicionalPropertyNotAllowedValidationError string InvalidPropertyPatternValidationError string InvalidPropertyNameValidationError string StringLengthGTEValidationError string StringLengthGTValidationError string StringLengthLTEValidationError string StringLengthLTValidationError string String NãoMatchPatternValidationError NãoMatchFormatValidationError string ConditionThenValidationError string ConditionElseValidationError string
  
  O valor é false.
  
  Um campo obrigatório está ausente.
  
  O valor é required.
  
  Um campo tem um tipo de valor inválido.
  
  O valor é invalid_type.
  
  Um campo contém uma array exclusiva com valores não exclusivos.
  
  O valor é unique.
  
  O valor é missing_dependency.
  
  O valor é internal.
  
  Um campo tem um valor constante inválido.
  
  O valor é const.
  
  Um campo tem um valor de enumeração inválido.
  
  O valor é enum.
  
  Um campo não corresponde a nenhum esquema em anyOf.
  
  O valor é number_any_of.
  
  Um campo não corresponde exatamente a um esquema em oneOf.
  
  O valor é number_one_of.
  
  Um campo não corresponde a todos os esquemas em allOf.
  
  O valor é number_all_of.
  
  Um campo corresponde a um esquema exclusivo em não.
  
  O valor é number_not.
  
  Um campo contém um número que não é maior ou igual ao valor mínimo.
  
  O valor é number_gte.
  
  Um campo contém um número que não é estritamente maior que o valor mínimo.
  
  O valor é number_gt.
  
  Um campo contém um número que não é menor ou igual ao valor máximo.
  
  O valor é number_lte.
  
  Um campo contém um número que não é estritamente menor que o valor máximo.
  
  O valor é number_lt.
  
  Um campo contém um número que não é múltiplo do valor especificado.
  
  O valor é multiple_of.
  
  Um campo contém uma array de tupla fechada com elementos adicionais inválidos.
  
  O valor é array_no_additional_items.
  
  Um campo contém uma array com poucos elementos.
  
  O valor é array_min_items.
  
  Um campo contém uma array com muitos elementos.
  
  O valor é array_max_items.
  
  Uma array não contém nenhum elemento de seu tipo contido.
  
  O valor é contains.
  
  Uma array não contém elementos suficientes do seu tipo contido.
  
  O valor é array_min_properties.
  
  Uma array contém muitos elementos do seu tipo contido.
  
  O valor é array_max_properties.
  
  Um campo está presente, mas não definido em um esquema fechado.
  
  O valor é additional_property_not_allowed.
  
  Um nome de campo que corresponde a uma propriedade de padrão não contém um valor válido.
  
  O valor é invalid_property_pattern.
  
  Um nome de campo é inválido.
  
  O valor é invalid_property_name.
  
  Um campo contém uma string que não é maior ou igual ao comprimento mínimo.
  
  O valor é string_gte.
  
  Um campo contém uma string que não é estritamente maior que o comprimento mínimo.
  
  O valor é string_gt.
  
  Um campo contém uma string que não é menor ou igual ao comprimento máximo.
  
  O valor é string_lte.
  
  Um campo contém uma string que não é estritamente menor que o comprimento máximo.
  
  O valor é string_lt.
  
  Um campo contém uma string que não corresponde ao padrão do campo.
  
  O valor é pattern.
  
  Um campo contém uma string com um formato inválido.
  
  O valor é format.
  
  Um valor não é válido quando uma expressão condicional avalia para true.
  
  O valor é condition_then.
  
  Um valor não é válido quando uma expressão condicional avalia para false.
  
  O valor é condition_else.
  
  error_count número
  
  O número de documentos de amostra que falharam nesta validação.
  
  Campo string
  
  O caminho do campo que falhou nesta validação.
  
  failed_ids array[string]
  
  Uma lista dos _id valores para documentos de amostra que falharam nesta validação.
  
  failed_documents_query objeto
  
  Um filtro de query do MongoDB que corresponda a documentos de amostra que falharam nesta validação.
- total_processed_count número
  
  O número total de documentos que foram amostrados.
- total_error_count número
  
  O número total de documentos que falharam em validação.

POST /groups/{groupId}/apps/{appId}/services/{datasourceId}/commands/validate_documents

curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/services/{datasourceId}/commands/validate_documents' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"database_name":"string","collection_name":"string","from_schema":{},"query":{},"limit":10000,"sort":{}}'

Exemplos de solicitação

{
  "database_name": "string",
  "collection_name": "string",
  "from_schema": {},
  "query": {},
  "limit": 10000,
  "sort": {}
}

Exemplos de resposta (200)

{
  "errors": [
    {
      "": "false",
      "error_count": 42.0,
      "field": "(root)._id",
      "failed_ids": [
        "string"
      ],
      "failed_documents_query": {}
    }
  ],
  "total_processed_count": 42.0,
  "total_error_count": 42.0
}

Amostra e validação de documentos

parâmetros de caminho

corpo, corpo Obrigatório

Respostas

error_code string