ข้ามไปยังเนื้อหา
Sursa Developers

GET/v1/folders

ดึงโครงสร้างโฟลเดอร์ของทุกคอลเลกชัน

folder_trees

ส่งคืนโครงสร้างโฟลเดอร์ของทุกคอลเลกชันที่ผู้ใช้มองเห็นออบเจ็กต์อย่างน้อยหนึ่งรายการในการตอบกลับเดียว โดยใช้กฎการมองเห็นเดียวกับ GET /v1/collections/{name}/folders และเรียงตามลำดับของ GET /v1/collections คอลเลกชันที่ไม่มีออบเจ็กต์ที่มองเห็นได้จะไม่รวมอยู่ด้วย นอกจาก cards แล้ว แต่ละโฟลเดอร์ยังมีผลรวมของต้นไม้ย่อย cards_total sensitive_total และ top_category เมื่อใช้ updated_since หรือ metadata[<key>]= ฟิลด์ folders ของแต่ละคอลเลกชันจะมีโฟลเดอร์ที่ตรงเงื่อนไขเป็นรายการแบบแบน (children ว่างเปล่า และ parent_id บอกตำแหน่งในต้นไม้) เมื่อใช้ updated_since โฟลเดอร์จะเรียงตาม updated_at จากน้อยไปมาก แล้วตาม id หากไม่ใช้จะเรียงตามลำดับ sort_key คอลเลกชันที่ไม่มีโฟลเดอร์ที่ตรงเงื่อนไขจะไม่รวมอยู่ด้วย

การยืนยันตัวตน

ส่งคีย์ API ในเฮดเดอร์ Authorization: Authorization: Bearer <คีย์>

พารามิเตอร์คิวรี

  • limitinteger

    ขนาดหน้า ถ้าไม่มี limit และ cursor จะส่งคืนรายการทั้งหมด ถ้ามีจะส่งคืนไม่เกิน limit รายการ และแจ้งหน้าถัดไปในเฮดเดอร์ Link (rel="next") และ X-Next-Cursor

    ≥ 1, ≤ 200

  • cursorstring

    เคอร์เซอร์ของหน้าถัดไปจาก X-Next-Cursor หรือ next_cursor ของการตอบกลับก่อนหน้าที่ใช้ตัวกรองเดียวกัน เคอร์เซอร์มีขนาดหน้าอยู่ในตัว ถ้าใช้ร่วมกับ offset: 422 validation.failed ถ้าเป็นเคอร์เซอร์ของรายการอื่น ของตัวกรองอื่น หรือมีรูปแบบผิด: 400 api.cursor_invalid

    length ≤ 512

  • updated_sincestring (date-time)

    เฉพาะออบเจ็กต์ที่มี updated_at ตรงกับหรือหลังเวลานี้ (RFC 3339 พร้อมออฟเซ็ต) สำหรับการซิงก์ เมื่อระบุพารามิเตอร์นี้ รายการจะเรียงตาม updated_at จากน้อยไปมาก แล้วตาม id และเคอร์เซอร์จะไล่ต่อตามลำดับนั้น ออบเจ็กต์ที่ลบแล้วไม่อยู่ในรายการ: การลบแจ้งมาเป็นอีเวนต์

    length ≤ 512

  • metadatamap of string

    กรองตาม metadata: metadata[<key>]=<value> ต้องตรงกันทุกตัวอักษร ระบุได้สูงสุด 3 เงื่อนไข และทุกเงื่อนไขต้องตรง (?metadata[team]=support&metadata[crm_id]=A-1042) เงื่อนไขมากกว่า 3 ข้อหรือคีย์ที่ไม่ถูกต้องจะส่งคืน 400 api.metadata_invalid

การตอบกลับ

200การตอบกลับเมื่อสำเร็จ

เฮดเดอร์การตอบกลับ

  • Link

    ที่อยู่ของหน้าถัดไป <…>; rel="next" ถ้าไม่มีเฮดเดอร์นี้แสดงว่าเป็นหน้าสุดท้าย

  • X-Next-Cursor

    เคอร์เซอร์ของหน้าถัดไปสำหรับพารามิเตอร์ cursor ถ้าไม่มีเฮดเดอร์นี้แสดงว่าเป็นหน้าสุดท้าย

  • RateLimit-Policy

    ขีดจำกัดที่มีผล ในรูปแบบของร่าง IETF draft-ietf-httpapi-ratelimit-headers: รายการคั่นด้วยจุลภาค "<name>";q=<quota>;w=<window in seconds> โดย key คืออัตราคำขอของคีย์ API (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือ user และเมื่อไม่มีข้อมูลรับรองคือ ip) ส่วน minute day และ month คือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTC

  • RateLimit

    ส่วนที่เหลือของแต่ละขีดจำกัดใน RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>

  • X-RateLimit-Limit

    ขีดจำกัดของรายการที่เข้มงวดที่สุดใน RateLimit-Policy (รายการที่เหลือคำขอน้อยที่สุด)

  • X-RateLimit-Remaining

    จำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด

  • X-RateLimit-Reset

    จำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต

