class Asana::Resources::Tag
A tag is a label that can be attached to any task in Asana. It exists in a single workspace or organization.
Tags have some metadata associated with them, but it is possible that we will simplify them in the future so it is not encouraged to rely too heavily on it. Unlike projects, tags do not provide any ordering on the tasks they are associated with.
Attributes
Public Class Methods
Creates a new tag in a workspace or organization.
Every tag is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the `workspace` parameter regardless of whether or not it is an organization.
Returns the full record of the newly created tag.
workspace - [Id] The workspace or organization to create the tag in. options - [Hash] the request I/O options. data - [Hash] the attributes to post.
# File lib/asana/resources/tag.rb, line 48 def create(client, workspace: required("workspace"), options: {}, **data) with_params = data.merge(workspace: workspace).reject { |_,v| v.nil? || Array(v).empty? } self.new(parse(client.post("/tags", body: with_params, options: options)).first, client: client) end
Creates a new tag in a workspace or organization.
Every tag is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the `workspace` parameter regardless of whether or not it is an organization.
Returns the full record of the newly created tag.
workspace - [Id] The workspace or organization to create the tag in. options - [Hash] the request I/O options. data - [Hash] the attributes to post.
# File lib/asana/resources/tag.rb, line 65 def create_in_workspace(client, workspace: required("workspace"), options: {}, **data) self.new(parse(client.post("/workspaces/#{workspace}/tags", body: data, options: options)).first, client: client) end
Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned.
workspace - [Id] The workspace or organization to filter tags on. team - [Id] The team to filter tags on. archived - [Boolean] Only return tags whose `archived` field takes on the value of this parameter.
per_page - [Integer] the number of records to fetch per page. options - [Hash] the request I/O options.
# File lib/asana/resources/tag.rb, line 89 def find_all(client, workspace: nil, team: nil, archived: nil, per_page: 20, options: {}) params = { workspace: workspace, team: team, archived: archived, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? } Collection.new(parse(client.get("/tags", params: params, options: options)), type: self, client: client) end
Returns the complete tag record for a single tag.
id - [Id] The tag to get. options - [Hash] the request I/O options.
# File lib/asana/resources/tag.rb, line 74 def find_by_id(client, id, options: {}) self.new(parse(client.get("/tags/#{id}", options: options)).first, client: client) end
Returns the compact tag records for all tags in the workspace.
workspace - [Id] The workspace or organization to find tags in. per_page - [Integer] the number of records to fetch per page. options - [Hash] the request I/O options.
# File lib/asana/resources/tag.rb, line 99 def find_by_workspace(client, workspace: required("workspace"), per_page: 20, options: {}) params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? } Collection.new(parse(client.get("/workspaces/#{workspace}/tags", params: params, options: options)), type: self, client: client) end
Returns the plural name of the resource.
# File lib/asana/resources/tag.rb, line 32 def plural_name 'tags' end
Public Instance Methods
A specific, existing tag can be deleted by making a DELETE request on the URL for that tag.
Returns an empty data record.
# File lib/asana/resources/tag.rb, line 125 def delete() client.delete("/tags/#{id}") && true end
Returns the compact task records for all tasks with the given tag. Tasks can have more than one tag at a time.
per_page - [Integer] the number of records to fetch per page. options - [Hash] the request I/O options.
# File lib/asana/resources/tag.rb, line 135 def get_tasks_with_tag(per_page: 20, options: {}) params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? } Collection.new(parse(client.get("/tags/#{id}/tasks", params: params, options: options)), type: Task, client: client) end
Updates the properties of a tag. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged.
When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the task.
Returns the complete updated tag record.
options - [Hash] the request I/O options. data - [Hash] the attributes to post.
# File lib/asana/resources/tag.rb, line 116 def update(options: {}, **data) refresh_with(parse(client.put("/tags/#{id}", body: data, options: options)).first) end