Appearance
Query Tag Page API
API Information
- Request Path:
/tag/query/page - 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
TagListReq Object
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| page | Integer | Yes | Page number | Must be positive integer |
| size | Integer | Yes | Page size | Must be positive integer |
| tagName | String | No | Tag name filter | Optional name filter |
| sortField | String | No | Sort field | Optional sort field |
| sortOrder | String | No | Sort order | Optional: "asc" or "desc" |
Request Body Example
json
{
"page": 1,
"size": 10,
"tagName": "satellite",
"sortField": "createTime",
"sortOrder": "desc"
}Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | TagResp | Tag list response |
TagResp Object
| Field | Type | Description |
|---|---|---|
| total | Integer | Total number of records |
| list | List<TagVo> | List of tag records |
TagVo Object (Nested in TagResp)
| Field | Type | Description |
|---|---|---|
| id | Long | Tag ID |
| tagName | String | Tag name |
| description | String | Tag description |
| usageCount | Integer | Usage count |
| createTime | String | Creation timestamp |
| updateTime | String | Update timestamp |
| category | Integer | Tag category |
| color | String | Hexadecimal color value |
| status | Integer | Tag status |
Response Examples
Success Response
json
{
"code": 200,
"message": "success",
"data": {
"total": 25,
"list": [
{
"id": 1,
"tagName": "satellite",
"description": "Satellite imagery data",
"usageCount": 15,
"createTime": "2024-01-01T10:00:00Z",
"updateTime": "2024-01-01T10:00:00Z",
"category": 1,
"color": "#FF5733",
"status": 1
},
{
"id": 2,
"tagName": "vegetation",
"description": "Vegetation analysis data",
"usageCount": 8,
"createTime": "2024-01-01T10:00:00Z",
"updateTime": "2024-01-01T10:00:00Z",
"category": 2,
"color": "#33FF57",
"status": 1
}
]
}
}Failure Response
json
{
"code": 400,
"message": "Invalid request parameters",
"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 query tag list with pagination
- User authentication is required
- Supports filtering by tag name and sorting
- Returns paginated results with total count
Notes
- User authentication token must be included in request headers
- Request body must be valid JSON format
- Pagination parameters are required