... | ... | @@ -32,6 +32,8 @@ The properties "revisions" and "passwords" are also processed if necessary. |
|
|
| edited | Date | Date when the user last edited the tag |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Available api actions
|
|
|
| Action | Url | Method | Description |
|
|
|
| --- | --- | --- | --- |
|
... | ... | @@ -45,6 +47,8 @@ The properties "revisions" and "passwords" are also processed if necessary. |
|
|
| restore | `/api/1.0/tag/restore` | PATCH | Restore an earlier state of a tag |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# The create action
|
|
|
The create action creates a new tag with the given attributes.
|
|
|
|
... | ... | @@ -70,6 +74,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
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# The update action
|
|
|
The update action creates a new revision of a tag with an updated set of attributes.
|
|
|
|
... | ... | @@ -84,7 +90,6 @@ The update action creates a new revision of a tag with an updated set of attribu |
|
|
| hidden | bool | false | no | Whether or not the tag should be hidden |
|
|
|
| favourite | bool | false | no | Whether or not the user has marked this tag as favourite |
|
|
|
|
|
|
|
|
|
#### Return value
|
|
|
The success status code is `200 Ok`
|
|
|
|
... | ... | @@ -99,6 +104,8 @@ The success status code is `200 Ok` |
|
|
- If the `edited` time is in the future, the current time will be used
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# The delete action
|
|
|
The delete action moves a tag to the trash or deletes it completely if it is already in the trash.
|
|
|
|
... | ... | @@ -120,6 +127,8 @@ The success status code is `200 Ok` |
|
|
- If a tag is deleted, all relations to passwords are deleted
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# The restore action
|
|
|
The restore action can restore an earlier state of a tag.
|
|
|
|
... | ... | @@ -146,6 +155,8 @@ The success status code is `200 Ok` |
|
|
- Deleted tags can not be restored
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# The show action
|
|
|
The show action lists the properties of a single tag.
|
|
|
|
... | ... | @@ -163,6 +174,8 @@ The return value is a tag object with the given detail level |
|
|
- This is the only action that can access hidden tags
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# The list action
|
|
|
The list action lists all tags of the user except those in trash and the hidden ones.
|
|
|
|
... | ... | @@ -180,6 +193,8 @@ The return value is a list of tag objects with the given detail level |
|
|
- The list will not include hidden tags
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# The find action
|
|
|
The find action can be used to find all tags matching the given search criteria.
|
|
|
Only a specific set of fields is allowed in the criteria.
|
... | ... | |