application/json

ออบเจ็กต์: FolderTreeList

array of FolderTree
  • collection_idintegerจำเป็น
  • collection_namestringจำเป็น
  • collection_titlestringจำเป็น

    ชื่อคอลเลกชันสำหรับการแสดงผล

  • permissionsarray of stringจำเป็น

    สิทธิ์ที่มีผลของผู้ใช้บนคอลเลกชัน

  • unfiledintegerจำเป็น

    การ์ดของคอลเลกชันที่ผู้ใช้เข้าถึงได้และไม่ได้อยู่ในโฟลเดอร์ใด ไม่นับการ์ดที่เก็บเข้าคลังแล้ว เหมือนในรายการการ์ดค่าเริ่มต้น

  • foldersarray of FolderNodeจำเป็น
401ไม่ได้ส่งข้อมูลรับรอง (ไม่มีทั้งคุกกี้เซสชันและคีย์ API) หรือไม่พบคีย์

เฮดเดอร์การตอบกลับ

  • RateLimit-Policy

    ขีดจำกัดที่มีผล ในรูปแบบของร่าง IETF draft-ietf-httpapi-ratelimit-headers: รายการคั่นด้วยจุลภาค "<name>";q=<quota>;w=<window in seconds> โดย key คืออัตราคำขอของคีย์ API (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือ user และเมื่อไม่มีข้อมูลรับรองคือ ip) ส่วน minute day และ month คือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTC

  • RateLimit

    ส่วนที่เหลือของแต่ละขีดจำกัดใน RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>

  • X-RateLimit-Limit

    ขีดจำกัดของรายการที่เข้มงวดที่สุดใน RateLimit-Policy (รายการที่เหลือคำขอน้อยที่สุด)

  • X-RateLimit-Remaining

    จำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด

  • X-RateLimit-Reset

    จำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต

application/json

ออบเจ็กต์: Error

429คำขอมากเกินไป (`api.rate_limited`) โควตาขององค์กรสำหรับนาที วัน หรือเดือนหมดแล้ว (`api.quota_exceeded` โดย `error.details` มี `quota` `limit` และ `reset_at`) องค์กรใช้ถึงขีดจำกัดแล้ว หรือบริการคำตอบไม่ว่าง (`answers.engine_busy`) รอตามเวลาในเฮดเดอร์ `Retry-After`

เฮดเดอร์การตอบกลับ

  • Retry-After

    จำนวนวินาทีที่ต้องรอก่อนลองส่งคำขอใหม่

  • RateLimit-Policy

    ขีดจำกัดที่มีผล ในรูปแบบของร่าง IETF draft-ietf-httpapi-ratelimit-headers: รายการคั่นด้วยจุลภาค "<name>";q=<quota>;w=<window in seconds> โดย key คืออัตราคำขอของคีย์ API (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือ user และเมื่อไม่มีข้อมูลรับรองคือ ip) ส่วน minute day และ month คือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTC

  • RateLimit

    ส่วนที่เหลือของแต่ละขีดจำกัดใน RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>

  • X-RateLimit-Limit

    ขีดจำกัดของรายการที่เข้มงวดที่สุดใน RateLimit-Policy (รายการที่เหลือคำขอน้อยที่สุด)

  • X-RateLimit-Remaining

    จำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด

  • X-RateLimit-Reset

    จำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต

application/json

ออบเจ็กต์: Error

รหัสข้อผิดพลาด

รหัสที่เอนด์พอยต์นี้อาจส่งคืนใน error.code นอกเหนือจากรหัสทั่วไปของทุกคำขอ

ขีดจำกัดอัตราการเรียก

การตอบกลับมีเฮดเดอร์ RateLimit และ RateLimit-Policy รวมถึงเฮดเดอร์แบบเดิม X-RateLimit-Limit X-RateLimit-Remaining และ X-RateLimit-Reset การตอบกลับ 429 มี Retry-After เป็นวินาที ให้รอตามนั้นแล้วลองใหม่

← folders · เอกสารอ้างอิง API