Changes
Page history
Complete sharing api documentation
authored
Jan 28, 2018
by
Marius David Wieschollek
Show whitespace changes
Inline
Side-by-side
Developers/Api/Folder-Api.md
View page @
2b3e2ce5
...
@@ -39,6 +39,8 @@ The properties "revisions", "parent", "folders" and "passwords" are also process
...
@@ -39,6 +39,8 @@ The properties "revisions", "parent", "folders" and "passwords" are also process
-
The base folder can not be edited at all
-
The base folder can not be edited at all
# Available api actions
# Available api actions
| Action | Url | Method | Description |
| Action | Url | Method | Description |
| --- | --- | --- | --- |
| --- | --- | --- | --- |
...
@@ -52,6 +54,8 @@ The properties "revisions", "parent", "folders" and "passwords" are also process
...
@@ -52,6 +54,8 @@ The properties "revisions", "parent", "folders" and "passwords" are also process
| restore |
`/api/1.0/folder/restore`
| PATCH | Restore an earlier state of a folder |
| restore |
`/api/1.0/folder/restore`
| PATCH | Restore an earlier state of a folder |
# The create action
# The create action
The create action creates a new folder with the given attributes.
The create action creates a new folder with the given attributes.
...
@@ -79,6 +83,8 @@ The success status code is `201 Created`
...
@@ -79,6 +83,8 @@ The success status code is `201 Created`
-
If the
`edited`
argument is "0", missing or in the future, the current time will be used
-
If the
`edited`
argument is "0", missing or in the future, the current time will be used
# The update action
# The update action
The update action creates a new revision of a folder with an updated set of attributes.
The update action creates a new revision of a folder with an updated set of attributes.
...
@@ -93,7 +99,6 @@ The update action creates a new revision of a folder with an updated set of attr
...
@@ -93,7 +99,6 @@ The update action creates a new revision of a folder with an updated set of attr
| hidden | bool | false | no | Whether or not the folder should be hidden |
| hidden | bool | false | no | Whether or not the folder should be hidden |
| favourite | bool | false | no | Whether or not the user has marked this folder as favourite |
| favourite | bool | false | no | Whether or not the user has marked this folder as favourite |
#### Return value
#### Return value
The success status code is
`200 Ok`
The success status code is
`200 Ok`
...
@@ -111,6 +116,8 @@ The success status code is `200 Ok`
...
@@ -111,6 +116,8 @@ The success status code is `200 Ok`
-
If the
`edited`
time is in the future, the current time will be used
-
If the
`edited`
time is in the future, the current time will be used
# The delete action
# The delete action
The delete action moves a folder and its content to the trash or deletes it completely if it is already in the trash.
The delete action moves a folder and its content to the trash or deletes it completely if it is already in the trash.
...
@@ -133,6 +140,8 @@ The success status code is `200 Ok`
...
@@ -133,6 +140,8 @@ The success status code is `200 Ok`
-
If a folder is deleted, all passwords and folders in it will be deleted as well
-
If a folder is deleted, all passwords and folders in it will be deleted as well
# The restore action
# The restore action
The restore action can restore an earlier state of a folder.
The restore action can restore an earlier state of a folder.
...
@@ -160,6 +169,8 @@ The success status code is `200 Ok`
...
@@ -160,6 +169,8 @@ The success status code is `200 Ok`
-
Deleted folders can not be restored
-
Deleted folders can not be restored
# The show action
# The show action
The show action lists the properties of a single folder.
The show action lists the properties of a single folder.
...
@@ -177,6 +188,8 @@ The return value is a folder object with the given detail level
...
@@ -177,6 +188,8 @@ The return value is a folder object with the given detail level
-
This is the only action that can access hidden folders
-
This is the only action that can access hidden folders
# The list action
# The list action
The list action lists all folders of the user except those in trash and the hidden ones.
The list action lists all folders of the user except those in trash and the hidden ones.
...
@@ -195,6 +208,8 @@ The return value is a list of folder objects with the given detail level
...
@@ -195,6 +208,8 @@ The return value is a list of folder objects with the given detail level
-
The list will not include suspended folders where a parent folder is in the trash
-
The list will not include suspended folders where a parent folder is in the trash
# The find action
# The find action
The find action can be used to find all folders matching the given search criteria.
The find action can be used to find all folders matching the given search criteria.
Only a specific set of fields is allowed in the criteria.
Only a specific set of fields is allowed in the criteria.
...
...
...
...