Skip to content

Update Tag API

API Information

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

Request Headers

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

Request Body Structure

UpdateTagReq Object

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

Request Body Example

json
{
  "id": 12345,
  "tagName": "updated_urban_analysis",
  "category": 1,
  "color": "#808080",
  "status": 1
}

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataBooleanUpdate result, true indicates success

Response Examples

Success Response

json
{
  "code": 200,
  "message": "success",
  "data": true
}

Failure Response

json
{
  "code": 404,
  "message": "Tag not found",
  "data": false
}

Error Code Description

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
404Tag not found
500Server internal error

Usage Instructions

  1. This API is used to update an existing tag
  2. User authentication is required
  3. Tag ID is required to identify which tag to update
  4. Returns boolean indicating update success

Notes

  • Tag ID is required and cannot be null
  • Only fields that are provided will be updated
  • Tag name must remain unique if changed
  • User authentication token must be included in request headers