Skip to content

Insert Tag API ​

API Information ​

  • Request Path: /tag/insert/tag
  • Request Method: POST
  • Content-Type: application/json

Request Headers ​

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token
Content-TypeStringYesMust be set to application/json

Request Body Structure ​

InsertTagReq Object ​

FieldTypeRequiredDescriptionConstraints
tagNameStringYesTag nameMust be unique
categoryIntegerYesTag category1-Dataset, 2-Metadata
colorStringNoHexadecimal color valueFormat: #808080
statusIntegerNoTag status0-inactive, 1-active

Request Body Example ​

json
{
  "tagName": "urban_analysis",
  "category": 1,
  "color": "#808080",
  "status": 1
}

Response Body Structure ​

CommonResponse Object ​

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataTagCreateRespTag create information

TagCreateResp Object ​

FieldTypeDescription
tagIdLongCreated tag ID

Response Examples ​

Success Response ​

json
{
  "code": 200,
  "message": "success",
  "data": {
      "tagId": 12345
  }
}

Failure Response ​

json
{
  "code": 400,
  "message": "Tag name already exists",
  "data": null
}

Error Code Description ​

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
500Server internal error

Usage Instructions ​

  1. This API is used to create a new tag
  2. User authentication is required
  3. Tag name is required
  4. Returns the ID of the created tag

Notes ​

  • Tag name is required and must be unique
  • Category must be specified (1 for Dataset, 2 for Metadata)
  • Color is optional but recommended for visual identification
  • User authentication token must be included in request headers