Appearance
Insert Tag API
API Information
- Request Path:
/tag/insert/tag - Request Method:
POST - Content-Type:
application/json
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| Authorization | String | Yes | User authentication token |
| Content-Type | String | Yes | Must be set to application/json |
Request Body Structure
InsertTagReq Object
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| tagName | String | Yes | Tag name | Must be unique |
| category | Integer | Yes | Tag category | 1-Dataset, 2-Metadata |
| color | String | No | Hexadecimal color value | Format: #808080 |
| status | Integer | No | Tag status | 0-inactive, 1-active |
Request Body Example
json
{
"tagName": "urban_analysis",
"category": 1,
"color": "#808080",
"status": 1
}Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | TagCreateResp | Tag create information |
TagCreateResp Object
| Field | Type | Description |
|---|---|---|
| tagId | Long | Created 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 Code | Description |
|---|---|
| 200 | Success |
| 400 | Request parameter error |
| 401 | Unauthorized |
| 500 | Server internal error |
Usage Instructions
- This API is used to create a new tag
- User authentication is required
- Tag name is required
- 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