@Path(value="/tags/{containerUid}") public interface ITags extends IDataShardSupport
Tag
(keyword and color).
The containerUid is obtained from ITagUids.getDefaultUserTags(String)
or can be a domain uid (ie. domain name).Modifier and Type | Method and Description |
---|---|
java.util.List<ItemValue<Tag>> |
all()
Find all
Tag s. |
java.util.List<java.lang.String> |
allUids()
List all
Tag uids in the container. |
ContainerChangelog |
changelog(java.lang.Long since)
Get all the changes that occurred on the container starting at the given
version.
|
ContainerChangeset<java.lang.String> |
changeset(java.lang.Long since)
ContainerChangeset of the container starting at given version. |
void |
create(java.lang.String uid,
Tag tag)
Create a new
Tag . |
void |
delete(java.lang.String uid)
Delete a
Tag . |
ItemValue<Tag> |
getComplete(java.lang.String uid)
Fetch a
Tag from its uid. |
java.util.List<ItemValue<Tag>> |
multipleGet(java.util.List<java.lang.String> uids)
Fetch multiple
Tag s from their uids. |
void |
update(java.lang.String uid,
Tag tag)
Update a
Tag . |
ContainerUpdatesResult |
updates(TagChanges changes)
Update multiple tags at once.
|
xfer
@PUT @Path(value="{uid}") void create(@PathParam(value="uid") java.lang.String uid, Tag tag)
Tag
. Tags can be associated with items and may be used
to categorize items or for searching.uid
- The unique identifiertag
- Tag
that will be created.ServerFault
- If anything goes wrong@POST @Path(value="{uid}") void update(@PathParam(value="uid") java.lang.String uid, Tag tag)
Tag
.uid
- The unique identifiertag
- Tag
that will be created.ServerFault
- If anything goes wrong@DELETE @Path(value="{uid}") void delete(@PathParam(value="uid") java.lang.String uid)
Tag
.uid
- The unique identifier of the Tag
tag
- Tag
that will be created.ServerFault
- If anything goes wrong@GET @Path(value="{uid}") ItemValue<Tag> getComplete(@PathParam(value="uid") java.lang.String uid)
Tag
from its uid.uid
- The unique identifierItemValue
ServerFault
- If anything goes wrong@POST @Path(value="_mget") java.util.List<ItemValue<Tag>> multipleGet(java.util.List<java.lang.String> uids)
Tag
s from their uids.uids
- the unique identifiers to fetchItemValue
ServerFault
- If anything goes wrong@GET java.util.List<ItemValue<Tag>> all()
Tag
s. Domain tags are not returned when this method is
invoked on ITagUids.defaultUserTags(String)
.Tag
sServerFault
- If anything goes wrong@PUT @Path(value="_mupdates") ContainerUpdatesResult updates(TagChanges changes)
changes
- the batch of changes to applyServerFault
- If anything goes wrong@GET @Path(value="_changelog") ContainerChangelog changelog(@QueryParam(value="since") java.lang.Long since)
since
- version of first changes to retrieveContainerChangelog
ServerFault
- If anything goes wrong@GET @Path(value="_changeset") ContainerChangeset<java.lang.String> changeset(@QueryParam(value="since") java.lang.Long since)
ContainerChangeset
of the container starting at given version.since
- version of first change to retrieveServerFault
- If anything goes wrong@GET @Path(value="_alluids") java.util.List<java.lang.String> allUids()
Tag
uids in the container.Tag
uidServerFault
- If anything goes wrongCopyright © 2021. All Rights Reserved.