Μετάβαση στο περιεχόμενο
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 (η ποσόστωση είναι η ριπή, το παράθυρο είναι ο χρόνος για την πλήρη αναπλήρωσή της· για μια συνεδρία είναι 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Δεν στάλθηκαν διαπιστευτήρια (ούτε cookie συνεδρίας ούτε κλειδί API) ή το κλειδί δεν βρέθηκε.

Κεφαλίδες απόκρισης

  • RateLimit-Policy

    Τα όρια σε ισχύ, στη μορφή του προσχεδίου IETF draft-ietf-httpapi-ratelimit-headers: στοιχεία χωρισμένα με κόμμα "<name>";q=<quota>;w=<window in seconds>. Το key είναι ο ρυθμός αιτημάτων του κλειδιού API (η ποσόστωση είναι η ριπή, το παράθυρο είναι ο χρόνος για την πλήρη αναπλήρωσή της· για μια συνεδρία είναι 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 (η ποσόστωση είναι η ριπή, το παράθυρο είναι ο χρόνος για την πλήρη αναπλήρωσή της· για μια συνεδρία είναι 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