Tags
In the middletwin platform tags are the object types that are used for grouping member objects together.
Tag object properties
Field | Required | Description |
id | Update/Delete | long – The id of an existing tag |
text | Yes | String – The text of the tag (64 max) |
Tags have the following actions
get_all_tags
This action will return an array list of all the tags in the system that have member associations. It has no options.
get_tags
This action will return an array list of all the tags in the system. It has no options.
get_matching_tags
This action will return an array of tags that have text that match a passed in string. This action has one required parameter named ‘text’ that will have the text to search for.
create_tag
This action will create a new tag and requires one parameter named ‘text’. You can optionally pass in a parameter named ‘members’ with an array of member id’s to associate with this new tag.
update_tag
This action will update an existing tag and requires two parameters, one named ‘id’ with the id of the tag to update and one named ‘text’ with the new text value for the tag.
delete_tag
This action will delete an existing tag and requires one parameter named ‘id’ with the id of the tag to delete.
get_tag_members
This action will return an array of member objects that are associated with a tag. It requires one parameter named ‘tag’ that contains the id of the tag.
create_tag_member
This action will create an association between an existing member and an existing tag. It requires two parameters, one named ‘member’ with the id of the member for the association and one named ‘tag’ with the id of the tag for the association.
delete_tag_member
This action will delete an association between an exiting tag and an existing member. It requires two parameters, one named ‘member’ with the id of the member for the association and one named ‘tag’ with the id of the tag for the association.