하나의 문서 찾기

POST /action/findOne

AccessToken 이메일 & 비밀번호 Api key Custom jwt

쿼리와 일치하는 단일 문서를 찾습니다.

body

dataSource 문자열 필수 사항

연결된 MongoDB Atlas 데이터 소스의 이름입니다. 이는 일반적으로 "mongodb-atlas"이지만 데이터 소스를 생성할 때 다른 이름을 선택한 경우 앱에서 해당 이름이 다를 수 있습니다.
database 문자열 필수 사항

지정된 데이터 소스에 있는 데이터베이스의 이름입니다.
컬렉션 문자열 필수 사항

지정된 데이터베이스에 있는 컬렉션의 이름입니다.
필터 객체

문서와 일치하는 MongoDB 쿼리 필터입니다. 데이터 API가 지원하는 모든 쿼리 작업자 목록은 쿼리 작업자를 참조하세요.
프로젝션 객체

작업에서 반환된 일치하는 문서에 대한 MongoDB 프로젝션입니다.
프로젝션 속성 숨기기 프로젝션 속성 표시 객체
- * 숫자 additionalProperties
  
  값은 0 또는 1입니다.

body

dataSource 문자열 필수 사항

연결된 MongoDB Atlas 데이터 소스의 이름입니다. 이는 일반적으로 "mongodb-atlas"이지만 데이터 소스를 생성할 때 다른 이름을 선택한 경우 앱에서 해당 이름이 다를 수 있습니다.
database 문자열 필수 사항

지정된 데이터 소스에 있는 데이터베이스의 이름입니다.
컬렉션 문자열 필수 사항

지정된 데이터베이스에 있는 컬렉션의 이름입니다.
필터 객체

문서와 일치하는 MongoDB 쿼리 필터입니다. 데이터 API가 지원하는 모든 쿼리 작업자 목록은 쿼리 작업자를 참조하세요.
프로젝션 객체

작업에서 반환된 일치하는 문서에 대한 MongoDB 프로젝션입니다.
프로젝션 속성 숨기기 프로젝션 속성 표시 객체
- * 숫자 additionalProperties
  
  값은 0 또는 1입니다.

응답

200

application/json

application/json application/ejson

Found
응답 속성 숨기기 응답 속성 표시 객체
- 문서 객체 | null
  
  지정된 필터하다 와 일치하는 문서 입니다. 일치하는 문서가 없는 경우 이는 null입니다.
응답 속성 숨기기 응답 속성 표시 객체
- 문서 객체 | null
  
  지정된 필터하다 와 일치하는 문서 입니다. 일치하는 문서가 없는 경우 이는 null입니다.
400 application/json

요청 형식이 잘못되었거나 불완전했습니다.
다음 중 하나입니다.
ErrorNoAuthenticationSpecified 객체 ErrorMissingAuthenticationParameter 객체
요청 인증 자격 증명 포함되지 않았음을 나타냅니다.

속성 숨기기 속성 표시

오류 문자열

오류를 설명하는 메시지입니다.

값은 no authentication methods were specified입니다.

error_code 문자열

오류 유형입니다.

값은 InvalidParameter입니다.

링크 문자열

실패한 작업에 대한 로그 항목 의 링크입니다.
요청 본문 또는 헤더에서 인증 매개변수가 누락되었음을 나타냅니다. 예시 를 들어 요청 email 헤더는 포함되지만 해당 password 헤더는 포함되지 않을 수 있습니다.

속성 숨기기 속성 표시

오류 문자열

오류를 설명하는 메시지입니다.

값은 must specify some form of authentication (either email+password, api-key, or jwt) in the request header or body입니다.

error_code 문자열

오류 유형입니다.

값은 MissingParameter입니다.

링크 문자열

실패한 작업에 대한 로그 항목 의 링크입니다.
401 application/json

인증된 사용자에게 이 엔드포인트 액세스 할 수 있는 권한이 없습니다.
응답 속성 숨기기 응답 속성 표시 객체
제공된 인증 자격 증명 일치하는 사용자가 없음을 나타냅니다.
- 오류 문자열
  
  오류를 설명하는 메시지입니다.
  
  값은 invalid session: error finding user for endpoint입니다.
- error_code 문자열
  
  오류 유형입니다.
  
  값은 InvalidSession입니다.
- 링크 문자열
  
  실패한 작업에 대한 로그 항목 의 링크입니다.

POST /조치/findOne

curl -s "https://data.mongodb-api.com/app/$CLIENT_APP_ID/endpoint/data/v1/action/findOne" \
  -X POST \
  -H "apiKey: $API_KEY" \
  -H 'Content-Type: application/ejson' \
  -H "Accept: application/json" \
  -d '{
    "dataSource": "mongodb-atlas",
    "database": "learn-data-api",
    "collection": "tasks",
    "filter": {
      "text": "Do the dishes"
    }
  }'

요청 예시

{
  "filter": {
    "text": "Do the dishes"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas",
  "projection": {
    "text": 1,
    "status": 1
  }
}

요청 예시

{
  "filter": {
    "text": "Do the dishes"
  },
  "database": "todo",
  "collection": "tasks",
  "dataSource": "mongodb-atlas",
  "projection": {
    "text": 1,
    "status": 1
  }
}

응답 예시(200)

{
  "document": {
    "_id": "6193504e1be4ab27791c8133",
    "text": "Do the dishes",
    "status": "open"
  }
}

응답 예시(200)

{
  "document": {
    "_id": {
      "$oid": "6193504e1be4ab27791c8133"
    },
    "text": "Do the dishes",
    "status": "open"
  }
}

응답 예시(400)

{
  "error": "no authentication methods were specified",
  "error_code": "InvalidParameter",
  "link": "string"
}

{
  "error": "must specify some form of authentication (either email+password, api-key, or jwt) in the request header or body",
  "error_code": "MissingParameter",
  "link": "string"
}

응답 예시(401)

{
  "error": "invalid session: error finding user for endpoint",
  "error_code": "InvalidSession",
  "link": "string"
}