Folder Properties

Each folder has the following properties and is accessed via /api/folder. Complete details in FolderProperties.

id

The unique id for this folder. It will never change.

wing_object_type

folder.

date_created

A date when the folder was created.

date_updated

A date when the folder was last updated.

name

The name the folder is known by.

parent_id

The unique id of a folder that this folder is a child of.

user_id

The unique id of a User that controls this folder.

Relationships

folders

The Folders contained in this folder.

files

The Files contained in this folder.

ancestors

The Folders before this one in the hierarchy.

Related Objects

user

The User that this folder is controlled by.

parent

The Folder that this folder is contained by, if any.

Folder Methods

The methods used to fetch and manipulate folders.

Create Folder

 POST /api/folder

session_id

Required. The unique session id provided by a Session method.

name

Required.

user_id

Required.

parent_id

Required.

Returns:

 {
   "id" : "xxx",
   "name" : "My Game",
   ...
 }

Update Folder

 PUT /api/folder/xxx

See Create Folder for details.

Delete Folder

 DELETE /api/folder/xxx

session_id

Required. The unique session id provided by a Session method.

Returns:

 {
   "success" : 1
 }

Fetch Folder

 GET /api/folder/xxx

session_id

Optional. The unique session id provided by a Session method.

_include_relationships

Optional. See "Relationships" in Intro and Folder Relationships above for details.

Returns:

 {
   "id" : "xxx",
   "name" : "My Game",
   ...
 }