Delete document

정보

• 데이터 추가, 읽기, 변경, 삭제를 위해서는 client write secret이 필요합니다.

Overview

Path

DELETE/v1/collections/{collectionName}/documents/{docId}

• Collection에서 Document를 제거합니다

Example

---

curl -X DELETE https://api.invector.co/v1/collections/{collectionName}/documents/{docId} \
     -H "Content-Type: application/json" \
     -H "Authorization: Basic base64({CLIENT_ID}:{CLIENT_WRITE_SECRET})"

Authorization

---

Authorization

BasicBasic authorization at Header. Base64 encoding required

client_id

string

client_secret

string

example

 curl -X DELETE https://api.invector.co/v1/collections/{collectionName}/documents/{docId} \
      -H "Content-Type: application/json" \
      -H "Authorization: Basic base64({CLIENT_ID}:{CLIENT_WRITE_SECRET})" \
     ...

Path Parameters

---

collectionName

string

docId

string

Response Body

---

200

objectInformation about deleted document

_id

stringUnique Document ID.

deleted

booleanWhether document is deleted or not.

example

{
  "_id": "12345",
  "deleted": true
}