Skip to content

Get Tag Information


GET /api/v1/tag/{tag_uuid}/get

Overview

Get detailed information about a tag

Route Parameters

Parameter Name Type Required Description
tag_uuid string Y Tag UUID

Additional Parameter Notes

Data Description

  • Response Parameter Description
Parameter Name Type Description
name string Tag name
description string Field description
color string Predefined color types, default, style_key1, style_key2, etc.
  • Color color field type-color mapping:
{
  "default": { "background": "#CCE6FF", "color": "rgba(0,0,0,0.8)" },
  "style_key1": { "background": "#3333FE", "color": "#FFFFFF" },
  "style_key2": { "background": "#428BCA", "color": "#FFFFFF" },
  "style_key3": { "background": "#364450", "color": "#FFFFFF" },
  "style_key4": { "background": "#E0E1FF", "color": "rgba(0,0,0,0.8)" },
  "style_key5": { "background": "#9400D3", "color": "#FFFFFF" },
  "style_key6": { "background": "#EDDBFF", "color": "rgba(0,0,0,0.8)" },
  "style_key7": { "background": "#CC328B", "color": "#FFF" },
  "style_key8": { "background": "#FCDEF0", "color": "rgba(0,0,0,0.8)" },
  "style_key9": { "background": "#DC143D", "color": "#FFFFFF" },
  "style_key10": { "background": "#FCBABA", "color": "rgba(0,0,0,0.8)" },
  "style_key11": { "background": "#BD0B48", "color": "#FFFFFF" },
  "style_key12": { "background": "#FDECD2", "color": "rgba(0,0,0,0.8)" },
  "style_key13": { "background": "#FFC29C", "color": "rgba(0,0,0,0.8)" },
  "style_key14": { "background": "#ED9120", "color": "#FFFFFF" },
  "style_key15": { "background": "#CD5B44", "color": "#FFFFFF" },
  "style_key16": { "background": "#FAF570", "color": "rgba(0,0,0,0.8)" },
  "style_key17": { "background": "#C29953", "color": "#FFFFFF" },
  "style_key18": { "background": "#02B140", "color": "#FFFFFF" },
  "style_key19": { "background": "#D5F4D5", "color": "rgba(0,0,0,0.8)" },
  "style_key20": { "background": "#009966", "color": "#FFFFFF" },
  "style_key21": { "background": "#023220", "color": "#FFFFFF" },
  "style_key22": { "background": "#E7E7E7", "color": "rgba(0,0,0,0.8)" },
  "style_key23": { "background": "#808080", "color": "#FFFFFF" }
}

Request Example

curl 'https://us1-openapi.truewatch.com/api/v1/tag/tag_xxxx32/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

Response

{
    "code": 200,
    "content": {
        "colour": "style_key3",
        "createAt": 1698754516,
        "creator": "acnt_xxxx32",
        "deleteAt": -1,
        "description": "temp_test",
        "id": 357,
        "name": "test_ha",
        "status": 0,
        "updateAt": 1698754516,
        "updator": "acnt_xxxx32",
        "uuid": "tag_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-614EDF3A-BB62-4DC4-BBDD-6BC0F2C7FC54"
}