Tag

---

List tags

Get a list of tags.

const response = await geocore.Tag.tagList({
  name: "name",
  defaultName: "defaultName",
  description: "description",
  page: 1,
  limit: 10,
});

Prerequisites

Successfully get the IdToken from login API.

Parameters

name	type	data type	description
name	optional	string	Search by tag name
defaultName	optional	string	Search by tag default name
description	optional	string	Search by tag description
page	optional	number	Page ordinal number
limit	optional	number	Number of records per page

Create tag

Create a new tag.

const response = await geocore.Tag.createTag({
  defaultName: "string",
  name: "string",
  description: "string",
  color: "string",
  groupId: "string"
});

Prerequisites

Successfully get the IdToken with companyAdmin access level from login API.

Parameters

name	type	data type	description
defaultName	required	string	Tag default name
name	required	string	Tag name
description	required	string	Tag description
color	required	string	Tag color in hexa format (e.g: #123456)
groupId	required	string	ID of group

Order tags

Change the display order of tags.

const response = await geocore.Tag.orderTag({
  tagIds: ["tagId"],
});

Prerequisites

Successfully get the IdToken with companyAdmin access level from login API.

Parameters

name	type	data type	description
tagIds	required	array<string>	Array of tag IDs in order

Update tag

Update a tag.

const response = await geocore.Tag.updateTag(
  tagId,
  {
    defaultName: "string",
    name: "string",
    description: "string",
    color: "string"
  }
);

Prerequisites

Successfully get the IdToken with companyAdmin access level from login API.

Parameters

name	type	data type	description
tagId	required	string	ID of tag
defaultName	required	string	Tag default name
name	required	string	Tag name
description	required	string	Tag description
color	required	string	Tag color in hexa format (e.g: #123456)

Delete tag

Delete a tag.

const response = await geocore.Tag.deleteTag(tagId);

Prerequisites

Successfully get the IdToken with companyAdmin access level from login API.

Parameters

name	type	data type	description
tagId	required	string	Tag ID