plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

DriveFolder

DriveFolder

A folder in a drive: the tree plnnrly's file browser draws under a project, a customer, the organisation drive or a user's personal drive.

View as Markdown
Summary view
DriveFolderList, 16 fields. What a list returns by default.
Detail view
DriveFolder, 16 fields. The default for a single read and for every write.
Read with
api:read:project_driveorapi:read:customer_driveorapi:read:organization_driveorapi:read:user_driveandproject_drive::access
Write with
api:write:project_driveorapi:write:customer_driveorapi:write:organization_driveorapi:write:user_driveandproject_drive::create

A folder holds drive items and other folders, and it is where the drive's access rules are anchored: an item or a subfolder that inherits permissions takes them from the nearest ancestor folder that does not.

Used by

GETList drive folders/drive-foldersDriveFolderList
POSTCreate a drive folder/drive-foldersDriveFolder
GETRead a drive folder/drive-folders/{drive_folder}DriveFolder
PATCHUpdate a drive folder/drive-folders/{drive_folder}DriveFolder

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Unique identifier.

namestring≤ 255

Folder name as shown in the drive tree.

parent_idinteger or null

Folder this one sits in, or null at the drive root.

parent_folderRef or DriveFolderSummary or null

The folder this one sits in; absent for folders at the drive root.

owner_typestring

The kind of record owner points at; it says which branch of owner applies.

projectcustomerorganizationuser

New values may be added.

owner_idinteger

The id of the record owner points at.

ownerRef or ProjectSummary or CustomerSummary or UserSummary

The project, customer, organisation or user whose drive this folder lives in. An organisation-owned folder renders as a bare {"id": N} reference.

Which form you get depends on owner_type.

project
ProjectSummary
customer
CustomerSummary
organization
Ref
user
UserSummary
orderintegerServer-assigned

Sort position within the drive and level, as shown in the drive tree. Positions count per drive and level, so the sequence is only meaningful once the collection is narrowed to one drive and one level. It is not assigned on create, so a folder created through the API stays at 0 until it is positioned in plnnrly; reordering is not exposed in v2.0.

created_byinteger or nullServer-assigned

Author; always the authenticated user at create time. Null on legacy rows and where the author has since been deleted.

inherits_permissionsboolean

Whether this folder takes its permissions from its parent.

Variants

DriveFolderList 16 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

DriveFolderSummary 2 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: parent_id, parent_folder, owner_type, owner_id, owner, order, created_by, inherits_permissions, general_access, access, created_at, updated_at, drive_items_count, links

DriveFolderLinks 2 fields

The links object on this resource.

Keys: self, drive_items

Polymorphic fields

ownerWhich form you get depends on owner_type.