| ... | ... | @@ -77,7 +77,7 @@ The success status code is `201 Created` |
|
|
|
|
|
|
|
#### Notes
|
|
|
|
- If the uuid of the parent folder is invalid or does not exist, the base folder uuid will be used instead
|
|
|
|
- If the folder is not hidden and should be created in a hidden folder, it will be created in the default folder instead
|
|
|
|
- If the folder is not hidden and should be created in a hidden folder, it will be created in the base folder instead
|
|
|
|
- If the `edited` argument is "0", missing or in the future, the current time will be used
|
|
|
|
|
|
|
|
|
| ... | ... | @@ -87,7 +87,7 @@ The update action creates a new revision of a folder with an updated set of attr |
|
|
|
#### Arguments
|
|
|
|
| Argument | Type | Default | Required | Description |
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
| id | string | - | yes | The id of the password object |
|
|
|
|
| id | string | - | yes | The id of the folder |
|
|
|
|
| label | string | - | yes | The label of the folder |
|
|
|
|
| parent | string | Base folder | no | The current parent folder |
|
|
|
|
| cseType | string | "none" | no | The client side encryption type |
|
| ... | ... | @@ -106,8 +106,124 @@ The success status code is `200 Ok` |
|
|
|
|
|
|
|
#### Notes
|
|
|
|
- If the uuid of the parent folder is invalid or does not exist, the base folder uuid will be used instead
|
|
|
|
- If the folder is not hidden and should be moved to a hidden parent folder, it will be moved to the default folder instead
|
|
|
|
- If the folder is not hidden and should be moved to a hidden parent folder, it will be moved to the base folder instead
|
|
|
|
- If hou hide a folder, all folders and passwords in it will be hidden as well
|
|
|
|
- If you unhide a folder no change to the folders and passwords in it will be made and they will remain hidden
|
|
|
|
- If the `edited` argument is "0" or missing, the timestamp from the last revision will be used
|
|
|
|
- If the `edited` time is in the future, the current time will be used
|
|
|
|
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
|
|
|
|
#### Arguments
|
|
|
|
| Arguments | Type | Default | Required | Description |
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
| id | string | - | yes | The id of the folder |
|
|
|
|
|
|
|
|
#### Return value
|
|
|
|
The success status code is `200 Ok`
|
|
|
|
|
|
|
|
| Argument | Type | Description |
|
|
|
|
| --- | --- | --- |
|
|
|
|
| id | string | The UUID of the folder |
|
|
|
|
| revision | string | The UUID of the new revision. Only if the folder was moved to the trash |
|
|
|
|
|
|
|
|
#### Notes
|
|
|
|
- If a folder is moved to the trash, all passwords and folders in it will be suspended and hidden from list and find actions
|
|
|
|
- If a folder is moved to the trash, the relations between tags and passwords in the folder will be hidden from the tag, but not the password
|
|
|
|
- If a folder is deleted, all passwords and folders in it will be deleted as well
|
|
|
|
|
|
|
|
|
|
|
|
# The restore action
|
|
|
|
The restore action can restore an earlier state of a folder.
|
|
|
|
|
|
|
|
#### Arguments
|
|
|
|
| Arguments | Type | Default | Required | Description |
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
| id | string | - | yes | The id of the folder |
|
|
|
|
| revision | string | - | no | The id of the revision |
|
|
|
|
|
|
|
|
#### Return value
|
|
|
|
The success status code is `200 Ok`
|
|
|
|
|
|
|
|
| Argument | Type | Description |
|
|
|
|
| --- | --- | --- |
|
|
|
|
| id | string | The UUID of the folder |
|
|
|
|
| revision | string | The UUID of the new revision |
|
|
|
|
|
|
|
|
#### Notes
|
|
|
|
- If no revision is given and the folder is in trash, it will be removed from trash
|
|
|
|
- If no revision is given and the folder is not in trash, nothing is done
|
|
|
|
- If a revision is given and the revision is marked as in trash, it will be removed from trash
|
|
|
|
- This action will always create a new revision
|
|
|
|
- The server side encryption type may change
|
|
|
|
- If the parent folder does not exist anymore, it will be moved to the base folder
|
|
|
|
- Deleted folders can not be restored
|
|
|
|
|
|
|
|
|
|
|
|
# The show action
|
|
|
|
The show action lists the properties of a single folder.
|
|
|
|
|
|
|
|
#### Arguments
|
|
|
|
| Argument | Type | Default | Required | Description |
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
| id | string | - | yes | The id of the folder |
|
|
|
|
| detailLevel | string | "model" | no | The detail level of the returned folder object |
|
|
|
|
|
|
|
|
#### Return value
|
|
|
|
The success status code is `200 Ok`
|
|
|
|
The return value is a folder object with the given detail level
|
|
|
|
|
|
|
|
#### Notes
|
|
|
|
- This is the only action that can access hidden folders
|
|
|
|
|
|
|
|
|
|
|
|
# The list action
|
|
|
|
The list action lists all folders of the user except those in trash and the hidden ones.
|
|
|
|
|
|
|
|
#### Arguments
|
|
|
|
| Argument | Type | Default | Required | Description |
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
| detailLevel | string | "model" | no | The detail level of the returned folder objects |
|
|
|
|
|
|
|
|
#### Return value
|
|
|
|
The success status code is `200 Ok`
|
|
|
|
The return value is a list of folder objects with the given detail level
|
|
|
|
|
|
|
|
#### Notes
|
|
|
|
- The list will not include trashed folders
|
|
|
|
- The list will not include hidden folders
|
|
|
|
- The list will not include suspended folders where a parent folder is in the trash
|
|
|
|
|
|
|
|
|
|
|
|
# The find action
|
|
|
|
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.
|
|
|
|
How the criteria array works is explained on the [object search page](./Object-Search.md).
|
|
|
|
|
|
|
|
#### Arguments
|
|
|
|
| Argument | Type | Default | Required | Description |
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
| criteria | array | [] | no | The search criteria |
|
|
|
|
| detailLevel | string | "model" | no | The detail level of the returned folder objects |
|
|
|
|
|
|
|
|
#### Allowed search fields
|
|
|
|
| Field | Type | Description |
|
|
|
|
| --- | --- | --- |
|
|
|
|
| created | int | Unix timestamp when the folder was created |
|
|
|
|
| updated | int | Unix timestamp when the folder was updated |
|
|
|
|
| edited | int | Unix timestamp when the user last renamed the folder |
|
|
|
|
| cseType | string | The client side encryption type |
|
|
|
|
| sseType | string | The server side encryption type |
|
|
|
|
| trashed | bool | Whether or not the folder is in the trash |
|
|
|
|
| favourite | bool | Whether or not the user has marked the folder as favourite |
|
|
|
|
|
|
|
|
#### Return value
|
|
|
|
The success status code is `200 Ok`
|
|
|
|
The return value is a list of folder objects that match the criteria with the given detail level
|
|
|
|
|
|
|
|
#### Notes
|
|
|
|
- The list will include trashed folders, so you need to filter that
|
|
|
|
- The list will not include hidden folders
|
|
|
|
- The list will not include suspended folders where a parent folder is in the trash |
|
|
\ No newline at end of file |
